Health

Health check endpoint with pluggable health checkers.

HealthChecker Interface

type HealthChecker interface {
    Name() string
    Check(ctx context.Context) error
}

Implement this interface for each service dependency:

type DBHealthChecker struct {
    db *sql.DB
}

func (h *DBHealthChecker) Name() string { return "database" }

func (h *DBHealthChecker) Check(ctx context.Context) error {
    return h.db.PingContext(ctx)
}

HealthHandler

func HealthHandler(checkers ...HealthChecker) HandlerFunc

Creates a handler that runs all health checkers and returns the aggregate status.

app.Get("/health", kruda.HealthHandler(
    &DBHealthChecker{db: db},
    &RedisHealthChecker{client: rdb},
))

Response Format

All healthy (HTTP 200):

{
  "status": "healthy",
  "checks": {
    "database": { "status": "healthy" },
    "redis": { "status": "healthy" }
  }
}

One or more unhealthy (HTTP 503):

{
  "status": "unhealthy",
  "checks": {
    "database": { "status": "healthy" },
    "redis": { "status": "unhealthy", "error": "connection refused" }
  }
}

Example

package main

import (
    "context"
    "github.com/go-kruda/kruda"
)

type AppChecker struct{}

func (c *AppChecker) Name() string                    { return "app" }
func (c *AppChecker) Check(ctx context.Context) error { return nil }

func main() {
    app := kruda.New()

    app.Get("/health", kruda.HealthHandler(&AppChecker{}))

    app.Listen(":3000")
}