Download the PHP package symsensor/actuator-bundle without Composer
On this page you can find all versions of the php package symsensor/actuator-bundle. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
FAQ
Example:
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Informations about the package actuator-bundle
ActuatorBundle
ActuatorBundle provides basically two features:
- It provides an endpoint which can be used as a health probe url
- With another endpoint you can read runtime informations about the deployed software
It is also easily extensible, so you add your custom logic to both features. Some predefined extensions can be also found within this GitHub organization.
The bundle is heavily inspired by akondas/symfony-actuator-bundle.
Installation
Make sure Composer is installed globally, as explained in the installation chapter of the Composer documentation.
Applications that use Symfony Flex
Open a command console, enter your project directory and execute:
Applications that don't use Symfony Flex
Step 1: Download the Bundle
Open a command console, enter your project directory and execute the following command to download the latest stable version of this bundle:
Step 2: Enable the Bundle
Then, enable the bundle by adding it to the list of registered bundles
in the config/bundles.php file of your project:
After the installation you have to configure the routing in your config/routes.yaml file:
The routing defines two endpoints:
<prefix>/health<prefix>/info
You should secure the two endpoints with the builtin Security so that the two endpoints are not public accessible.
Configuration
The Bundle can be configured with a configuration file named config/packages/sym_sensor_actuator.yaml. Following snippet shows the default value for all configurations:
Following table outlines the configuration:
| key | default | description |
|---|---|---|
| sym_sensor_actuator.health.enabled | true | if the health endpoint should be enabled |
| sym_sensor_actuator.health.disk_space.enabled | true | if the builtin disk_space health endpoint should be enabled |
| sym_sensor_actuator.health.disk_space.threshold | 52428800 | Size in bytes which has to be free in order that this health endpoint is "UP" |
| sym_sensor_actuator.health.disk_space.path | '%kernel.project_dir%' | The directory which should be monitored |
| sym_sensor_actuator.info.enabled | true | if the info endpoint should be enabled |
| sym_sensor_actuator.info.builtin.php.enabled | true | if the php info endpoint should be enabled |
| sym_sensor_actuator.info.builtin.symfony.enabled | true | if the symfony info endpoint should be enabled |
| sym_sensor_actuator.info.builtin.git.enabled | true | if the git info endpoint should be enabled |
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 sym_sensor_actuator.health_indicator.
So for example, add following class under src/Health/CustomHealthIndicator.php:
Then add following definition to config/services.yaml:
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 sym_sensor_actuator.info_collector.
Then add following definition to config/services.yaml:
License
ActuatorBundle is released under the MIT Licence. See the bundled LICENSE file for details.
Author
Originally developed by Arkadiusz Kondas
