repository·5.x·Indexed 26 days ago
https://github.com/laravel/horizonA dashboard and configuration system for managing Redis-powered queues in Laravel applications. Horizon provides real-time monitoring of job metrics, code-driven worker configuration, and tools for managing supervisor environments, auto-scaling, and job tagging. It includes features for routing LongWaitDetected notifications via Email, Slack, and SMS, as well as utilities for managing job payloads and snapshot retention.
You can configure where Horizon sends LongWaitDetected alerts by using the built-in routing methods within the boot() method of your App\Providers\HorizonServiceProvider. Horizon automatically wires the LongWaitDetected event to these routes.
Available routing methods:
Horizon::routeMailNotificationsTo(...)Horizon::routeSlackNotificationsTo(...)Horizon::routeSmsNotificationsTo(...)Horizon uses a hierarchical configuration structure for supervisors. The defaults array defines the base configuration for all supervisors. The environments array is used to patch these defaults for specific environments (e.g., production).
Important: The environments array merges into defaults rather than replacing it. You only need to specify the keys you wish to override in your environment-specific blocks.
ModelClass:id (e.g., App\Models\User:42). These tags are immediately available for filtering in the Horizon dashboard. You only need to implement a tags() method in your job class if you require custom tags in addition to this automatic behavior.When upgrading to version 5.0, ensure your environment meets the following requirements and note the following breaking changes:
timeoutAt with retryUntil.delay with backoff.balance: false and define a specific maxProcesses value.When upgrading to version 3.0, ensure your environment meets the following requirement:
horizon artisan command does not automatically populate metrics. To build the metrics graph, you must schedule the horizon:snapshot command to run periodically (recommended every 5 minutes) using Laravel's scheduler.When using balance: auto on a single supervisor, Horizon ignores the order of the queue array for load balancing purposes. To ensure specific queues are processed with higher priority, you must create separate named supervisors.
For example, to prioritize a notifications queue over a default queue, create one supervisor for notifications with a higher maxProcesses and a second supervisor for default with a lower maxProcesses cap.
When upgrading to version 4.0, ensure your environment meets the following requirements and note the following breaking changes:
composer.json file..env file:HORIZON_PREFIX="horizon:"horizon:assets command has been renamed to horizon:publish.silenced_tags configuration option in config/horizon.php. This is useful for silencing entire categories of jobs (e.g., all notifications) without needing to list every individual job class.To control when Horizon fires a LongWaitDetected event, adjust the waits array in your config/horizon.php file. The value defines the maximum number of seconds a job can wait in a specific queue before the event is triggered. For example, 'redis:default' => 60 means jobs in the default queue will trigger an alert if they wait longer than 60 seconds.
Note: Adjust this configuration value to change alert frequency; do not attempt to change this via notification routing.