Getting started

Install healthzkit, expose /healthz/live and /healthz/ready, and point Kubernetes at those routes. For a real database check using your existing client, follow Integrate healthzkit. The custom database adapter below is a placeholder; replace it before using it in production.

Hono (copy-paste)

pnpm add healthzkit hono

npm install healthzkit hono

import { Hono } from "hono";
import { createHealthKit, toFetchResponse } from "healthzkit";

const kit = createHealthKit({
  checks: [
    {
      name: "process",
      type: ["liveness", "startup"],
      adapter: { check: async () => ({ status: "ok" }) },
    },
    {
      name: "db",
      type: ["readiness"],
      adapter: {
        check: async () => {
          // ping your database, or use @healthzkit/postgres, drizzle, prisma, …
          return { status: "ok" };
        },
      },
    },
  ],
});

const app = new Hono();
app.get("/healthz/live", async () => toFetchResponse(await kit.handleLiveness()));
app.get("/healthz/ready", async () => toFetchResponse(await kit.handleReadiness()));
app.get("/healthz/startup", async () => toFetchResponse(await kit.handleStartup()));

export default app;

Point a liveness probe at GET /healthz/live and a readiness probe at GET /healthz/ready.

Need Express, Fastify, Elysia, Next.js, or Node http? See Framework guides.

Fetch-API servers (Bun, Deno, Workers)

pnpm add healthzkit

npm install healthzkit

import { createFetchHandler, createHealthKit } from "healthzkit";

const kit = createHealthKit({
  checks: [
    { name: "process", type: ["liveness"], adapter: { check: async () => ({ status: "ok" }) } },
  ],
});

const handler = createFetchHandler(kit);

createFetchHandler answers {basePath}/live, {basePath}/ready, and {basePath}/startup (default /healthz) on GET and HEAD. Other methods on those routes return 405. Unknown paths return 404.

`handleRequest`

If you already route HTTP yourself, pass the incoming path:

const res = await kit.handleRequest({ path: "/healthz/ready", method: "GET" });
if (res) {
  // res.status, res.headers, res.body
}

Default routes and `basePath`

By default, healthzkit expects:

Path	Behavior
`{basePath}/live`	Runs checks whose `type` includes `"liveness"`
`{basePath}/ready`	Runs checks whose `type` includes `"readiness"`
`{basePath}/startup`	Runs checks whose `type` includes `"startup"`

The default basePath is /healthz. Set basePath in the root config to move all three routes (for example /api/health → /api/health/live, /api/health/ready, and /api/health/startup). handleRequest(req) returns null when req.path does not match any recognized route, so you can try it first and fall through to the rest of your application.

`AgnosticResponse`

Handlers resolve to AgnosticResponse:

interface AgnosticResponse {
  status: number;
  headers: Record<string, string>;
  body: string;
}

Map status, headers, and body onto your framework’s response object, or call toFetchResponse(res) for Hono, Next.js, Bun, and Workers.

Guide

Adapters

Hono (copy-paste)

Fetch-API servers (Bun, Deno, Workers)

`handleRequest`

Default routes and `basePath`

`AgnosticResponse`

​Hono (copy-paste)

​Fetch-API servers (Bun, Deno, Workers)

​handleRequest

​Default routes and basePath

​AgnosticResponse

Hono (copy-paste)

Fetch-API servers (Bun, Deno, Workers)

`handleRequest`

Default routes and `basePath`

`AgnosticResponse`