README

检查您的 Statamic 应用程序的健康状况

使用此插件，您可以通过注册检查来监控应用程序的健康状况。

以下是一个示例，我们将监控可用磁盘空间。

// typically, in a service provider

use Spatie\Health\Facades\Health;
use Spatie\Health\Checks\Checks\UsedDiskSpaceCheck;

Health::checks([
    UsedDiskSpaceCheck::new()
        ->warnWhenUsedSpaceIsAbovePercentage(70)
        ->failWhenUsedSpaceIsAbovePercentage(90),
]);

当使用磁盘空间超过 70% 时，将发送带有警告的通知。如果超过 90%，您将收到错误通知。默认情况下，该包可以通过电子邮件和 Slack 通知您。

支持我们

我们投入了大量资源来创建最佳的开放源代码包。您可以通过购买我们的付费产品之一来支持我们。

我们非常感谢您从家乡寄来明信片，说明您正在使用我们的哪个包。您可以在我们的联系页面上找到我们的地址。我们将在我们的虚拟明信片墙上发布所有收到的明信片。

安装

发布 laravel-health 配置文件

php artisan vendor:publish --tag="health-config"

在 health_stores 数组中删除 EloquentHealthResultStore 并替换为以下内容

Spatie\Health\ResultStores\JsonFileHealthResultStore::class => [
    'disk' => 'local',
    'path' => 'health.json',
],

这将将健康检查的结果存储在 json 文件中，而不是尝试访问数据库。

文档

此插件使用 Laravel Health 包，有关包本身的更多信息，请参阅文档。

小部件

此插件提供将健康检查小部件添加到 Statamic 仪表板的选项，您可以通过配置 config/statamic/cp.php 中的小部件来添加任何健康检查

'widgets' => [
    [
        'type' => 'health_check',
        'check' => \Spatie\Health\Checks\Checks\UsedDiskSpaceCheck::class,
        'width' => 33,
    ],
    ...
],

在将其添加到仪表板之前，请确保已正确配置健康检查。

禁用健康控制面板部分

如果您想禁用控制面板中的健康部分，例如，当您已将所有小部件添加到 Statamic 仪表板时，您可以将以下配置键添加到 Laravel health (config/health.php) 文件中

'statamic' => [
    'enable_dashboard' => false,
]

测试

composer test

变更日志

请参阅 CHANGELOG 了解最近更改的更多信息。

贡献

请参阅 CONTRIBUTING 了解详细信息。

安全漏洞

请参阅我们的安全策略了解如何报告安全漏洞。

鸣谢

许可证

MIT 许可证 (MIT)。请参阅许可证文件了解更多信息。

spatie / statamic-health

维护者

详细信息