symsensor / actuator-maintenance-bundle
为ActuatorBundle扩展提供维护模式下的健康检查功能。
v1.0.1
2024-03-22 13:15 UTC
Requires
- symfony/framework-bundle: ^6.0 || ^7.0
- symsensor/actuator-bundle: ^1.1
Requires (Dev)
- friendsofphp/php-cs-fixer: ^3.22
- mikey179/vfsstream: ^1.6
- phpstan/phpstan: ^1.10
- phpstan/phpstan-phpunit: ^1.1
- phpstan/phpstan-symfony: ^1.1
- phpunit/phpunit: ^10.3
- symfony/browser-kit: ^6.0
- symfony/yaml: ^6.0
README
ActuatorMaintenanceBundle通过提供健康指标来扩展ActuatorBundle,该指标将指示应用程序是否处于维护模式。
安装
确保全局已安装Composer,如Composer文档中的安装章节
所述。
使用Symfony Flex的应用程序
打开命令行,进入您的项目目录并执行以下操作
$ composer require symsensor/actuator-maintenance-bundle
不使用Symfony Flex的应用程序
步骤1:下载Bundle
打开命令行,进入您的项目目录并执行以下命令以下载此Bundle的最新稳定版本
$ composer require symsensor/actuator-maintenance-bundle
步骤2:启用Bundle
然后,通过将其添加到项目config/bundles.php
文件中注册的Bundle列表中来启用Bundle
// config/bundles.php return [ // ... SymSensor\ActuatorBundle\SymSensorActuatorMaintenanceBundle::class => ['all' => true], ];
配置
可以通过名为config/packages/sym_sensor_actuator.yaml
的配置文件配置Bundle。以下代码片段显示了所有配置的默认值
sym_sensor_actuator_maintenance: enabled: true files: - /tmp/maintenance - /var/www/html/maintenance
列出应监视的所有文件。如果文件存在、可由用户读取并包含内容"1"(不带换行符),则此扩展将使健康指标为红色。如果声明了多个文件,则只需满足一个文件的准则即可。
许可证
ActuatorBundle在MIT许可证下发布。有关详细信息,请参阅捆绑的LICENSE文件。
作者
最初由Arkadiusz Kondas开发。