3slab/vdm-healthcheck-bundle

Provide a simple healthcheck endpoint that checks dependencies too

Installs: 323

Dependents: 0

Suggesters: 0

Security: 0

Stars: 0

Watchers: 3

Forks: 1

Open Issues: 0

Type:symfony-bundle

1.0.0 2020-12-12 13:57 UTC

This package is auto-updated.

Last update: 2021-10-08 08:20:45 UTC


README

Build Status

This bundle provides all the tooling to implement simple healthcheck functionnality.

Installation

composer require 3slab/vdm-healthcheck-bundle

And load the routes in routing.yml :

vdm_healthcheck:
  resource: "@VdmHealthcheckBundle/Resources/config/routing.yml"
  prefix:   /

Configuration

Put your configuration in config/packages/vdm_healthcheck.yaml file. This is the default :

vdm_healthcheck:
  secret: ~
  liveness_path: /liveness
  liveness_checkers: {}
  readiness_path: /readiness
  readiness_checkers: {}
Parameter Default Description
vdm_healthcheck.secret null if set, you need to provide the secret as a GET parameter secret or in the
header VDM-HEALTHCHECK-SECRET to get the detailed result of the healthcheck in the response body.
vdm_healthcheck.liveness_path /liveness Change the path of the liveness endpoint.
vdm_healthcheck.liveness_checkers {} Configure a list of checker for the liveness endpoint. See below for
a detailed explanation.
vdm_healthcheck.readiness_path /readiness Change the path of the readiness endpoint.
vdm_healthcheck.readiness_checkers {} Configure a list of checker for the readiness endpoint. See below for
a detailed explanation.

liveness_checkers and readiness_checkers are hash map. The key is the name given to this check and the value is an hash map to configure the check.

vdm_healthcheck:
  liveness_checkers:
    name_of_your_checker:
      type: <checker type>
      arguments: []

Each checker has a name, a type and a list of constructor arguments depending on its type. Arguments support parameters surrounded by % or service id prefixed by @.

Exemple :

vdm_healthcheck:
  liveness_checkers:
    db:
      type: dbal
      arguments:
        - '@doctrine.dbal.default_connection'

Checker's types

You can also create your own checker