Aller au contenu
Réussir mon BTS SIO

Tape une notion, une commande ou le nom d'une épreuve.

Par exemple

Exercice 6 / 8Moyen

Endpoint healthcheck

À toi

Construis 2 endpoints healthcheck :

  • GET /health/live (liveness) → toujours 200 { status: "alive" }. Pas de check externe — juste "je tourne".
  • GET /health/ready (readiness) → utilise une fonction checkBdd() injectée :
    • Si elle résout → 200 { status: "ready", checks: { bdd: "ok" } }
    • Si elle reject (ou throw) → 503 { status: "not_ready", checks: { bdd: "down" } }

Le code initial expose app.locals.checkBdd que tu utilises dans le handler — ça permet aux tests de stubber.

Healthcheck : exposer la santé de ton API

Toute API en prod a besoin d'endpoints de healthcheck pour que :

  • Un load balancer sache quelle instance peut recevoir du trafic
  • Un orchestrateur (Kubernetes, Docker Swarm) sache quoi redémarrer
  • Un monitoring (Datadog, UptimeRobot) sache si l'app est down
  • Un CI/CD vérifie qu'un déploiement est OK avant de promouvoir

Les 2 niveaux : liveness vs readiness

EndpointQuestionAction si KO
/health/live"Est-ce que ce process est encore vivant ?"Redémarrer le process
/health/ready"Est-ce que ce process peut servir du trafic ?"Retirer du load balancer

Liveness — minimaliste

javascript
app.get("/health/live", (req, res) => {
  res.json({ etat: "up", uptime: Math.round(process.uptime()) });
});

Pas de check BDD, pas de check externe. Juste : "le process Express tourne, répond aux requêtes". Si ça échoue, le process est gelé/crashé → redémarrer.

Readiness — vérifie les dépendances

javascript
app.get("/health/ready", async (req, res) => {
  try {
    await checkCache(); // throw si le cache ne répond pas
    res.json({ etat: "pret", checks: { cache: "ok" } });
  } catch {
    res.status(503).json({ etat: "indisponible", checks: { cache: "ko" } });
  }
});

Si une dépendance (BDD, cache…) est down, l'instance n'est pas prête à servir du trafic. Le LB la retire de la rotation. Le process reste vivant (pas de redémarrage), il attend que la dépendance revienne.

Pourquoi distinguer ?

Si tu mets le check BDD dans /health/live :

  • BDD tombe → liveness échoue → orchestrator redémarre le pod → BDD toujours down → liveness échoue → redémarre encore → CRASHLOOP

Avec readiness :

  • BDD tombe → readiness échoue → pod sort du LB (mais reste vivant)
  • BDD revient → readiness OK → pod réintègre le LB

Format de réponse

Pas de standard formel mais un format stable et lisible :

json
{
  "status": "ready",
  "checks": {
    "bdd": "ok",
    "redis": "ok",
    "queue": "ok"
  },
  "uptime": 1234,
  "version": "1.2.3"
}

Tu peux exposer plus sur un endpoint admin (/health/detailed) protégé, mais le /health/ready doit rester simple et rapide.

Statut HTTP

  • 200 : ready / alive
  • 503 Service Unavailable : not ready (le bon code pour "je suis là mais incapable de servir")

⚠️ Pas 500 — 500 indique un bug, alors que 503 indique un état temporaire (BDD down).

Authentification ?

Les endpoints health sont publics par convention. Le LB / orchestrator doit pouvoir les pinger sans token. Mais ne leak rien (pas de version exposée, pas de stack traces, pas d'IP internes).

En prod : terminus

javascript
const { createTerminus } = require("@godaddy/terminus");
createTerminus(server, {
  healthChecks: {
    "/health/live": () => Promise.resolve(),
    "/health/ready": async () => { await checkBdd(); },
  },
  signal: "SIGINT",
  onSignal: async () => { /* graceful shutdown */ },
});

Bonus : gère le graceful shutdown (attendre les requêtes en cours avant de tuer le process).

Ton code

Connecte-toi pour faire cet exercice

C'est gratuit, avec ton compte Google : un clic, et tu reviens ici. Ta progression te suit ensuite sur tous tes appareils.

Le site garde ton nom et ton email, rien d'autre. Tes données