Laravel Schedule Monitor 使用教程

Laravel Schedule Monitor 使用教程

laravel-schedule-monitorMonitor scheduled tasks in a Laravel app项目地址:https://gitcode.com/gh_mirrors/la/laravel-schedule-monitor

1、项目的目录结构及介绍

Laravel Schedule Monitor 是一个用于监控 Laravel 应用中计划任务的开源项目。以下是其基本目录结构：

laravel-schedule-monitor/
├── config/
│   └── schedule-monitor.php
├── database/
│   ├── migrations/
│   └── factories/
├── src/
│   ├── Commands/
│   ├── Models/
│   └── ScheduleMonitorServiceProvider.php
├── tests/
└── README.md

• config/：包含项目的配置文件 schedule-monitor.php。
• database/：包含数据库迁移文件和工厂类。
• src/：包含项目的主要源代码，包括命令、模型和服务提供者。
• tests/：包含项目的测试文件。
• README.md：项目的说明文档。

2、项目的启动文件介绍

Laravel Schedule Monitor 的启动文件主要是 ScheduleMonitorServiceProvider.php，位于 src/ 目录下。这个文件负责注册服务提供者，并包含一些关键的启动逻辑。

namespace Spatie\ScheduleMonitor;

use Illuminate\Support\ServiceProvider;

class ScheduleMonitorServiceProvider extends ServiceProvider
{
    public function boot()
    {
        // 发布配置文件和迁移文件
        $this->publishes([
            __DIR__.'/../config/schedule-monitor.php' => config_path('schedule-monitor.php'),
        ], 'schedule-monitor-config');

        $this->publishes([
            __DIR__.'/../database/migrations' => database_path('migrations'),
        ], 'schedule-monitor-migrations');

        // 加载路由和视图
        $this->loadMigrationsFrom(__DIR__.'/../database/migrations');
    }

    public function register()
    {
        $this->mergeConfigFrom(__DIR__.'/../config/schedule-monitor.php', 'schedule-monitor');
    }
}

3、项目的配置文件介绍

配置文件 schedule-monitor.php 位于 config/ 目录下，包含了项目的主要配置选项。以下是配置文件的主要内容：

return [
    /*
     * The schedule monitor will log each start, finish, and failure of all scheduled jobs.
     * After a while, the `monitored_scheduled_task_log_items` might become big.
     * Here you can specify the amount of days log items should be kept.
     */
    'delete_log_items_older_than_days' => 30,

    /*
     * The date format used for all dates displayed on the output of commands
     * provided by this package.
     */
    'date_format' => 'Y-m-d H:i:s',

    'models' => [
        /*
         * The model you want to use as a MonitoredScheduledTask model needs to extend the
         * `Spatie\ScheduleMonitor\Models\MonitoredScheduledTask` Model.
         */
        'monitored_scheduled_task' => Spatie\ScheduleMonitor\Models\MonitoredScheduledTask::class,

        /*
         * The model you want to use as a MonitoredScheduledTaskLogItem model needs to extend the
         * `Spatie\ScheduleMonitor\Models\MonitoredScheduledTaskLogItem` Model.
         */
        'monitored_scheduled_log_item' => Spatie\ScheduleMonitor\Models\MonitoredScheduledTaskLogItem::class,
    ],

    /*
     * The schedule monitor will retry failed jobs that have been queued for
     * longer than the time configured here.
     */
    'retry_job_for_minutes' => 10,
];

• delete_log_items_older_than_days：指定日志项保留的天数。
• date_format：指定日期格式。
• models：指定使用的模型类。
• retry_job_for_minutes：指定重试失败任务的时间。

以上是 Laravel Schedule Monitor 项目的基本介绍和使用教程。希望对你有所帮助！

laravel-schedule-monitorMonitor scheduled tasks in a Laravel app项目地址:https://gitcode.com/gh_mirrors/la/laravel-schedule-monitor