@openknot-ts/knot-health
v0.0.6-preview
Published
Health probe HTTP adapters for the OpenKnot Node and Fastify hosts, and the probe routing other hosts share.
Readme
@openknot-ts/knot-health
Serves the @openknot-ts/health probes over HTTP: as middleware for the Node host and as a plugin for the Fastify host. It owns probe routing, framing and paths; the host owns listening, the health core owns the probe semantics.
Usage
import { healthHttp } from "@openknot-ts/knot-health";
import { http } from "@openknot-ts/knot-http-node";
import { trpcHttp } from "@openknot-ts/trpc-knot-server-handler";
import { defineApplication } from "@openknot-ts/wire";
export const application = defineApplication({
modules: [applicationModule, transport, http, trpcHttp, healthHttp],
});On Fastify, use the module of the same name from /fastify:
import { fastifyHttp } from "@openknot-ts/fastify-server";
import { healthHttp } from "@openknot-ts/knot-health/fastify";
export const application = defineApplication({ modules: [applicationModule, fastifyHttp, healthHttp] });The Bun host uses @openknot-ts/knot-health-bun. Selecting the health core alone adds no endpoints.
API
| Entry | Export | Description |
| --- | --- | --- |
| @openknot-ts/knot-health | healthHttp | Ready Node module: probe middleware before the application handler. |
| | nodeHealthMiddleware({ requirements?, paths? }) | Node middleware with custom paths. |
| | healthHttpConfig | The default path configuration. |
| @openknot-ts/knot-health/fastify | healthHttp, fastifyHealthPlugin({ requirements?, paths? }) | The same for the Fastify host. |
| @openknot-ts/knot-health/probes | probeSettings, ProbePaths, ProbeOptions | Host-neutral routing, configuration and framing for other host adapters. |
Configuration
| Variable | Default | Probe |
| --- | --- | --- |
| HTTP_LIVENESS_PATH | /livez | Liveness |
| HTTP_READINESS_PATH | /readyz | Readiness |
| HTTP_HEALTH_PATH | /health | Readiness plus dependency checks |
Paths must start with / and differ; invalid or duplicate paths fail before the host listens. paths(dependencies) returns { liveness, readiness, health } from the application's own config and replaces these variables entirely.
Responses
GETandHEADanswer 200 when up, 503 when down, withCache-Control: no-storeand the body{ "status": "up" | "down" }(none forHEAD). Query strings do not affect matching.- Other paths and methods pass to the application unchanged.
- A closed request aborts the dependency checks' signal.
- Readiness is down during startup and from the moment the application starts stopping; a failing dependency affects only
/health.
Tests
test/probes.test.ts covers lifecycle phases, dependency failures, HEAD, cancellation and paths; test/config.test.ts custom paths; test/fastify.test.ts the Fastify plugin. Both main examples select the Node adapter.
