brightfish/health-checks

Laravel 的简单健康检查

0.8.1 2023-04-13 16:30 UTC

This package is auto-updated.

Last update: 2024-09-13 19:46:56 UTC


README

Tests Latest Version on Packagist Total Downloads

用法

从命令行运行所有已注册的检查

php artisan health:check

或向内置的 health 端点发送 HTTP 请求

curl GET https://your.app/health

安装

使用 composer 安装包

composer require brightfish/health-checks

发布配置文件

php artisan vendor:publish --provider="Brightfish\HealthChecks\HealthServiceProvider" --tag="health-checks-config"

创建自定义健康检查类

namespace App\Health\MyCustomCheck;

class MyCustomCheck extends \Brightfish\HealthChecks\Checks\AbstractCheck
{
    public function run(): bool
    {
        return false;
    }

    public function getMessage(): string
    {
        return 'Error';
    }
}

最后,在配置文件中列出该类

return [
    'checks' => [
        \App\Health\MyCustomCheck::class,
    ],
];

测试

composer test

贡献

请参阅 CONTRIBUTING 获取详细信息。

安全漏洞

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

致谢

许可证

GNU 通用公共许可证 (GPL)。请参阅 许可证文件 获取更多信息。