eazybright/status-page

您laravel应用程序的状态页面

1.0.0 2023-03-11 14:41 UTC

This package is auto-updated.

Last update: 2024-09-13 20:05:13 UTC


README

Latest Version on Packagist GitHub Tests Action Status GitHub Code Style Action Status Total Downloads

如何判断您的laravel应用程序是否正常运行或者是否有宕机? StatusPage可以帮助您实时传达应用程序的状态。

安装

您可以通过composer安装此包

composer require eazybright/status-page

您可以使用以下命令发布公共资源

php artisan vendor:publish --tag="status-page-assets"

资源文件将可在public/vendor/status-page目录下访问

您可以使用以下命令发布配置文件

php artisan vendor:publish --tag="status-page-config"

这是已发布配置文件的内容

return [
    /**
     * Specify the location of the logo
    */
    'logo' => 'vendor/status-page/img/STATUSPAGE.png',
];

可选,您可以使用以下命令发布视图

php artisan vendor:publish --tag="status-page-views"

使用方法

在您查看状态页面之前,需要执行一些操作。

  1. 将bash脚本复制到根目录,将生成health-check.sh文件。
php artisan status-page:copy-script
  1. 爬取应用程序中的路由。这将在公共文件夹中创建urls.cfg文件。这是保存可用URL的地方。
php artisan status-page:generate-route

可选,您可以将您的URL包含到urls.cfg文件中。

Google https://google.com GET
Statsig https://statsig.com GET
  1. 创建状态页面视图。
php artisan status-page:create

您的视图可在localhost:8000/status-page访问

Status Page View

  1. 要自动化步骤3,您可以在app\Console\kernel.php文件中调度artisan命令php artisan status-page:create以独立运行。
    // ...

    /**
     * Define the application's command schedule.
     *
     * @param Schedule $schedule
     * @return void
     */
    protected function schedule(Schedule $schedule)
    {
        // ...

        $schedule->command('status-page:create')->hourly();
    }

它是如何工作的?

脚本(health-check.sh)将对配置中的每个URL执行curl,并将该运行的输出追加到日志文件中(public/vendor/status-page/logs)。然后,此日志将从status.blade.php文件动态获取并以易于消费的方式显示。

测试

composer test

贡献

提交PR - 我很乐意整合您的想法。

致谢

许可证

MIT许可证(MIT)。请参阅许可证文件以获取更多信息。