Zum Hauptinhalt springen
Version: 2024.2.x

Actuator REST-Endpoints

Für Monitoring- und Diagnose-Zwecke stehen unter /actuator eine Reihe von REST-Endpoints zur Verfügung.

Mit Ausnahme des /actuator/health-Endpoints sind diese grundsätzlich nur für angemeldete DMC-Administratoren zugänglich.

health

Der Health-Endpoint unter /actuator/health kann im Kubernetes- bzw. Container-Deployment verwendet werden, um den Gesundheitszustand der Applikation zu prüfen.

https://docs.spring.io/spring-boot/api/rest/actuator/health.html

metrics

Der Metrics-Endpoint unter /actuator/metrics gibt Zugriff auf eine Reihe von Anwendungsmetriken.

Er ist aus Sicherheitsgründen nur für angemeldete DMC-Administratoren zugänglich.

https://docs.spring.io/spring-boot/api/rest/actuator/metrics.html

env

Der Environment-Endpoint unter /actuator/env gibt zu Analysezwecken die vollständigen Konfigurationsparameter der DMC inklusive aller Umgebungsvariablen auf Betriebssystem-Ebene aus.

Er ist aus Sicherheitsgründen nur für angemeldete DMC-Administratoren zugänglich.

Zusätzlich sind Passwörter in der DMC-Konfiguration maskiert - dies gilt jedoch nicht zwangsläufig für die Inhalte potenziell sensibler Umgebungsvariablen!

Der Endpoint ist zwar standardmäßig aktiv, kann jedoch bei Bedarf mit der Variable DMC_ENABLE_ACTUATOR_ENV=false deaktiviert werden.

https://docs.spring.io/spring-boot/api/rest/actuator/env.html

loggers

Der Loggers-Endpoint unter /actuator/loggers gibt Informationen über die aktuellen Log-Einstellungen der DMC zurück. Zusätzlich erlaubt er es auch, den Log-Level gezielt im laufenden Betrieb zu ändern, so dass unnötige Neustarts vermieden werden können.

Er ist aus Sicherheitsgründen nur für angemeldete DMC-Administratoren zugänglich.

https://docs.spring.io/spring-boot/api/rest/actuator/loggers.html

log

Der Log-Endpoint unter /actuator/log gibt zu Analysezwecken den Inhalt der DMC-Logdatei zurück.

Er ist aus Sicherheitsgründen nur für angemeldete DMC-Administratoren zugänglich.

Falls die DMC keine Logdatei verwendet, wird stattdessen ein In-Memory-Puffer verwendet, der immer die letzten Log-Nachrichten speichert. Die Größe des Puffers kann über die Variable DMC_LOG_BUFFER_SIZE gesteuert werden.

Der Endpoint ist zwar standardmäßig aktiv, kann jedoch bei Bedarf mit der Variable DMC_ENABLE_ACTUATOR_LOG=false deaktiviert werden.