akondas / symfony-actuator-bundle
Production-ready features for your Symfony application
Installs: 3 449
Dependents: 0
Suggesters: 0
Security: 0
Stars: 7
Watchers: 5
Forks: 1
Open Issues: 3
Type:symfony-bundle
Requires
- php: ^7.4 || ^8.0
- symfony/framework-bundle: ^5.2
Requires (Dev)
- friendsofphp/php-cs-fixer: ^2.16
- phpstan/phpstan: ^0.12.70
- phpunit/phpunit: ^9.5
- symfony/browser-kit: ^5.2
- symfony/yaml: ^5.2
This package is auto-updated.
Last update: 2024-10-30 01:42:57 UTC
README
Production-ready features for your Symfony application. Actuator endpoints let you monitor and interact with your application
Features
- REST API endpoints (
/api/actuator
) - UI console (not implemented)
Endpoints
-
/health (
components
in progress){ "status": "up" }
-
/info
{ "git": { "branch": "actuator", "commit": "6c01dce07274c6fddfd58610cf5fe14964689edd" }, "php": { "version": "7.4.3", "architecture": 64, "intlLocale": "en", "timezone": "Europe/Berlin", "xdebugEnabled": false, "apcuEnabled": false, "opCacheEnabled": true }, "symfony": { "version": "5.2.2", "lts": false, "environment": "dev", "endOfMaintenance": "July 2021", "endOfLife": "July 2021", "bundles": { "FrameworkBundle": "Symfony\\Bundle\\FrameworkBundle\\FrameworkBundle", "SensioFrameworkExtraBundle": "Sensio\\Bundle\\FrameworkExtraBundle\\SensioFrameworkExtraBundle", "TwigBundle": "Symfony\\Bundle\\TwigBundle\\TwigBundle", "MonologBundle": "Symfony\\Bundle\\MonologBundle\\MonologBundle", "DoctrineBundle": "Doctrine\\Bundle\\DoctrineBundle\\DoctrineBundle", "DoctrineMigrationsBundle": "Doctrine\\Bundle\\MigrationsBundle\\DoctrineMigrationsBundle", "SecurityBundle": "Symfony\\Bundle\\SecurityBundle\\SecurityBundle", "ActuatorBundle": "Akondas\\ActuatorBundle\\ActuatorBundle" } }, "database": { "default": { "type": "stgreSQL100", "database": "app", "driver": "Symfony\\Bridge\\Doctrine\\Middleware\\Debug\\Driver" } } }
Install
composer require akondas/symfony-actuator-bundle
Add ActuatorBundle
to config/bundles.php
Akondas\ActuatorBundle\ActuatorBundle::class => ['all' => true]
Add actuator.yaml
to config/routes
directory (you can change prefix):
web_profiler_wdt: resource: '@ActuatorBundle/Resources/config/routing.yaml' prefix: /api/actuator
Security
⚠️Be aware that this bundle provides information and functionalities that may be potentially dangerous for your application.
Use the built-in symfony/security component to secure api.
Example configuration (security.yaml
) for Basic Authentication:
security: providers: in_memory: memory: users: admin: password: 'password' roles: 'ROLE_ACTUATOR' firewalls: actuator: http_basic: ~ access_control: - { path: ^/api/actuator, roles: ROLE_ACTUATOR } encoders: Symfony\Component\Security\Core\User\User: plaintext
Extending
Health indicator
You can write your own health indicator and implement your own logic to determine the state of your application. To do so, you have to implement the interface HealthIndicator
and tag your service with the tag akondas.health_indicator
.
So for example, add following class under src/Health/CustomHealthIndicator.php
:
<?php declare(strict_types=1); namespace App\Health; use Akondas\Service\Health\HealthIndicator; use Akondas\Service\Health\Health; class CustomHealthIndicator implements HealthIndicator { public function name(): string { return 'custom'; } public function health(): Health { return Health::up()->setDetails(['state' => 'OK!']); } }
Then add following definition to config/services.yaml
:
services: App\Health\CustomHealthIndicator: tags: ['akondas.health_indicator']
Information Collector
Similar to a health indicator, you can write also a service which exposes informations. To do so, you have to implement the interface Collector
and add the tag akondas.info_collector
.
<?php declare(strict_types=1); namespace App\Info; use Akondas\Service\Info\Collector\Collector; use Akondas\Service\Info\Info; class CustomInfoCollector implements Collector { public function collect(): Info { return new Info('my-info', [ 'time' => time() ]); } }
Then add following definition to config/services.yaml
:
services: App\Info\CustomInfoCollector: tags: ['akondas.info_collector']
Configuration reference
The bundle works out of the box with no configuration. If you want to change the default configuration, create a configuration file under config/packages/actuator.yaml
. The default configuration is as follows:
actuator: health: enabled: true builtin: disk_space: enabled: true threshold: 52428800 path: '%kernel.project_dir%' database: enabled: true connections: default: service: 'Doctrine\DBAL\Connection' check_sql: 'SELECT 1' info: enabled: true builtin: php: enabled: true symfony: enabled: true git: enabled: true database: enabled: true connections: connection_name: 'Doctrine\DBAL\Connection'
Following table outlines the configuration:
Roadmap
- flex recipe
- status for components (database, mailer, notifier, etc.)
- endpoints for components:
- messenger: show failed message, retry by message class (most wanted feature!)
- mailer: send email,
- cache: clear cache maybe?
- notifier: trigger test notification
- UI: same as rest api but presented in the beauty of the admin panel. In particular, I care about the messenger component, because at the moment retrying erroneous messages is very clunky
License
SymfonyActuatorBundle is released under the MIT Licence. See the bundled LICENSE file for details.