README

此包提供实现简单健康检查功能的所有工具。

安装

composer require 3slab/vdm-healthcheck-bundle

并在 routing.yml 中加载路由

vdm_healthcheck:
  resource: "@VdmHealthcheckBundle/Resources/config/routing.yml"
  prefix:   /

将配置放在 config/packages/vdm_healthcheck.yaml 文件中。这是默认配置

vdm_healthcheck:
  secret: ~
  liveness_path: /liveness
  liveness_checkers: {}
  readiness_path: /readiness
  readiness_checkers: {}

liveness_checkers 和 readiness_checkers 是哈希表。键是检查的名称，值是配置检查的哈希表。

vdm_healthcheck:
  liveness_checkers:
    name_of_your_checker:
      type: <checker type>
      arguments: []

每个检查器都有一个名称、一个类型以及其类型依赖的构造函数参数。参数支持用 % 包围的参数或以 @ 开头的服务ID。

示例

vdm_healthcheck:
  liveness_checkers:
    db:
      type: dbal
      arguments:
        - '@doctrine.dbal.default_connection'