postalservice14 / php-actuator-slim-provider
Slim Provider for php-actuator
1.0.0
2016-02-19 19:50 UTC
Requires
- php: ~5.5|~7.0
- postalservice14/php-actuator: ^1.0
Requires (Dev)
- phpunit/phpunit: 4.*
- scrutinizer/ocular: ~1.1
- slim/slim: ^3.0
- squizlabs/php_codesniffer: ~2.3
This package is auto-updated.
Last update: 2024-10-15 23:56:37 UTC
README
Slim Provider for php-actuator
Install
Via Composer
$ composer require postalservice14/php-actuator-slim-provider
Registering
$container = $app->getContainer(); $container['health.aggregator'] = new OrderedHealthAggregator(); $container['health.indicators'] = array( 'disk' => new DiskSpaceHealthIndicator() ); $container['health'] = function ($container) { return new HealthServiceProvider( $container['health.aggregator'], $container['health.indicators'] ); };
Usage
Setup the route you would like your health check on. e.g.:
$app->get('/health', function ($req, $res) { return $this->health->getHealth($res); });
Then visit your endpoint. In this case: /health
Getting Started
The following is a minimal example to get you started quickly. It uses the DiskSpaceHealthIndicator.
- Create a composer.json with at minimum, the following dependencies
{ "require": { "postalservice14/php-actuator-slim-provider": "^1.0" } }
- Run composer install
- Create /public/index.php
<?php require_once __DIR__.'/../vendor/autoload.php'; use Slim\App; use Actuator\Health\OrderedHealthAggregator; use Actuator\Health\Indicator\DiskSpaceHealthIndicator; use Actuator\Slim\Provider\HealthServiceProvider; $indicators = array( 'disk' => new DiskSpaceHealthIndicator() ); $app = new App(); $container = $app->getContainer(); $container['health.aggregator'] = new OrderedHealthAggregator(); $container['health.indicators'] = $indicators; $container['health'] = function ($container) { return new HealthServiceProvider( $container['health.aggregator'], $container['health.indicators'] ); }; $app->get('/health', function ($req, $res) { return $this->health->getHealth($res); }); $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
Change log
Please see CHANGELOG for more information what has changed recently.
Testing
$ composer test
Contributing
Please see CONTRIBUTING and CONDUCT for details.
Credits
License
The MIT License (MIT). Please see License File for more information.