TerminusModule

NestJS 🟡 Mid

Definition

Module de health checks via @nestjs/terminus. Expose un endpoint /health qui verifie la base de donnees, Redis, disque et services externes.

Analogie

Comme un bilan de sante : le medecin verifie chaque organe et donne un bulletin de sante global.

Exemple de code

@Controller('health')
export class HealthController {
  constructor(private health: HealthCheckService,
    private db: TypeOrmHealthIndicator) {}

  @Get()
  check() {
    return this.health.check([
      () => this.db.pingCheck('database'),
    ]);
  }
}

Cas d'usage

Fournir un endpoint de sante pour les load balancers et orchestrateurs comme Kubernetes.

Anti-pattern

Retourner toujours 200 sur /health sans verifier reellement l'etat des dependances.

Termes lies

#core