Monitoring DPG health

<<<<<<< HEAD DPG provides healthz and liveness API endpoints to monitor the current DPG health.

1. healthz: Checks the current health of the DPG container and reports whether DPG is running fine.

   • If the status code 200 (status is OK ) is returned, DPG is running fine. You can proceed with your operations.

   • If the status code 503 (an error), DPG can't process any requests but it is recoverable. Check the issue in the DPG logs and fix the issue to recover from the error state.

   Example

   GET https://<DPG instanceip>:<port>/healthz
   

   Output

   {
     "status": "OK"
   }
   

   In the above API call, replace <DPG instanceip> and <port> with the actual values from your DPG deployment.

2. liveness: Checks the liveness of the DPG container whether DPG is running healthy.

   • If the status code 200 (status is OK ) is returned, DPG is running fine. You can proceed with your operations.

   • If the status code 503 (an error) is returned, DPG can't process any requests and isn't recoverable. In this case, you need to restart or redeploy the DPG container.

   Example

   GET https://<DPG instanceip>:<port>/liveness
   

   Output

   {
     "status": "OK"
   }
   

   In the above API call, replace <DPG instanceip> and <port> with the actual values from your DPG deployment.

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

healthz

Checks the current health of the DPG container and reports whether it is ready to receive service requests. The readiness probe is served on non-TLS port 8080.

The health of the DPG container is evaluated by the following status codes:

• Status code 200 (status is OK ) – DPG is ready to serve requests.

• Status code 503 (an error) – DPG can't process any requests but it is recoverable. Check the DPG logs and fix the issue to recover from the error state.

Example

GET https://<dpg host IP>:<probes port>/healthz

Output

{
    "status": "OK"
}

In the above API call, replace <dpg host IP> and <probes port> with the actual values from your DPG deployment.

liveness

Checks whether the DPG container is live and healthy. The liveness probe is served on non-TLS port 8080.

The liveness of the DPG container is evaluated by the following status codes:

• Status code 200 (status is OK ) – DPG is ready to serve requests.

• Status code 503 (an error) – DPG can't process any requests and isn't recoverable. Restart or redeploy the DPG container to recover from the error state.

Example

GET https://<dpg host IP>:<probes port>/liveness

Output

{
    "status": "OK"
}

In the above API call, replace <dpg host IP> and <probes port> with the actual values from your DPG deployment.

v-1.5.0