Health Checks

gRPC Health Checking Protocol implementation with HTTP endpoints for Kubernetes liveness and readiness probes.

Quick Start

import { createServer } from '@connectum/core';
import { Healthcheck, healthcheckManager, ServingStatus } from '@connectum/healthcheck';
import routes from '#gen/routes.js';

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

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

await server.start();

Installation

pnpm add @connectum/healthcheck

Key Concepts

Concept	Description
ServingStatus	UNKNOWN (0), SERVING (1), NOT_SERVING (2), SERVICE_UNKNOWN (3)
gRPC Protocol	Health/Check, Health/Watch, Health/List on grpc.health.v1.Health
HTTP Endpoints	/healthz, /health, /readyz -- returns JSON with status and HTTP 200/503/404
healthcheckManager	Global singleton to update service status from anywhere in your app
Dependency Checks	Track downstream services (database, cache) alongside your service health

Learn More

• Protocol Details -- gRPC methods, HTTP endpoints, configuration options, dependency checks
• Kubernetes Integration -- HTTP/gRPC probes, graceful shutdown integration, shutdown timeline
• @connectum/healthcheck -- Package Guide
• @connectum/healthcheck API -- Full API Reference