Skip to main content

Module health

auth_framework::api

Module health

Expand description

Health Check and Monitoring API Endpoints

Provides system health, metrics, and monitoring endpoints

Structs§

DetailedHealthResponse: Detailed health check response
DiskInfo: Disk usage information
HealthResponse: Health check response
MemoryInfo: Memory usage information
Metric: Individual metric
MetricsResponse: Metrics response (Prometheus format)
NetworkInfo: Network information
ServiceHealth: Service health details
SystemHealth: System health information

Functions§

detailed_health_check: GET /health/detailed Detailed health check with service metrics
health_check: GET /health Basic health check endpoint
liveness_check: GET /liveness Kubernetes liveness probe endpoint
metrics: GET /metrics Prometheus metrics endpoint
readiness_check: GET /readiness Kubernetes readiness probe endpoint