postalservice14/php-actuator-silex-provider

Silex Provider for php-actuator

php-actuator-silex-provider

![Software License][ico-license] ![Coverage Status][ico-scrutinizer] ![Total Downloads][ico-downloads], _(*1)

Silex Provider for php-actuator, _(*2)

Install

Via Composer, _(*3)

``` bash $ composer require postalservice14/php-actuator-silex-provider, <sub>(*4)</sub>

## Parameters

* **health.indicators**: An array of indicators to be used. Key as indicator name, value as indicator object.
* **health.endpoint**: Endpoint for health checks.  Defaults to "/health".

## Registering

```php
$app->register(new Actuator\Silex\Provider\HealthServiceProvider(), array(
    "health.indicators" => array(
        new DiskSpaceHealthIndicator()
    )
));

Usage

The following route is made available by default (unless you changed the "health.endpoint"):, <sub>(*5)</sub>

• GET /health: Get health indicator statuses

Getting Started

The following is a minimal example to get you started quickly. It uses the DiskSpaceHealthIndicator., <sub>(*6)</sub>

• Create a composer.json with at minimum, the following dependecies

{
    "require": {
        "postalservice/php-actuator": "^1.0"
    }
}

• Run composer install
• Create /public/index.php

require_once __DIR__.'/../vendor/autoload.php';

use Silex\Application;
use Actuator\Health\Indicator\DiskSpaceHealthIndicator;
use Actuator\Health\Indicator\DoctrineConnectionHealthIndicator;
use Doctrine\DBAL\DriverManager;

$app = new Application();
$app['debug'] = true;

$app->register(new Actuator\Silex\Provider\HealthServiceProvider(), array(
    "health.indicators" => array(
        'diskspace' => new DiskSpaceHealthIndicator()
    )
));

$app->run();

• Run the service php -S localhost:8000 -t public public/index.php
• Go to http://localhost:8000/health to see your health indicator.

Example

Available at /example, <sub>(*7)</sub>

Change log

Please see CHANGELOG for more information what has changed recently., <sub>(*8)</sub>

Testing

bash $ composer test, <sub>(*9)</sub>

Contributing

Please see CONTRIBUTING and CONDUCT for details., <sub>(*10)</sub>

Credits

• John Kelly
• All Contributors

License

The MIT License (MIT). Please see License File for more information., <sub>(*11)</sub>