Health Endpoints Guide | PraisonAIUI Docs

Health Endpoints GuideOverviewPraisonAIUI provides multiple health endpoints optimized for different use cases:/health/live - Fast liveness check (<500ms)/health/ready - Readiness check with optional deep checks/health - Legacy endpoint (backward compatibility)EndpointsLiveness Check: `/health/live`Fast endpoint to verify the server is running. Returns immediately with minimal processing.Use for:Load balancer health probesKubernetes liveness probesHigh-frequency monitoringResponse time: <500ms (typically <100ms)Example:Response:Readiness Check: `/health/ready`Verifies the server is ready to handle requests. Performs parallel health checks on all features with timeout protection.Use for:Kubernetes readiness probesPre-deployment validationDetailed diagnosticsQuery parameters:?deep=false - Skip feature checks for faster responseResponse time:With deep checks: <1s (parallel execution)Without deep checks: <200msExample:Response with deep checks:API Health: `/api/health`Cached version of readiness check for dashboard polling. 30-second TTL to reduce load.Use for:Dashboard health indicatorsFrequent client pollingStatus pagesResponse: Same as /health/ready but cached for 30 secondsDeployment ConfigurationsKubernetesAWS ALB/ELBDocker ComposeNginxMigration GuideIf you're upgrading from a version using only /health:1. Update monitoring: Change health checks to use /health/live for liveness2. Update readiness: Use /health/ready?deep=false for readiness probes3. Update dashboards: Point status indicators to /api/health (cached)4. Backward compatibility: The /health endpoint remains available but may be slowPerformance Characteristics| Endpoint | Cold Start | Warm (p50) | Warm (p95) | Use Case ||----------|------------|------------|------------|----------|| /health/live | <100ms | <20ms | <50ms | Liveness probes || /health/ready?deep=false | <200ms | <50ms | <100ms | Basic readiness || /health/ready | <1s | <500ms | <800ms | Full diagnostics || /api/health (cached) | <1s* | <20ms | <50ms | Dashboard polling |*First request only, then cached for 30sTroubleshootingSlow `/health` responsesIf you're seeing slow responses on the legacy /health endpoint:Switch to /health/live for fast checksUse /health/ready?deep=false if you don't need feature healthEnable caching with /api/health for frequent pollingFeature timeoutsFeatures that timeout in /health/ready will show:This indicates the feature took longer than 500ms to respond. The server is still operational, but that specific feature may be experiencing issues.High latency under loadUnder high load, use /health/live exclusively for monitoring. It has minimal overhead and won't impact performance.