zucommunications/health-check-bundle

Symfony 包提供健康检查端点

维护者

详细信息

github.com/ZuCommunications/health-check-bundle

源代码

问题

安装: 14

依赖: 0

建议者: 0

安全: 0

星标: 0

关注者: 3

分支: 0

开放问题: 1

类型:symfony-bundle

v0.2.0 2024-07-10 16:01 UTC

Requires

Requires (Dev)

Conflicts

proprietary 347e6cedb7af9eb22ade13b3bde8a7520f47de79

This package is not auto-updated.

Last update: 2024-09-18 16:48:10 UTC

README

⚠️ 此包仍在积极开发中，尚未准备使用！⚠️

简介

此包为您的 Symfony 应用程序提供了一个简单的健康检查端点。它可以用来检查应用程序及其服务的状态。

此包提供了两个端点：用于一般健康检查的 /ping 和用于配置服务的更详细健康检查的 /health-check。

要配置要检查的服务，您可以将以下配置添加到您的 zu_health_check.yaml 文件中

zu_health_check:
    type:
        smtp: false
        doctrine: false

错误信息目前要求您检查日志，这尚未实现。

要求

  • PHP 版本（例如，PHP 8.3 或更高版本）
  • Symfony 版本（例如，Symfony 6.4 或更高版本）

Doctrine 健康检查

需要 symfony/orm-pack 包。

邮件健康检查

需要 symfony/mailer 包。

安装

运行以下命令安装此包

composer require zu/health-check-bundle

配置

⚠️ 目前未设置 Flex，因此您需要手动启用此包。⚠️ 如果您已安装 symfony/flex，则包应自动启用，您可以跳过此步骤。

如果没有，您可以通过将以下行添加到您的 config/bundles.php 文件中来手动启用该包

return [
    ...
    Zu\HealthCheckBundle\ZuHealthCheckBundle::class => ['all' => true],
    ...
];

接下来，您需要为健康检查端点注册路由。您可以通过将以下内容添加到您的 config/routes.yaml 文件中来实现

...
zu_health_check_bundle:
  resource: '@ZuHealthCheckBundle/config/routes.yaml'
...

要配置要检查的服务，您可以将以下配置添加到您的 zu_health_check.yaml 文件中

zu_health_check:
    type:
        smtp: false
        doctrine: false

开发

  • 为了在 Symfony 应用程序中运行此包，您需要克隆此存储库并将其添加到您的 Symfony 应用程序中作为本地包。
  • 待办事项：然后您可以通过运行 composer require zu/health-check-bundle 来安装包。

测试

运行 php bin/phpunit 来运行测试，或运行 XDEBUG_MODE=coverage ./vendor/bin/phpunit --coverage-text 以查看文本覆盖率报告。

我们希望将测试覆盖率保持得尽可能高，因此请确保为任何新编写的代码编写测试。