3slab/vdm-healthcheck-bundle

Provide a simple healthcheck endpoint that checks dependencies too

1.2.0 2024-03-26 15:16 UTC

Requires

• php: >=7.2
• symfony/framework-bundle: ^5.4|^6.4
• symfony/property-access: ^5.4|^6.4
• symfony/serializer: ^5.4|^6.4
• symfony/yaml: ^5.4|^6.4

Requires (Dev)

• ext-curl: *
• ext-json: *
• ext-mbstring: *
• ext-sqlite3: *
• ext-xml: *
• doctrine/doctrine-bundle: ^2
• phpunit/phpunit: ^8|^9
• squizlabs/php_codesniffer: 3.*
• symfony/browser-kit: ^5.4
• symfony/css-selector: ^5.4
• symfony/http-client: ^5.4

Suggests

• doctrine/dbal: check a connection to an sql database
• doctrine/mongodb-odm-bundle: check a connection to a mongo database with doctrine odm
• symfony/http-client: check a dependent http service is up

proprietary

• Jonathan Bouzekri
• Julian Marié

README

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

• Doctrine DBAL
• Doctrine ODM
• HTTP

You can also create your own checker