Laravel Horizon is a dashboard and code-driven configuration tool designed for Laravel's Redis queues that provide in-depth insights into queue systems. 1. Before installation, make sure to use Redis as the queue driver and install Horizon through Composer. 2. After publishing its resources, you can configure monitoring options in config/horizon.php, such as connection, queue name, number of processes, etc. 3. After the installation is completed, visit /horizon to view real-time statistics and set up notification mechanisms. 4. When running in a production environment, it is recommended to use process management tools such as Supervisor to keep running, and clear and restart Horizon after deploying new code. 5. For platforms such as Forge or Vapor, built-in features can be used to simplify the deployment process.

Laravel Horizon is a powerful, built-in dashboard and code-driven configuration system for managing your Redis queues in Laravel. It gives you deep insight into your queue system — from job throughput to failure tracking and even performance monitoring. If you're using Redis as your queue driver and want more control and visibility, Horizon is the tool to use.

Installing and Configuring Laravel Horizon

First things first: make sure you're using Redis as your queue driver. Horizon only works with Redis, so that's non-negotiable. You can set this up in your .env file by setting QUEUE_CONNECTION=redis .

Once Redis is ready, install Horizon via Composer:

 composer requires laravel/horizon

Then publish its assets with:

 php artisan horizon:install

This creates the Horizon command in your App\Console\Kernel and sets up the views needed for the dashboard. Also, it adds a service provider so everything gets wired up automatically.

The main config file is at config/horizon.php . Here, you define your queue supervision settings — like which queues to monitor, how many workers to run per queue, and how long jobs should be allowed to run before timing out.

A common setup might look like:

 'environments' => [
    'production' => [
        'supervisor-1' => [
            'connection' => 'redis',
            'queue' => ['default'],
            'balance' => 'simple',
            'processes' => 10,
            'tries' => 3,
        ],
    ],
],

You can tweak these values ??based on your app's needs. For example, high-priority queues might get more processes or shorter timeouts.

Using the Horizon Dashboard

After installing, access the Horizon dashboard by visiting /horizon in your browser. By default, it's protected in local environments only, but you can adjust middleware to allow authenticated users in production.

From here, you'll see real-time stats on:

• Active jobs
• Failed jobs
• Throughput (jobs per minute)
• Runtime averages
• Queue wait times

One of the most useful parts is the "Monitoring" tab, where you can set up alerts for stalled jobs or long wait times. For instance, if a queue starts backing up, Horizon can notify you via email or Slack — assuming you've configured those notifications.

To enable notifications, you'll need to use Laravel's built-in notification system. In your HorizonServiceProvider , you can specify who gets notified when certain events happen:

 Horizon::night();

Horizon::when('failed', function ($event) {
    return $event->type === 'job_failed';
});

This kind of setup helps you catch bottlenecks before they become serious issues.

Running Horizon in Production

Running Horizon in production requires a process monitor to keep the supervisor running. Most people use Supervisor on Ubuntu or similar systems.

Here's a basic Supervisor config:

 [program:horizon]
command=php /path/to/artisan horizon
directory=/path/to/laravel
autostart=true
autorestart=true
user=www-data
redirect_stderr=true
stdout_logfile=/path/to/logs/horizon.log

This ensures Horizon restarts automatically if it crashes and keeps your queues running smoothly.

If you're deploying on platforms like Forge or Vapor, there are usually built-in tools or deployment hooks to manage Horizon without manual setup.

Also, remember to clear and restart Horizon after deploying new code:

 php artisan horizon:clear
php artisan horizon:terminate

These commands help avoid outdated jobs lingering and ensure fresh workers pick up the latest changes.

That's pretty much what you need to know to get started with Laravel Horizon. Once it's running, you'll wonder how you ever managed without it.

The above is the detailed content of Setting up and monitoring queues with Laravel Horizon. For more information, please follow other related articles on the PHP Chinese website!