README

一个为 ThinkPHP 框架设计的健康检查库，支持自定义健康检查和灵活的配置选项。

功能特性

简单易用的健康检查接口
可自定义的健康检查
灵活的配置选项
支持使用命令行定时上报健康情况

安装

通过 Composer 安装：

composer require 153264/think-health

基本使用

安装后，健康检查接口会自动注册到你的应用中。默认情况下，你可以通过访问 /health 路径来进行健康检查：

curl http://your-domian/your-entrance/health

成功

HTTP/1.1 200 OK
Content-Type: text/html

ok

失败

HTTP/1.1 500 Internal Server Error
Content-Type: text/html

{"CheckEnv":"APP_DEBUG is not falsy"}

也可以通过命令行 health:check 进行健康检查。默认不进行上报，如果需要上报可以使用 -r 选项

php think health:check

成功

ok

失败

CheckEnv APP_DEBUG is not falsy

配置选项

在 config/health.php 文件中配置健康检查行为：

<?php

return [
    /**
     * 健康检查路由
     * @var string|bool
     */
    'url' => '/health',

    /**
     * 健康检查上报
     * 必须要继承 ReportAbstracte 类
     * @var array<ReportAbstracte>
     */
    'reportHandles' => [
        new Http(
            /**
             * 上报地址
             * @var string
             */
            url: 'https://your-server.com/health/report',
            /**
             * 超时时间
             * @var integer
             */
            timeout: 30,
        )
    ],
    /**
     * 监听器
     * 必须要继承 CheckAbstracte 类
     * @var array<CheckAbstracte>
     */
    'checkHandles' => [
        new CheckDataBase(
            /**
             * 需要检测的数据库连接
             * 如果为空，则检测所有数据库连接
             * @var array<string>
             */
            connections: []
        ),
        new CheckCache(
            /**
             * 需要检测的缓存
             * 如果为空，则检测所有缓存
             * @var array<string>
             */
            stores: [],
            /**
             * 缓存key
             * @var string
             */
            key: 'health_check_cache_key',
            /**
             * 缓存value
             * @var string
             */
            value: 'health_check_cache_value'
        ),
        new CheckEnv(
            /**
             * 需要检测的key值
             *
             * falsy 为空或0
             * truthy 为非空或非0
             * string 为字符串
             * int 为数字
             *
             * @var array<string,string>
             */
            keys: [
                'APP_DEBUG' => 'falsy',

                'DATABASE.TYPE' => 'mysql',
                'DATABASE.HOST' => 'string',
                'DATABASE.NAME' => 'string',
                'DATABASE.USER' => 'string',
                'DATABASE.PASS' => 'string',
                'DATABASE.PORT' => 'int',
                'DATABASE.CHARSET' => 'utf8mb4',
            ]
        ),
        new CheckFolder(
            /**
             * 需要检查的文件夹
             * 键为文件夹路径，值为允许的最大大小（字节）
             * @var array<string,int>
             */
            folders: [
                runtime_path() => 1024 * 1024 * 1024
            ]
        ),
        new CheckHttp(
            /**
             * 需要检查的网络资源
             * @var string
             */
            url: 'https://your-server.com/resource',
            /**
             * 超时时间
             * @var integer
             */
            timeout: 30,
            /**
             * 允许的HTTP状态码
             * @var array<integer>
             */
            statusCodes: [200, 201, 202, 204],
        )
    ],
];

创建自定义健康检查

你可以创建自定义的健康检查来检查特定的服务或资源：

<?php

namespace app\check;

use think\health\Contract\CheckAbstracte;

class CheckApp extends CheckAbstracte
{
    public function name():string{
        return 'app check';
    }

    public function handle():void
    {
        // check app
    }
}

然后在配置文件中添加这个检查：

'checkHandles' => [
    // ... 其他检查
    new \app\check\CheckApp()
],

创建自定义上报

你可以创建自定义的上报逻辑：

<?php

namespace app\report;

use think\health\Contract\ReportAbstracte;

class ReportApp extends ReportAbstracte
{
    /**
     * @param Collection<string,Throwable|bool> $messages
     */
    public function handle(Collection $messages): void {
        // report app
    }
}

然后在配置文件中添加这个上报：

'reportHandles' => [
    // ... 其他上报
    new \app\report\ReportApp()
],

内置检查

CheckEnv

检查项目环境变量是否正确

CheckDatabase

检查数据库连接是否正常

CheckCache

检查缓存是否正常

CheckFolder

检查文件夹大小是否正常

CheckHttp

检查网络资源

许可证

MIT License

153264 / think-health

Maintainers

Details