Health check

Opt-in feature installed with kl-nest new (multiselect) or kl-nest add health.

Exposes GET /health using @nestjs/terminus. The endpoint is public (@IsPublic()) and excluded from OpenAPI (@ApiExcludeEndpoint()).

Indicators

If REDIS_CONNECTION_STRING is set but the ioredis package is not installed (Redis cache was not added), the indicator returns up with a warning instead of failing the health check.

Structure

src/host/controllers/health-check/
├── health-check.controller.ts
└── health-check.module.ts

src/infra/services/
├── database.indicator.service.ts
└── redis.indicator.service.ts

The CLI registers HealthCheckModule in AppModule.

Sample response

{
  "status": "ok",
  "info": {
    "database": { "status": "up" },
    "redis": { "status": "up" }
  },
  "error": {},
  "details": {
    "database": { "status": "up" },
    "redis": { "status": "up" }
  }
}

Related variables

Next steps

• Cache (Redis) — install ioredis for cache and real Redis ping
• Environment variables