icyboy/health-check

PHP 的 healthcheck

1.0.4 2018-01-15 08:58 UTC

This package is not auto-updated.

Last update: 2024-09-15 04:36:43 UTC


README

允许您轻松编写应用程序的健康检查,并显示一个简单、汇总的报告,以便您可以快速诊断应用程序是否有问题(或者是否可以怪罪其他人)。您还可以使用 nagioszabbix 等工具监控健康检查。

Build Status

等等,什么是健康检查?

健康检查是测试系统健康和与其他服务连接性的好方法。例如,您可以验证与 memcache 或 mysql 的连接性,确认您的应用程序可以读取/写入特定文件,或者第三方服务的 API 密钥仍然有效。

安装

您可以使用 composer 将此安装到您的项目中。在项目根目录下创建一个 composer.json 文件,并添加以下内容

{
    "require": {
        "php": ">=5.4.0",
        "icyboy/health-check": "~1.0"
    }
}

运行 composer install,包括 vendor/autoload.php,然后您就可以开始了!

示例用法

检查

use Icyboy\HealthCheck\HealthManager;
use Icyboy\HealthCheck\HealthException;

$hc = new HealthManager();

$hc->addCheck('info', function(){
    return "response extra message";
});

$hc->addCheck('pass', function() {
    return true;
});

$hc->addCheck('fail', function() {
    return false;
});

$config["version"] = 123;
$hc->addCheck('xxx', function() use ($config) {
    if ($config["version"] == "123") {
        return $config;
    } else {
        throw new HealthException("something was wrong");
    }
});

echo json_encode($hc->check());