Skip to content
GuidesDocs 1.3.x

Health Checks

@connectum/healthcheck implements the gRPC Health Checking Protocol and can expose HTTP endpoints for platform probes. The application owns status transitions; the protocol only reports them.

typescript
const server = createServer({
  services: [routes],
  protocols: [Healthcheck({ httpEnabled: true })],
});

server.on('ready', () => {
  healthcheckManager.update(ServingStatus.SERVING);
});

Choose the owning guide

NeedCanonical destination
Configure protocol options, HTTP paths, status semantics, components, or dependency stateHealth protocol
Configure Kubernetes HTTP/gRPC probes and termination timingKubernetes integration
Coordinate drain hooks and the global shutdown deadlineGraceful shutdown
Find an exact manager or protocol symbol@connectum/healthcheck API

Readiness means the process can accept useful work; liveness means it should not be restarted. During shutdown, mark the service not serving before draining traffic. Worker-only processes with services: [] should register an application component in the manager so /healthz has an explicit readiness source; the protocol guide owns that pattern.

Use the @connectum/healthcheck module hub for installation and navigation.