ekreative/health-check-bundle

A bundle that provides a simple /healthcheck route

Health Check Bundle

A bundle that provides a simple /healthcheck route, _(*1)

, _(*2)

Install

Composer

composer require ekreative/health-check-bundle

AppKernel

Include the bundle in your AppKernel, _(*3)

public function registerBundles()
{
    $bundles = [
        ...
        new Ekreative\HealthCheckBundle\EkreativeHealthCheckBundle(),

Routing

ekreative_health_check:
    resource: '@EkreativeHealthCheckBundle/Resources/config/routes.xml'

Security

You should make sure /healthcheck does not require authentication, _(*4)

security:
    firewalls:
        healthcheck:
            pattern: ^/healthcheck
            security: false

Configuration

By default healthcheck will check that your default doctrine connection is working., _(*5)

Doctrine

To check more than one doctrine connection you should add the configuration, listing the names of the connections, _(*6)

ekreative_health_check:
    doctrine:
        - 'default'
        - 'alternative'

You can also list doctrine connections that should be checked, but don't cause a failure, _(*7)

ekreative_health_check:
    optional_doctrine:
        - 'another.optional'

Its possible to disable the doctrine check, _(*8)

ekreative_health_check:
    doctrine_enabled: false

Timeout

Its recommended to change the default PDO connection timeout so that your health check will fail faster, _(*9)

Add this under connection setting, _(*10)

doctrine:
    dbal:
        connections:
            default:
                driver: pdo_mysql
                host: '%database_host%'
                options:
                    !php/const PDO::ATTR_TIMEOUT: 5

Redis

The bundle can also check that redis connections are working. You should add a list of service names to check, _(*11)

This will require the PHP Redis extension enabled., _(*12)

ekreative_health_check:
    redis:
        - 'redis'

You can also list redis connections that should be checked, but don't cause a failure, _(*13)

ekreative_health_check:
    optional_redis:
        - 'redis.optional'

Timeout

Its recommended to change the default Redis connection timeout so that your health check will fail faster. Its the third argument to connect call for \Redis., _(*14)

services:
    redis:
        class: Redis
        calls:
            - [ connect, ['%redis_host%', '%redis_port%', 5]]

Redis

When you want redis to be optional, you might want to use the provided RedisFactory (or your own) that catches any exceptions on connect. Without this a Redis failure will cause the container to fail, resulting in a 500 error., _(*15)

services:
    redis:
        class: Redis
        factory: Ekreative\HealthCheckBundle\DependencyInjection\RedisFactory::get
        arguments:
            $host: 'example.com'