Spring Boot Actuator is een sub-project van Spring Boot dat monitoring- en beheerfunctionaliteiten biedt voor actieve Spring Boot applicaties. Het laat je toe om applicaties te volgen, te monitoren en data te verzamelen over verkeer, database status en meer, zonder extra code te schrijven.
Zodra een project is geconfigureerd met Spring Actuator, zijn er standaard verschillende endpoints beschikbaar voor beheer en monitoring. Indien nodig kunnen extra endpoints toegevoegd worden voor meer controle.
Actuator Configureren in Spring Boot
Om Actuator te gebruiken, voeg je simpelweg de dependency spring-boot-starter-actuator toe aan je pom.xml (Maven) of build.gradle (Gradle) bestand.
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-actuator</artifactId>
</dependency>Na het toevoegen van de dependency en het herstarten van de applicatie, is Actuator geactiveerd.
Spring Boot Actuator biedt endpoints om toegang te krijgen tot informatie over de applicatie. Deze endpoints zijn toegankelijk via HTTP.
Enkele belangrijke endpoints zijn:
- /health: Geeft informatie over de “gezondheid” van de applicatie, zoals de database connectie status. Deze endpoint vereist standaard geen authenticatie.
- /info: Toont aangepaste informatie over de applicatie, zoals versie en beschrijving.
- /metrics: Geeft “metrics” van de applicatie op het huidige moment, zoals geheugengebruik en het aantal threads.
- /loggers: Toont en laat de log configuratie van de applicatie aanpassen.
Gedetailleerde informatie over de applicatie status wordt verzameld van beans die de HealthIndicator interface implementeren en geconfigureerd zijn in de context.
De /health endpoint kan bijvoorbeeld simpele informatie retourneren zoals:
{
"status": "UP"
}Naast het gebruik van standaard endpoints, is het mogelijk om endpoints aan te passen en nieuwe endpoints te creëren. Aanpassingen kunnen het wijzigen van de id, de enabled status (activeren/deactiveren) en de sensitive status (gevoeligheid – authenticatie vereist of niet) van een endpoint omvatten.
Om een nieuw endpoint te creëren, moet je de Endpoint<T> interface implementeren en de logica voor de endpoint definiëren.
Spring Boot Actuator ondersteunt verschillende technologieën, waaronder Spring MVC en JMX. Het integreert ook met Spring Security om de toegang tot endpoints te beveiligen. Het configureren van beveiliging voor Actuator is belangrijk om ongeautoriseerde toegang tot gevoelige informatie te voorkomen.
Endpoint configuratie kan gedaan worden via properties of YAML bestanden. Om bijvoorbeeld de id van de /beans endpoint te wijzigen naar /springbeans en toegang toe te staan zonder authenticatie:
endpoints.beans.id=springbeans
endpoints.beans.sensitive=false
endpoints.beans.enabled=true