README

本包提供类似于 Laravel Horizon 的数据库队列监控功能。

特性

• 监控任何队列的作业，如同 Laravel Horizon
• 处理失败的作业，并存储异常信息
• 监控作业进度
• 获取作业剩余时间的估计值
• 为作业监控存储额外数据

安装

composer require cloudvests/laravel-queue-monitor

配置

将配置和迁移文件复制到您的项目中

php artisan vendor:publish --provider="cloudvests\QueueMonitor\Providers\QueueMonitorProvider"

迁移队列监控表。表名可以在配置文件或已发布的迁移中进行配置。

php artisan migrate

使用方法

要监控一个作业，只需添加 cloudvests\QueueMonitor\Traits\IsMonitored 特性。

use Illuminate\Bus\Queueable;
use Illuminate\Queue\SerializesModels;
use Illuminate\Queue\InteractsWithQueue;
use Illuminate\Contracts\Queue\ShouldQueue;
use Illuminate\Foundation\Bus\Dispatchable;
use cloudvests\QueueMonitor\Traits\IsMonitored; // <---

class ExampleJob implements ShouldQueue
{
    use Dispatchable;
    use InteractsWithQueue;
    use Queueable;
    use SerializesModels;
    use IsMonitored; // <---
}

重要！ 您需要在作业类中实现 Illuminate\Contracts\Queue\ShouldQueue 接口。否则，Laravel 不会分发包含监控作业状态信息的任何事件。

用户界面

您可以通过在路由文件中调用 Route::queueMonitor() 来启用可选的用户界面路由，类似于官方的 ui 框架。

Route::prefix('jobs')->group(function () {
    Route::queueMonitor();
});

路由

更多信息请查看 完整的配置文件。

扩展使用

进度

您可以设置一个 进度值（0-100），以获取作业进度的估计值。

use Illuminate\Contracts\Queue\ShouldQueue;
use cloudvests\QueueMonitor\Traits\IsMonitored;

class ExampleJob implements ShouldQueue
{
    use IsMonitored;

    public function handle()
    {
        $this->queueProgress(0);

        // Do something...

        $this->queueProgress(50);

        // Do something...

        $this->queueProgress(100);
    }
}

块进度

作业的一个常见场景是遍历大量集合。

这个示例作业遍历大量用户，并在每个块迭代中更新其进度值。

use Illuminate\Contracts\Queue\ShouldQueue;
use Illuminate\Database\Eloquent\Collection;
use cloudvests\QueueMonitor\Traits\IsMonitored;

class ChunkJob implements ShouldQueue
{
    use IsMonitored;

    public function handle()
    {
        $usersCount = User::count();

        $perChunk = 50;

        User::query()
            ->chunk($perChunk, function (Collection $users) use ($perChunk, $usersCount) {

                $this->queueProgressChunk($usersCount‚ $perChunk);

                foreach ($users as $user) {
                    // ...
                }
            });
    }
}

进度冷却

为了避免频繁重复的更新查询而使数据库过载，您可以重写 progressCooldown 方法并指定一个长度为秒的等待时间，在将每个进度更新写入数据库之前。注意，冷却对于值 0、25、50、75 和 100 总是会被忽略。

use Illuminate\Contracts\Queue\ShouldQueue;
use cloudvests\QueueMonitor\Traits\IsMonitored;

class LazyJob implements ShouldQueue
{
    use IsMonitored;

    public function progressCooldown(): int
    {
        return 10; // Wait 10 seconds between each progress update
    }
}

自定义数据

本包还允许在监控模型上设置数组语法自定义数据。

use Illuminate\Contracts\Queue\ShouldQueue;
use cloudvests\QueueMonitor\Traits\IsMonitored;

class CustomDataJob implements ShouldQueue
{
    use IsMonitored;

    public function handle()
    {
        $this->queueData(['foo' => 'Bar']);
        
        // WARNING! This is overriding the monitoring data
        $this->queueData(['bar' => 'Foo']);

        // To preserve previous data and merge the given payload, set the $merge parameter true
        $this->queueData(['bar' => 'Foo'], true);
    }
}

为了在 UI 上显示自定义数据，您需要在 config/queue-monitor.php 下添加此行。

'ui' => [
    ...

    'show_custom_data' => true,

    ...
]

仅保留失败作业

您可以通过重写 keepMonitorOnSuccess() 方法来仅存储已执行作业的失败监控条目。如果您只想保留经常执行但值得监控的失败的监控，可以使用此方法。或者，您还可以使用 Laravel 内置的 failed_jobs 表。

use Illuminate\Contracts\Queue\ShouldQueue;
use cloudvests\QueueMonitor\Traits\IsMonitored;

class FrequentSucceedingJob implements ShouldQueue
{
    use IsMonitored;

    public static function keepMonitorOnSuccess(): bool
    {
        return false;
    }
}

检索已处理的作业

use cloudvests\QueueMonitor\Models\Monitor;

$job = Monitor::query()->first();

// Check the current state of a job
$job->isFinished();
$job->hasFailed();
$job->hasSucceeded();

// Exact start & finish dates with milliseconds
$job->getStartedAtExact();
$job->getFinishedAtExact();

// If the job is still running, get the estimated seconds remaining
// Notice: This requires a progress to be set
$job->getRemainingSeconds();
$job->getRemainingInterval(); // Carbon\CarbonInterval

// Retrieve any data that has been set while execution
$job->getData();

// Get the base name of the executed job
$job->getBasename();

模型作用域

use cloudvests\QueueMonitor\Models\Monitor;

// Filter by Status
Monitor::failed();
Monitor::succeeded();

// Filter by Date
Monitor::lastHour();
Monitor::today();

// Chain Scopes
Monitor::today()->failed();

升级

• 从 1.0 升级到 2.0

本包受到 gilbitron 的 laravel-queue-monitor 的启发，该包已经不再维护。