Skip to main content

Health

Monitor application health and readiness.

Overview​

Health endpoints provide insights into the application's operational status:

  • Overall Health — Is the app running?
  • Liveness Probe — Is the app responsive? (Kubernetes)
  • Readiness Probe — Is the app ready to serve traffic? (Kubernetes)

These endpoints follow Spring Boot Actuator conventions and integrate with Kubernetes orchestration.

Use Cases​

  • Kubernetes Liveness Probe — Restarts pod if app is unresponsive
  • Kubernetes Readiness Probe — Removes pod from load balancer if not ready
  • Load Balancer Health Checks — Verify backend health
  • Monitoring Dashboards — Track uptime and dependencies
  • CI/CD Pipelines — Wait for app startup before running tests

Operations​

📄️ Application health

Returns liveness and readiness status including the status of downstream

📄️ Kubernetes liveness probe

Returns UP if the application process is alive. Used by Kubernetes to decide whether to restart the pod.

📄️ Kubernetes readiness probe

Returns UP if the application is ready to serve traffic. Used by Kubernetes to control load-balancer routing.

Example: Check Health​

# Full health report with all dependencies
curl http://localhost:8080/actuator/health

# Response:
# {
#   "status": "UP",
#   "components": {
#     "db": { "status": "UP" },
#     "kafka": { "status": "UP" },
#     "diskSpace": { "status": "UP" }
#   }
# }

Kubernetes Integration​

Liveness Probe Configuration​

livenessProbe:
  httpGet:
    path: /actuator/health/liveness
    port: 8080
  initialDelaySeconds: 30
  periodSeconds: 10

Readiness Probe Configuration​

readinessProbe:
  httpGet:
    path: /actuator/health/readiness
    port: 8080
  initialDelaySeconds: 20
  periodSeconds: 5

Dependencies Checked​

  • Database — PostgreSQL connectivity
  • Kafka — Message broker availability
  • Disk Space — Storage capacity
  • Custom Checks — Application-specific health

Schema References​

See the Schemas section in the sidebar for detailed definitions. Key schemas for this API: