Skip to main content

Module health_api

Module health_api 

Source

Enums§

GetHealthDetailedError
struct for typed errors of method get_health_detailed
GetHealthStatusError
struct for typed errors of method get_health_status

Functions§

get_health_detailed
Returns detailed health information including database pool stats, worker details, and queue status. Requires authentication. Use for monitoring dashboards and debugging. This endpoint always returns fresh data (no caching).
get_health_status
Health status endpoint. Returns cached health status (database connectivity, worker count). Cache TTL is fixed at 5 seconds. Use force=true query parameter to bypass cache. Note: This endpoint is intentionally different from Kubernetes probes to avoid confusion. For k8s liveness/readiness probes, use /version endpoint.