Horizon 为你的Laravel Redis队列提供了一个美观的控制面板和代码驱动的配置;它可以方便的监控队列系统的关键指标:任务吞吐量、运行时间、工作故障。
所有的worker配置存储在一个简单的配置文件中,你可以在整个团队都可以进行协作的地方进行源码控制。
提示: 要确保队列连接在
queue
配置文件的redis
项已经正确设置。
可以使用Composer将Horization安装到你的Laravel项目里:
composer require laravel/horizon
Horizon安装之后,使用horizon:install
Artisan命令将其资源发布:
php artisan horizon:install
Horizon资源发布之后,他的主要配置文件会被分配到config/horizon.php
文件。可以用这个配置文件配置工作选项,每个配置选项包含一个用途描述,因此要仔细研究这个文件。
注意:要确保
horizon
配置文件的environments
部分包含你了你计划在horizon上运行的每个环境选项。
Horizon 允许你从三个平衡策略中进行选择:simple
, auto
, 和 false
。simple
策略是配置文件的默认选项,它会在进程之间平均分配进入的任务:
'balance' => 'simple',
auto
策略根据队列的当前工作负载调整每个队列的工作进程数量。举个例子,如果你的notifications
队列有 1000 个等待的任务,而你的 render
队列是空的,那么 Horizon 将为notifications
队列分配更多的工作线程,直到队列为空。当balance
选项被设置为false
时,将使用默认的Laravel行为,它按照配置中列出的顺序处理队列。
当使用auto
策略时,你可以定义 minProcesses
和 maxProcesses
的配置选项来控制进程的最小和最大数量。
'environments' => [
'production' => [
'supervisor-1' => [
'connection' => 'redis',
'queue' => ['default'],
'balance' => 'auto',
'minProcesses' => 1,
'maxProcesses' => 10,
'tries' => 3,
],
],
],
horizon
配置文件允许您配置最近的和失败的任务应该持续多长时间(以分钟为单位)。默认情况下,保存最近的作业一个小时,保存失败的作业一个星期:
'trim' => [
'recent' => 60,
'failed' => 10080,
],
Horizon在 /horizon
上显示了一个控制面板。默认情况下,你只能在local
环境中访问这个面板。在你的 app/Providers/HorizonServiceProvider.php
文件中,有一个 gate
方法。此授权门控制着在非本地环境中对Horizon进行的访问。您可以根据需要修改此门,来限制对Horizon安装的访问:
/**
* 注册授权门.
*
* 此门决定了谁可以在非本地环境中访问Horizon
*
* @return void
*/
protected function gate()
{
Gate::define('viewHorizon', function ($user) {
return in_array($user->email, [
'taylor@laravel.com',
]);
});
}
提示:记住Laravel会自动将 authenticated 用户注入到Gate中。如果你的应用通过另一种方式提供了Horizon的安全性,比如IP限制,那么你的Horizon用户可能不需要“登录”。因此,你需要将上面的
function ($user)
更改为function ($user = null)
,以强制Laravel不需要身份验证。
当你升级到Horizon的一个新主要版本时,你需要仔细阅读升级指南.
另外,你应该重新发布Horizon的资源:
php artisan horizon:publish
一旦在 config/horizon.php
中配置了你的workers。你可以使用 horizon
Artisan命令启动Horizon。只需这一个命令你就可以启动你的所有已配置的workers:
php artisan horizon
可以暂停Horizon进程,并使用horizon:pause
和 horizon:continue
Artisan命令指示它继续处理任务:
php artisan horizon:pause
php artisan horizon:continue
可以使用 horizon:status
Artisan命令检查Horizon进程的当前状态:
php artisan horizon:status
您可以使用 horizon:terminate
Artisan命令优雅地终止机器上的主Horizon进程。Horizon会等当前正在处理的所有任务都完成后退出:
php artisan horizon:terminate
如果要将Horizon部署到一个正在运行的服务器上,应该配置一个进程监视器来监视 php artisan horizon
命令,并在它意外退出时重新启动它。在将新代码部署到服务器时,你需要终止主Horizon进程,以便进程监视器重新启动它并接收代码的更改。
Supervisor是一个用于Linux操作系统的进程监视器。如果它失败了,它将自动重启 horizon
进程。如果要在Ubuntu上安装Supervisor,你可以使用以下命令:
sudo apt-get install supervisor
提示:如果你觉得自己配置Supervisor很困难,可以考虑使用Laravel Forge,它将自动为您的Laravel项目安装和配置Supervisor。
Supervisor配置文件通常存储在 /etc/supervisor/conf.d
目录下。在此目录中,你可以创建任意数量的配置文件,这些配置文件会告诉supervisor如何监视你的进程。例如,让我们创建一个 horizon.conf
文件,它启动并监视一个horizon
进程:
[program:horizon]
process_name=%(program_name)s
command=php /home/forge/app.com/artisan horizon
autostart=true
autorestart=true
user=forge
redirect_stderr=true
stdout_logfile=/home/forge/app.com/horizon.log
stopwaitsecs=3600
注意: 要确保
stopwaitsecs
的值大于运行时间最长的任务所消耗的秒数。否则,Supervisor 可能会在工作完成前终止任务。
创建了配置文件后,可以使用以下命令更新Supervisor配置并启动进程:
sudo supervisorctl reread
sudo supervisorctl update
sudo supervisorctl start horizon
关于Supervisor的更多信息, 可以查阅 Supervisor 文档.
Horizon允许您将 tags
分配给任务,包括邮件、事件广播、通知和排队的事件监听器。实际上,Horizon会根据附加到作业上的有Eloquent模型,智能地、自动地标记大多数任务。例如,看看下面的任务:
<?php
namespace App\Jobs;
use App\Video;
use Illuminate\Bus\Queueable;
use Illuminate\Contracts\Queue\ShouldQueue;
use Illuminate\Foundation\Bus\Dispatchable;
use Illuminate\Queue\InteractsWithQueue;
use Illuminate\Queue\SerializesModels;
class RenderVideo implements ShouldQueue
{
use Dispatchable, InteractsWithQueue, Queueable, SerializesModels;
/**
* video实例
*
* @var \App\Video
*/
public $video;
/**
* 创建一个新的任务实例
*
* @param \App\Video $video
* @return void
*/
public function __construct(Video $video)
{
$this->video = $video;
}
/**
* 执行任务
*
* @return void
*/
public function handle()
{
//
}
}
如果此任务与 App\Video
实例一起排队,且该实例的 id
为 1
,则该作业将自动接收App\Video:1
标记。这是因为Horizon将为任何有Eloquent的模型检查任务的属性。如果找到了有Eloquent的模型,Horizon将智能地使用模型的类名和主键标记任务:
$video = App\Video::find(1);
App\Jobs\RenderVideo::dispatch($video);
如果你想手动定义你的一个队列对象的标签,你可以在类上定义一个 tags
方法:
class RenderVideo implements ShouldQueue
{
/**
* 获取应该分配给任务的标记
*
* @return array
*/
public function tags()
{
return ['render', 'video:'.$this->video->id];
}
}
注意: 如果要发送 Slack 或 SMS 通知,要配置Horizon应该检查,应该回顾一下 相关通知驱动程序的先决条件.
如果你希望在一个队列有较长的等待时间时得到通知,您可以使用 Horizon::routeMailNotificationsTo
,Horizon::routeSmsNotificationsTo
和Horizon::routeSmsNotificationsTo
方法。你可以从你的应用程序的HorizonServiceProvider
调用这些方法:
Horizon::routeMailNotificationsTo('example@example.com');
Horizon::routeSlackNotificationsTo('slack-webhook-url', '#channel');
Horizon::routeSmsNotificationsTo('15556667777');
您可以在 config/horizon.php
的配置文件中配置多少秒算是长等待。你可以用该文件中的 waits
配置选项控制每个 连接/队列 组合的长等待阈值:
'waits' => [
'redis:default' => 60,
],
Horizon有一个指标控制面板,它提供了任务和队列的等待时间和吞吐量等信息。要让这些信息显示在这个控制面板上,你应该配置Horizon的 snapshot
Artisan命令,通过你的应用程序的调度器每五分钟运行一次:
/**
* 定义应用程序的命令调度
*
* @param \Illuminate\Console\Scheduling\Schedule $schedule
* @return void
*/
protected function schedule(Schedule $schedule)
{
$schedule->command('horizon:snapshot')->everyFiveMinutes();
}