Monitoring CRDP health

CRDP provides healthz (readiness) and liveness API endpoints to monitor the current CRDP health.

1. healthz: Checks the current health of the CRDP container and reports whether it is ready to receive service requests. The readiness probe is served on port 8080. This endpoint doesn't support TLS.

   The health of the CRDP container is evaluated by the status code as follows:

   Status Code	Type	Description
   200	OK	CRDP is ready to receive requests.
   503	error	CRDP cannot process any requests, but it is recoverable. You can check the issue in the CRDP logs and fix it to recover from the error state.

   Example

   GET http://<crdp host IP>:<probes port>/healthz
   

   Output

   {
     "status": "OK"
   }
   

   In the above API call, replace <crdp host IP> and <probes port> with the valid values from the CRDP deployment.

2. liveness: Checks whether the current CRDP container is running actively. The liveness probe is served on port 8080. This endpoint doesn't support TLS.

   The liveness of the CRDP container is evaluated by the status code as follows:

   Status Code	Type	Description
   200	OK	CRDP is ready to receive requests.
   503	error	CRDP cannot process any requests and is not recoverable. Restart or redeploy the CRDP container to recover from the error state.

   Example

   GET http://<crdp host IP>:<probes port>/liveness
   

   Output

   {
     "status": "OK"
   }
   

   In the above API call, replace <crdp host IP> and <probes port> with the valid values from the CRDP deployment.

Refer to CRDP API Reference for details.