Documentation

Health Checks

Expose /health, /ready, and /live endpoints.

Overview

Health endpoints help orchestrators and load balancers make safe decisions.

Example

Go

app.GET("/health", health.Status())
app.GET("/ready", health.Ready(deps))
app.GET("/live", health.Live())

Best Practices

  • Keep /live cheap and dependency-free.
  • Include dependency checks in /ready.

Common Pitfalls

  • Running expensive checks on every /health call.
  • Returning success before dependencies initialize.