tseguier/health-check

一个提供健康检查路由的包,具有可扩展的接口,用于您的自定义检查服务。

该包的规范存储库似乎已消失,因此该包已被冻结。

安装: 420

依赖项: 2

建议者: 0

安全: 0

星级: 0

关注者: 2

分支: 2

开放问题: 8

类型:symfony-bundle

v0.2.2 2019-08-14 17:18 UTC

This package is auto-updated.

Last update: 2019-09-23 11:58:20 UTC


README

一个控制器,用于检查实现HealthCheckInterface的所有容器。它将调用每个容器的checkHealth方法,并显示JSON输出:{ "status": 如果所有容器都返回了状态为true的HealthData,则为true,否则为false。 "timestamp": 实际日期 }

安装

使用composer安装

composer require tseguier/health-check

将包添加到您的bundles.php中

Tseguier\HealthCheckBundle\HealthCheckBundle::class => ['all' => true],

在您的routes.yaml中配置控制器路由

health_check:
  resource: "@HealthCheckBundle/Controller/HealthCheckController.php"
  prefix: /
  type: annotation

配置

时间戳格式可以在date_format配置字段中配置,默认为'Y-m-d H:i:s T'

健康检查服务

要检查服务的健康状态,只需将其实现为HealthCheckInterface

例如

use Tseguier\HealthCheckBundle\Dto\HealthData;
use Tseguier\HealthCheckBundle\HealthCheckInterface;

final class HealthCheckerService implements HealthCheckInterface
{

    public function checkHealth(): HealthData
    {
        if ($this->somethingToCheck->isWorking()) {
          return new HealthData(true);
        } else {
          return new HealthData(false);
        }
    }
}

下一个版本

  • 检查服务的附加数据
  • 详细信息路由