Health Check

Check connectivity to all providers.

Endpoint

GET /admin/health

Example Request

curl http://localhost:8000/admin/health

Response

string

Overall status: healthy or degraded

object

Status of each provider

Example Response (Healthy)

{
  "status": "healthy",
  "providers": {
    "postgres": "healthy",
    "opensearch": "healthy"
  }
}

Example Response (Degraded)

{
  "status": "degraded",
  "providers": {
    "postgres": "healthy",
    "opensearch": "error: Connection refused"
  }
}

Provider Status Values

Status	Description
`healthy`	Provider is connected and responding
`unhealthy`	Provider is not responding
`error: <message>`	Provider returned an error

Use Cases

Kubernetes Liveness Probe

livenessProbe:
  httpGet:
    path: /admin/health
    port: 8000
  initialDelaySeconds: 10
  periodSeconds: 30

Load Balancer Health Check

Configure your load balancer to check /admin/health and route traffic only to healthy instances.

Monitoring

Poll the health endpoint and alert when status is degraded:

#!/bin/bash
STATUS=$(curl -s http://localhost:8000/admin/health | jq -r '.status')
if [ "$STATUS" != "healthy" ]; then
  echo "ALERT: cogmem-kos is degraded"
fi

​Health Check

​Endpoint

​Example Request

​Response

​Example Response (Healthy)

​Example Response (Degraded)

​Provider Status Values

​Use Cases

​Kubernetes Liveness Probe

​Load Balancer Health Check

​Monitoring