Cours Spring Boot Actuator & Healthchecks

Pour DevOps / CI-CD

Objectifs pédagogiques

À la fin de ce cours, vous serez capables de :

• Comprendre ce qu’est Spring Boot Actuator
• Comprendre l’utilité de l’URL : /actuator/health
• Expliquer ce qu’est un Healthcheck
• Mettre en place un healthcheck dans un pipeline GitLab CI
• Comprendre son utilisation dans Docker, Kubernetes et la supervision DevOps

Qu’est-ce que Spring Boot Actuator ?

Spring Boot Actuator est un module officiel qui expose automatiquement des endpoints techniques pour superviser votre application :

• État général (/actuator/health)
• Informations (/actuator/info)
• Métadonnées techniques
• Logs
• Beans
• Environnement
• Métriques

Vous n’avez aucun contrôleur Java à écrire : tout est généré automatiquement par Spring Boot.

Actuator = le tableau de bord de votre application.

Activer Actuator dans Spring Boot

Ajouter la dépendance dans pom.xml :

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-actuator</artifactId>
</dependency>

puis management.endpoints.web.exposure.include=health dans votre fichier application.properties ou application.yaml

L’endpoint /actuator/health

Une fois Actuator activé, Spring Boot crée automatiquement un GET /actuator/health

Exemple si tout va bien (réponse retournée en JSON):

{ "status": "UP" }

Exemple si un problème est détecté

{ "status": "DOWN" }

Aucun code Java n’est nécessaire : Spring Boot gère tout.

Pourquoi un Healthcheck ?

Un healthcheck sert à vérifier que votre application fonctionne réellement après un déploiement:

• Le serveur démarre correctement
• Le port 8080 ou autre répond !
• Les beans Spring sont chargés
• Le contexte ne génère pas d’erreur

Bonnes pratiques DevOps

Après un déploiement automatisé, un pipeline CI/CD doit :

• lancer l’application
• attendre son démarrage
• vérifier /actuator/health
• échouer si l’application n’est pas UP

Healthcheck dans un pipeline GitLab CI

Exemple de job deploy :

deploy:
  stage: deploy
  image: eclipse-temurin:17-jdk-alpine
  script: |
    java -jar target/app.jar &
    sleep 12
    apk add --no-cache curl
    
    if curl -f http://localhost:8080/actuator/health; then
      echo "Healthcheck OK"
    else
      echo "Healthcheck KO"
      exit 1
    fi
  when: manual

Explication :

• java -jar … & : lance l’app en arrière-plan
• sleep 12 : attend que Spring Boot démarre
• curl -f : échoue si l’URL ne renvoie pas un code 2xx/3xx
• exit 1 : le job CI passe en rouge = déploiement KO

Healthcheck dans un Dockerfile

Vous pouvez ajouter le healthcheck dans l’image :

HEALTHCHECK CMD curl -f http://localhost:8080/actuator/health || exit 1

Docker pourra alors dire :

• healthy (en bonne santé)
• unhealthy (en mauvaise santé ;)

Healthcheck dans Kubernetes (bonus)

Dans un pod Kubernetes :

livenessProbe:
  httpGet:
    path: /actuator/health
    port: 8080
  initialDelaySeconds: 10
  periodSeconds: 5

Kubernetes relance automatiquement le conteneur si :

• /actuator/health renvoie autre chose que UP
• ou ne répond pas

Exercices pratiques

Exercice 1 — Activer Actuator

• Ajouter la dépendance Actuator
• Activer l’exposition du health
• Démarrer l’application et tester l’URL

Attendu : { "status": "UP" }

Exercice 2 — Pipeline CI avec healthcheck

Créer un job :

• lancer le JAR
• attendre son démarrage
• tester /actuator/health

Attendu : le job échoue si l’app ne démarre pas correctement.

Exercice 3 — Simuler une panne

• Modifier le port dans votre fichier application.properties :

server.port=9999

• Lancer le pipeline

Attendu : healthcheck KO : job en rouge normalement

Correction :

deploy:
  stage: deploy
  image: eclipse-temurin:17-jdk-alpine
  script: |
    java -jar target/app.jar &
    sleep 12
    apk add --no-cache curl
    if curl -f http://localhost:8080/actuator/health; then
      echo "Healthcheck OK"
    else
      echo "Healthcheck KO"
      exit 1
    fi
  when: manual

Conclusion

Pas compliqué à mettre en place mais important de le faire !

Concept	Définition
Actuator	Module Spring Boot qui expose des endpoints techniques
/actuator/health	Indique la santé de l’application
Healthcheck	Test automatisé pour valider le bon fonctionnement de l’application
CI/CD	Utilise le healthcheck pour valider le déploiement
curl -f	Échoue si la réponse HTTP n’est pas correcte