Dynamo provides health check and liveness HTTP endpoints for each component which can be used to configure startup, liveness and readiness probes in orchestration frameworks such as Kubernetes.
Enable health checks and query endpoints:
Check health status:
The frontend liveness endpoint reports a status of live as long as
the service is running.
Note: Frontend liveness doesn’t depend on worker health or liveness only on the Frontend service itself.
The frontend health endpoint reports a status of healthy as long as
the service is running. Once workers have been registered, the
health endpoint will also list registered endpoints and instances.
Note: Frontend liveness doesn’t depend on worker health or liveness only on the Frontend service itself.
Before workers are registered:
After workers are registered:
Health checks for components other than the frontend are enabled
selectively based on environment variables. If a health check for a
component is enabled the starting status can be set along with the set
of endpoints that are required to be served before the component is
declared ready.
Once all endpoints declared in DYN_SYSTEM_USE_ENDPOINT_HEALTH_STATUS
are served the component transitions to a ready state until the
component is shutdown. The endpoints return HTTP status code of HTTP/1.1 503 Service Unavailable
when initializing and HTTP status code HTTP/1.1 200 OK once ready.
Note: Both /live and /ready return the same information
Before endpoints are being served:
After endpoints are being served: