bramr/stack-heartbeat

Stack middleware which provides a heartbeat url for your application

v1.0.0 2016-06-04 14:07 UTC

Requires

• php: >=5.4.0
• symfony/http-foundation: ~2.1|~3.0
• symfony/http-kernel: ~2.1|~3.0

Requires (Dev)

• stack/builder: ~1.0@dev
• stack/callable-http-kernel: ~1.0@dev
• stack/run: ~1.0@dev

MIT

• Bram Rohde

README

A simple Stack middleware which adds a route to your application to respond to heartbeat requests.

Installation

The easiest way to install stack-heartbeat is through Composer.

composer require bramr/stack-heartbeat

Usage

By default the middleware responds to the route: /heartbeat.check with a plain text message "OK"

public function __construct(HttpKernelInterface $app, $route = '/heartbeat.check', callable $handler = null)

The optional constructor arguments allows you to change the route or add a custom handler when the route is called. This allows you to alter the response but also to add checks to your application which check dependencies like a database, files, etc.

An example:

$app = new  CallableHttpKernel(function (Request $request) {
    return new Response('#yolo');
});

$app = (new Stack\Builder)
    ->push(BramR\Stack\Heartbeat::class)
    ->push(BramR\Stack\Heartbeat::class, '/custom', function () use ($diContainer) {
        return new Response(
            'Implement custom heartbeat check, to check some stuff in db:' . $diContainer['db.name']
        );
    })
    ->resolve($app);

Stack\run($app);

See example.php for a complete (and more complicated) example.

License

MIT, for details see LICENSE file.

Inspired by Rack::Heartbeat.