README

版本兼容性

安装

composer require arquivei/laravel-health-checker

使用方法

编辑配置文件 config/health-checker.php，其中注释提供了更多信息。

可用的检查器

database 测试数据库连接。
cache 测试缓存数据
directory-permission 测试目录权限
queue 测试队列

如何添加新的检查器

您只需要扩展 \Laravel\Health\Checkers\BaseChecker 并将其添加到 config/health-checker.php 中的服务中。

路由和响应

要访问健康状态，您可以使用以下路由

health/status 加载并列出所有检查服务。
health/{service_name}/status 只加载所选服务并显示其状态。

两种情况下的响应如下

{
    status: {
        code: 200,
        message: "OK"
    },
    health_status: [
        {
            cache: {
                is_healthful: true,
                message: null
            }
        },
        {
            database: {
                is_healthful: true,
                message: null
            }
        },
        {
            directory-permission: {
                is_healthful: false,
                message: "The directory /application/public/../storage/ is not writable."
            }
        },
        {
            queue: {
                is_healthful: true,
                message: null
            }
        }
    ]
}

命令使用方法

您可以使用以下命令在CLI应用程序中检查健康状态

php artisan application-health:check-health

或者

php artisan application:health-check

开发

我们提供Docker镜像以帮助设置开发环境。因此，为了构建镜像、安装依赖项并运行测试，您可能需要执行以下命令

make

初始设置完成后，您可以使用 bin/php 和 bin/composer 脚本（Docker镜像的包装器）来运行测试和安装新的依赖项。

arquivei / laravel-health-checker

维护者

详细信息