@samveys/health

Liveness and readiness endpoints for load balancers and orchestrators.

• GET /health/live answers 200 { "status": "ok" } while the process runs.
• GET /health/ready runs every check and answers 200 when all pass, 503 when one fails or times out.
• Readiness flips to 503 (shutting_down) as soon as the app starts terminating, before the HTTP drain, so traffic moves away first.

#Use it

import { createApp } from '@samveys/core'
import { http } from '@samveys/http'
import { health } from '@samveys/health'

export const app = createApp({
  name: 'billing',
  plugins: [
    http(),
    health({
      checks: {
        // A check gets an AbortSignal and must finish within `timeout` (default 2000 ms).
        upstream: async () => ({ ok: true }),
      },
    }),
  ],
})

With @samveys/database registered, a database check (select 1) is added automatically.

#Options

Other plugins add checks through the core extension point extend.healthCheck({ name, run }) in their boot().

#Response

{ "status": "unavailable", "checks": { "database": { "ok": true }, "upstream": { "ok": false, "message": "timed out" } } }