Share via

Verwalten und Überwachen einer App mit dem Spring Boot-Aktor

  • Artikel

Hinweis

Azure Spring Apps ist der neue Name für den Azure Spring Cloud-Dienst. Obwohl der Dienst umbenannt wurde, wird der alte Name noch an einigen Stellen verwendet, solange wir Ressourcen wie Screenshots, Videos und Diagramme aktualisieren.

Dieser Artikel gilt für: ✔️ Java ❌ C#

Dieser Artikel gilt für: ✔️ Basic/Standard ✔️ Enterprise

Spring Boot Actuator bringt produktionsreife Funktionen für Ihre Anwendungen. Mit diesem Tool können Sie Ihre Anwendung mühelos überwachen, Metriken sammeln und den Status oder die Datenbankaktivität verstehen. Sie erhalten Zugang zu professionellen Werkzeugen, ohne dass Sie diese von Grund auf neu erstellen müssen.

Der Aktuator gibt wichtige Betriebsdaten über Ihre laufende Anwendung preis, z. B. Zustandsdaten, Metriken, Informationen und mehr. Der Aktuator verwendet HTTP-Endpunkte oder Java Management Extensions (JMX), was eine einfache Interaktion mit ihm ermöglicht. Nach der Integration bietet es mehrere Standardendpunkte, und wie andere Spring-Module ist es leicht konfigurierbar und erweiterbar.

Azure Spring Apps verwendet den Aktor zur Anreicherung von Metriken über JMX. Es kann auch mit Application Live View im Enterprisetarif zusammenarbeiten, um Ihnen zu helfen, die Daten von Anwendungen zu erhalten und mit ihnen zu interagieren.

Diagramm, das den Datenfluss mit dem Spring Boot-Aktuator zeigt.

Spring Boot-Aktuator konfigurieren

In den folgenden Abschnitten wird beschrieben, wie der Aktuator konfiguriert wird.

Hinzufügen der Aktorabhängigkeit

Fügen Sie die folgende Abhängigkeit hinzu, um den Aktor zu einem auf Maven basierenden Projekt hinzuzufügen:

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

Diese Konfiguration funktioniert mit jeder Spring Boot-Version, da die Versionen in der Spring Boot-Stückliste (Bill of Materials, BOM) enthalten sind.

Konfigurieren des Aktuatorendpunkts

Standardmäßig macht eine Spring Boot-Anwendung nur den Endpunkt health verfügbar. Um die Konfiguration und die konfigurierbare Umgebung zu beobachten, führen Sie die folgenden Schritte aus, um auch die Endpunkte env und configprops zu aktivieren:

  1. Öffnen Sie den Bereich Übersicht der App, wählen Sie im Einstellungsmenü die Option Konfiguration aus, und öffnen Sie dann die Konfigurationsseite Umgebungsvariablen.

  2. Fügen Sie die folgenden Eigenschaften im Format „key:value“ hinzu. Diese Umgebung öffnet die folgenden Spring-Aktor-Endpunkte: health, env und configprops.

    management.endpoints.web.exposure.include: health,env,configprops

  3. Wählen Sie Speichern. Ihre Anwendung startet automatisch neu und lädt die neuen Umgebungsvariablen.

Sie können nun zur App-Übersicht zurückkehren und warten, bis der Bereitstellungsstatus in Erfolgreichändert geändert wird.

Um alle eingebauten Endpunkte und die zugehörigen Konfigurationen zu sehen, siehe den Abschnitt Endpunkte freigeben in Features von Spring Boot, die Bereit für die Produktion sind.

Endpunkt für sichere Aktuatoren

Wenn Sie die App für die Öffentlichkeit öffnen, werden diese Endpunkte des Aktuators ebenfalls der Öffentlichkeit zugänglich gemacht. Es wird empfohlen, alle Endpunkte durch Festlegen von management.endpoints.web.exposure.exclude=*auszublenden, da die Eigenschaft exclude Vorrang vor der Eigenschaft include hat. Diese Aktion blockiert die Anwendungsliveansicht im Enterprise-Plan und andere Apps oder Tools, die auf den HTTP-Endpunkt des Aktors angewiesen sind.

Im Enterprise-Plan gibt es zwei Möglichkeiten, den Zugriff zu schützen:

  • Sie können den öffentlichen Endpunkt von Apps deaktivieren und eine Routingregel in VMware Spring Cloud Gateway konfigurieren, um den Aktorzugriff von einem öffentlichen Standort aus zu deaktivieren. Weitere Informationen finden Sie unter VMware Spring Cloud-Gateway konfigurieren.

  • Sie können den Aktor so konfigurieren, dass er an einem anderen HTTP-Port auf der Hauptanwendung lauscht. In einer eigenständigen Anwendung ist der HTTP-Port des Aktors standardmäßig identisch mit dem HTTP-Hauptport. Damit die Anwendung an einem anderen Port lauscht, legen Sie die Eigenschaft management.server.port fest. Die Anwendungsliveansicht kann diese Portänderung nicht automatisch erkennen. Daher müssen Sie die Eigenschaft auch für eine Azure Spring Apps-Bereitstellung konfigurieren. Dann ist der Aktor nicht öffentlich zugänglich, aber die Anwendungsliveansicht kann über einen anderen Port vom Aktorendpunkt lesen. Weitere Informationen finden Sie unter Verwenden der Application Live View mit dem Azure Spring Apps Enterprise-Plan.

Nächste Schritte