Health checks

DES health check

DES provides a health check endpoint that can be used to check the status of the application. This endpoint is useful for monitoring and ensuring that the application is running correctly.

The health check endpoint is available at /health and returns a JSON response indicating the status of the application. More details on the health check endpoint can be found in the API documentation.

Workers health check

To add a health check for workers, there is a need to expose the port for health check probes. An example of adding the health check probes for GoodJob can be found in the GoodJob documentation

Ensure the background worker pods run with the env var GOOD_JOB_PROBE_PORT set to 7001. The pods will listen for traffic on that port and serve the following endpoints:

GET /status/started - suitable for startup probe

GET /status/connected - suitable for liveness probe