Weave Code
Alerts For Laravel Laravel Package
roundly-consulting/alerts-for-laravel
Alerts for Laravel offers a simple, fluent API for creating and displaying alerts in Laravel apps. Flash success, error, warning, and info messages to the session and render them in Blade views with minimal setup.
Schedule recurring health checks against any notifiable model and dispatch throttled alert notifications when they fail or recover.
Frequently asked questions about Alerts For Laravel
- How do I install alerts-for-laravel?
- Install it with Composer using composer require roundly-consulting/alerts-for-laravel. The package follows the standard Laravel package layout, so its service provider is auto-discovered and its config and migrations are published with vendor:publish. After publishing, review the config file and run your migrations before registering any checks. Confirm the Laravel and PHP version constraints in the package composer.json first, since that is the most likely blocker.
- How do I schedule a recurring health check against a model?
- You register checks through the package's fluent API and attach them to Laravel's scheduler, typically in routes/console.php or a console kernel schedule method. Each check targets a notifiable model and defines the condition that counts as a failure plus how often it should run. Laravel's scheduler then evaluates the check on that cadence, and the package dispatches notifications when the result changes.
- How does alert throttling work so a failing check doesn't spam notifications?
- Throttling is the core behavior of the package: a check that keeps failing does not notify on every single scheduler run. Notifications are tied to state changes, so you get alerted when a check fails or recovers rather than on every evaluation. You can tune the throttle window in the published config to match how noisy you want your alerting to be.
- Can I use my own model instead of the package's model?
- Yes. The package resolves its model through host-level configuration rather than hard-coding a concrete class, which is the standard config-published model binding pattern in Laravel. You point the relevant config key at your own class so the package operates on your existing domain entities. Since version 1.2.2 the package's Eloquent factories also build the configured model, so test fixtures match production wiring.
- What changed in version 1.2.2 and is it a breaking change?
- Version 1.2.2 is a semver patch containing a single bug fix: factories now build the configured model when a host swaps the package model via config. There are no deprecations, no API changes, and no data migration, so upgrading from 1.2.1 is a routine composer update. The only behavioral difference is at test time, where factory output will now be your host model instead of the package default.
- Which Laravel and PHP versions does this package support?
- The release notes do not state a support matrix, so check the require and require-dev blocks in the package composer.json before committing. Framework version constraints are the single most likely adoption blocker for a package like this. If you are on an older LTS, verify compatibility in a branch before rolling it out.
- Do I need a queue worker or an external service to use it?
- No. The package is a conventional Composer-installed Laravel package with a service provider, publishable config, publishable migrations, and Eloquent models with factories. It has no infrastructure prerequisites such as a queue worker, cache driver, or third-party monitoring service. Notifications go through Laravel's own notification system, so queueing is optional but recommended in production.
- How do I test an application that swaps the package's model?
- Run your full suite with the host model swap active, since that is exactly the scenario the 1.2.2 fix targets. Assert that factory-produced instances are the swapped class and that relationships, table names, and any morph aliases resolve consistently. Add a regression test that pins factory output to the configured model so future swaps stay honest. Also audit RefreshDatabase seeders and test doubles that reference package models by class name.
- What happens when a failing check recovers?
- The package treats recovery as a state transition and dispatches a recovery notification, then resets the throttle state for that check. This closes the loop so you know when an incident is over instead of only hearing about failures. Recovery notifications use the same notifiable model and channel configuration as failure alerts.
- Does swapping the model require extending the package base model, or updating a morph map?
- The release notes do not document this, so verify it against the package source before relying on it. The open questions are whether the host class must extend the package base model or only implement a contract, whether model resolution happens lazily per call or is cached at container-bind time, and whether a registered morph map needs a matching alias update. Confirm each of these in a branch before promoting the swap to production.
Weaver
How can I help you explore Laravel packages today?