通过
搜索
搜索oat-sa / bundle-health-check
健康检查组件
2.2.0
2022-09-05 10:41 UTC
Requires
- php: >=7.2.0
- ext-json: *
- oat-sa/lib-health-check: ^1.1
- psr/log: ^1.1
- symfony/console: ^4.4 || ^5.0 || ^6.0
- symfony/framework-bundle: ^4.4 || ^5.0 || ^6.0
- symfony/yaml: ^4.4 || ^5.0 || ^6.0
Requires (Dev)
- php-coveralls/php-coveralls: ^2.4
- phpunit/phpunit: 8.5.14
- symfony/browser-kit: ^4.4 || ^5.0
This package is auto-updated.
Last update: 2024-09-17 13:58:06 UTC
README
Symfony组件，用于自动化健康检查，基于健康检查库
目录
安装
$ composer require oat-sa/bundle-health-check
注意：相关的flex配方将自动在你的应用程序中启用和配置组件。
使用
可用端点
此组件默认提供以下端点
备注:
Ping
Ping端点仅返回带有字符串“pong”的200响应。
它仅用于确保您的应用程序正确安装、启动并运行。
健康检查器
如果您的应用程序服务实现了CheckerInterface（它们将自动注册到HealthChecker服务），则此组件将自动向其添加标签health_check.checker。
如果您想注册来自第三方库的CheckerInterface实现，可以按以下方式进行配置
# config/services.yaml services: My\Bundle\Checker\SomeChecker: tags: - { name: 'health_check.checker', priority: 2 } My\Bundle\Checker\OtherChecker: tags: - { name: 'health_check.checker', priority: 1 }
注意：您可以使用health_check.checker标签的priority属性来排序它们。
可用命令
如果您更喜欢在CLI模式下运行检查，此组件默认提供以下命令
$ bin/console health:check
备注:
- 它按上述部分中所述运行注册的检查器
- 如果整体成功，则返回
0，如果有一个（或多个）检查失败，则返回1 - 它显示所有执行检查器的摘要及其结果
测试
运行提供的测试
$ vendor/bin/phpunit
注意：有关可用套件的详细信息，请参阅phpunit文件。