Accueil › Spring Boot › Spring Boot Actuator
Spring Boot Actuator
Observabilitéavance
Actuator ajoute à l'application des endpoints HTTP de supervision : santé, métriques, configuration effective, journaux, etc. On l'ajoute avec spring-boot-starter-actuator.
Par défaut, un seul endpoint est exposé en HTTP : /actuator/health. Tous les autres existent mais ne répondent pas tant qu'ils ne sont pas ajoutés explicitement :
management:
endpoints:
web:
exposure:
include: health, info, metrics, prometheus, loggers
endpoint:
health:
show-details: when-authorized
Les endpoints les plus utilisés : health (l'application et ses dépendances sont-elles vivantes ?), info (métadonnées de build), metrics (compteurs et temps de réponse), env (propriétés effectives), beans (contenu du contexte Spring), loggers (niveaux de log, modifiables à chaud), mappings (routes exposées) et conditions (pourquoi telle auto-configuration s'est activée ou non).
health peut être détaillé par groupes — typiquement liveness et readiness, utilisés par Kubernetes pour savoir s'il faut redémarrer un pod (liveness) ou lui envoyer du trafic (readiness).
Les termes à connaître
- spring-boot-starter-actuator
Dépendance qui ajoute les endpoints de supervision (
/actuator/*) à l'application : santé, métriques, informations d'environnement, journalisation à chaud, etc. Rien n'est exposé en HTTP tant qu'on ne le configure pas explicitement.- management.endpoints.web.exposure.include
Propriété qui liste les endpoints exposés en HTTP. Par défaut, seul
healthest exposé : tous les autres (metrics,env,beans…) existent mais ne répondent pas tant qu'ils ne sont pas ajoutés à cette liste (ou*pour tout exposer).- management.endpoint.health.show-details
Contrôle le niveau de détail renvoyé par
/actuator/health:never(défaut, justeUP/DOWN),when-authorized(détail réservé aux rôles autorisés) oualways.- Groupes de santé (health groups)
Regroupement d'indicateurs de santé sous un sous-chemin dédié, typiquement
readinessetlivenesspour Kubernetes. Exposés sur/actuator/health/readinesset/actuator/health/liveness.- HealthIndicator
Interface à implémenter pour ajouter sa propre vérification de santé (ex. joignabilité d'une API tierce). Le nom du bean moins le suffixe
HealthIndicatordevient une clé dans la réponse de/actuator/health.- management.server.port
Fait écouter les endpoints Actuator sur un port séparé de celui de l'application, pour ne pas exposer la supervision sur le même réseau que l'API publique.
- /actuator/loggers
Endpoint qui affiche (GET) et modifie (POST) le niveau de log d'un logger à chaud, sans redémarrer l'application.
Cette page présente la partie essentielle de la leçon. Les exemples commentés, les pièges courants et les trois questions de quiz sont dans l'application.