README

本包的目的是将 ukfast/laravel-health-check 包集成到 spatie/laravel-dashboard 的瓷砖中。

安装

此包需要在提供的端点上运行 ukfast/laravel-health-check 包，以便我们可以断言您的服务正在运行。请按照该存储库中的说明安装该包。

您可以通过 composer 安装此包

composer require tylerwoonton/laravel-dashboard-health-check-tile

配置

在 dashboard 配置文件中，您必须在 tiles 键中添加此配置。

sites 数组应包含一个包含相应 URL 和任何需要执行的自定义 headers 或 Guzzle options 的网站的数组。

timeout 选项是 Guzzle 请求的超时时间（以秒为单位）。默认情况下，每个请求为 3 秒。

show_failures 选项确定失败的哪些服务在瓷砖上显示。如果您只想看到简洁的总体状态，则可以禁用此选项。

refresh_interval 选项确定在瓷砖重新渲染之前将经过多少秒。

// config/dashboard.php

return [
    // ...
    'tiles' => [
        'health_check' => [
            'sites' => [
                'Example App' => [
                    "url" => 'https://example.app/health', 
                    "headers" => [], // optional
                    "options" => [] // optional
                ]
            ],
            'timeout' => 3,
            'show_failures' => true,
            'refresh_interval' => 60
        ],
    ],
];

在 app\Console\Kernel.php 中，您应该安排 \TylerWoonton\HealthCheckTile\Commands\FetchHealthCheckDataCommand 运行。如果您想让它每分钟运行一次。如果您不希望此瓷砖的仪表板更新很快，也可以更频繁地运行它。

// app/Console/Kernel.php

protected function schedule(Schedule $schedule)
{
    // ...
    $schedule->command(\TylerWoonton\HealthCheckTile\Commands\FetchHealthCheckDataCommand::class)->everyMinute();
}

使用方法

在您的仪表板视图中，您使用 livewire:health-check-tile 组件。

<x-dashboard>
    <livewire:health-check-tile position="a1" />
</x-dashboard>

自定义视图

如果您想自定义用于渲染此瓷砖的视图，请运行此命令

php artisan vendor:publish --provider="TylerWoonton\HealthCheckTile\HealthCheckTileServiceProvider" --tag="dashboard-health-check-tile-views"

测试

composer test

贡献

我们欢迎对这个包的贡献。所有新的更改都应经过良好的测试，并遵循 PSR-12 标准。

有关更多信息，请参阅我们的 CONTRIBUTING 文件。

Treeware

此包是 Treeware。如果您在生产中使用它，我们要求您 为世界种一棵树 以感谢我们的工作。通过为 Treeware 森林做出贡献，您将为当地家庭创造就业机会并恢复野生动物栖息地。