Delen via

App beheren en bewaken met Spring Boot Actuator

  • Artikel

Notitie

Azure Spring Apps is de nieuwe naam voor de Azure Spring Cloud-service. Hoewel de service een nieuwe naam heeft, ziet u de oude naam op sommige plaatsen terwijl we werken aan het bijwerken van assets, zoals schermopnamen, video's en diagrammen.

Dit artikel is van toepassing op: ✔️ Java ❌ C#

Dit artikel is van toepassing op: ✔️ Basic/Standard ✔️ Enterprise

Spring Boot Actuator biedt productieklare functies voor uw apps. U kunt uw app moeiteloos bewaken, metrische gegevens verzamelen en de status of databaseactiviteit begrijpen met dit hulpprogramma. U krijgt toegang tot professionele hulpprogramma's zonder dat u ze helemaal zelf hoeft te bouwen.

De actuator toont essentiële operationele gegevens over uw actieve toepassing, zoals status, metrische gegevens, informatie en meer. De actuator maakt gebruik van HTTP-eindpunten of Java Management Extensions (JMX), waardoor u eenvoudig kunt communiceren. Nadat u deze hebt geïntegreerd, biedt het verschillende standaardeindpunten en net als andere Spring-modules, is het eenvoudig te configureren en uit te breiden.

Azure Spring Apps maakt gebruik van de actuator voor het verrijken van metrische gegevens via JMX. Het kan ook werken met Application Live View in het Enterprise-abonnement om u te helpen de gegevens uit apps op te halen en ermee te werken.

Diagram met de gegevensstroom met Spring Boot Actuator.

Spring Boot-aandrijving configureren

In de volgende secties wordt beschreven hoe u de actuator configureert.

Afhankelijkheid van actuator toevoegen

Als u de actuator wilt toevoegen aan een op Maven gebaseerd project, voegt u de volgende afhankelijkheid toe:

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

Deze configuratie werkt met elke Spring Boot-versie omdat versies worden gedekt in de Spring Boot Bill of Materials (BOM).

Eindpunt voor actuator configureren

In een Spring Boot-toepassing wordt standaard alleen het health eindpunt weergegeven. Als u de configuratie en configureerbare omgeving wilt bekijken, gebruikt u de volgende stappen om de env en configprops eindpunten in te schakelen:

  1. Ga naar het deelvenster Overzicht van de app, selecteer Configuratie in het instellingsmenu en ga vervolgens naar de configuratiepagina omgevingsvariabelen.

  2. Voeg de volgende eigenschappen toe, zoals in het formulier sleutel:waarde. Deze omgeving opent de volgende Spring Actuator-eindpunten: health, enven configprops.

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

  3. Selecteer Opslaan. De toepassing wordt automatisch opnieuw opgestart en de nieuwe omgevingsvariabelen worden geladen.

U kunt nu teruggaan naar het deelvenster Overzicht van de app en wachten totdat de inrichtingsstatus is gewijzigd in Geslaagd.

Als u alle ingebouwde en gerelateerde configuraties van alle eindpunten wilt bekijken, raadpleegt u de sectie Exposing Endpoints van spring Boot Production-gereede functies.

Eindpunt van beveiligde actuator

Wanneer u de app voor het publiek opent, zijn deze actuatoreindpunten ook zichtbaar voor het publiek. U wordt aangeraden alle eindpunten te verbergen door deze in te stellen management.endpoints.web.exposure.exclude=*, omdat de exclude eigenschap voorrang heeft op de include eigenschap. Deze actie blokkeert Application Live View in het Enterprise-plan en andere apps of hulpprogramma's die afhankelijk zijn van het HTTP-eindpunt van de actuator.

In het Enterprise-abonnement zijn er twee manieren om de toegang te beveiligen:

  • U kunt het openbare eindpunt van apps uitschakelen en een routeringsregel configureren in VMware Spring Cloud Gateway om actuatortoegang van het publiek uit te schakelen. Zie VMware Spring Cloud Gateway configureren voor meer informatie.

  • U kunt de actuator configureren om te luisteren op een andere HTTP-poort vanuit de hoofdtoepassing. In een zelfstandige toepassing wordt de HTTP-poort van de actuator standaard ingesteld op hetzelfde als de hoofd-HTTP-poort. Stel de management.server.port eigenschap in om de toepassing op een andere poort te laten luisteren. De liveweergave van de toepassing kan deze poortwijziging niet automatisch detecteren, dus u moet de eigenschap ook configureren in een Azure Spring Apps-implementatie. Vervolgens is de actuator niet openbaar toegankelijk, maar de Application Live View kan lezen van het eindpunt van de actuator via een andere poort. Zie Application Live View gebruiken met het Azure Spring Apps Enterprise-abonnement voor meer informatie.

Volgende stappen