Healthcheck endpoints
The healthcheck endpoint is accessed through:
GET /healthcheck
This endpoint provides:
- Readiness Verification: Returns HTTP Status
200 OK
to indicate service readiness. - Domain Validation: Displays the domain identifier, ensuring the service is responding from the correct domain.
- Reconfiguration Insights: Provides timestamps and statuses of recent reconfiguration attempts, including details on any failures to assist in diagnosing issues. If there was an unsuccessful domain reconfiguration attempt, an error message about the cause of the failure is included..
For an example of the healthcheck in use, see Verify that ADS is running.
Healthcheck probes
ADS reports its health status during different stages of its lifecycle to ensure its robustness in an orchestrated deployment.
In this regard, ADS exposes three types of probes to check the health of a container through the following probes:
Probes | Description | Failure Action |
---|---|---|
/healthcheck/liveness | Checks if the application is healthy. | Restarts the container to revive the application. |
/healthcheck/startup | Verifies if the application within a container has started. | Stops the container if the check fails and follows the pod's restart policy. |
/healthcheck/readiness | Determines if the container is ready to start accepting traffic. | Excludes the container from service endpoints if failing. |