Overview

Health

Health endpoints provide service status information for monitoring and operational purposes.

Endpoints

Endpoint	Purpose
/health	Overall service health
/health/ready	Readiness probe (Kubernetes)
/health/live	Liveness probe (Kubernetes)

Health Status Values

Status	Description
healthy	All systems operational
degraded	Partial functionality available
unhealthy	Service unavailable

Response Format

{
  "status": "healthy",
  "version": "0.7.20",
  "environment": "production",
  "timestamp": "2024-12-07T10:30:00Z"
}

Kubernetes Integration

Use these endpoints for container orchestration:

livenessProbe:
  httpGet:
    path: /api/health/live
    port: 8000
readinessProbe:
  httpGet:
    path: /api/health/ready
    port: 8000