Gerenciar e monitorar o aplicativo com o Spring Boot Actuator

  • Artigo

Observação

Azure Spring Apps é o novo nome do serviço Azure Spring Cloud. Embora o serviço tenha um novo nome, você verá o nome antigo em alguns locais por um tempo enquanto trabalhamos para atualizar ativos como capturas de tela, vídeos e diagramas.

Este artigo aplica-se a: ✔️ Java ❌ C#

Este artigo se aplica ao: ✔️ nível Básico/Standard ✔️ nível Enterprise

Spring Boot Actuator traz recursos prontos para produção para seus aplicativos. Você pode monitorar seu aplicativo sem esforço, coletar métricas e entender o status ou a atividade do banco de dados com essa ferramenta. Você obtém acesso a ferramentas de nível profissional sem precisar construí-las do zero.

O atuador expõe dados operacionais vitais sobre o aplicativo em execução, como status de integridade, métricas, informações e muito mais. O atuador usa terminais HTTP ou Java Management Extensions (JMX), facilitando a interação. Depois de integrá-lo, ele fornece vários pontos de extremidade padrão e, como outros módulos Spring, é facilmente configurável e extensível.

O Aplicativos Spring do Azure usa o atuador para enriquecer métricas por meio do JMX. Ele também pode funcionar com o Application Live View no plano Enterprise para ajudá-lo a obter e interagir com os dados dos aplicativos.

Diagrama que mostra o fluxo de dados usando Spring Boot Actuator.

Configurar o atuador Spring Boot

As seções a seguir descrevem como configurar o atuador.

Adicionar dependência de atuador

Para adicionar o atuador a um projeto baseado em Maven, adicione a seguinte dependência:

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

Essa configuração funciona com qualquer versão do Spring Boot porque as versões são abordadas na lista de materiais (BOM) do Spring Boot.

Configurar o ponto de extremidade do atuador

Por padrão, um aplicativo Spring Boot expõe apenas o ponto de extremidade health. Para observar a configuração e o ambiente configurável, use as etapas a seguir para habilitar também os terminais env e configprops:

  1. Vá para o painel Visão geral do aplicativo, selecione Configuração no menu de configuração e, em seguida, vá para a página de configuração Variáveis ​​de ambiente.

  2. Adicione as propriedades seguintes como as do formato “key:value”. Esse ambiente abre os seguintes pontos de extremidade do Spring Actuator: health, env, e configprops.

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

  3. Selecione Salvar. Seu aplicativo é reiniciado automaticamente e carrega as novas variáveis de ambiente.

Agora você pode voltar para o painel Visão geral do aplicativo e esperar até que o status de provisionamento mude para Bem-sucedido.

Para visualizar todos os pontos de extremidade integrados e configurações relacionadas, veja a seção Expondo Pontos de extremidade de Recursos prontos para produção do Spring Boot.

Ponto de extremidade do atuador seguro

Quando você abre o aplicativo ao público, esses pontos finais do atuador também são expostos ao público. Recomendamos que você oculte todos os pontos de extremidade definindo management.endpoints.web.exposure.exclude=*, porque a propriedade exclude tem precedência sobre a propriedade include. Esteja ciente de que esta ação bloqueia o Application Live View no plano Enterprise e outros aplicativos ou ferramentas que dependem do ponto de extremidade HTTP do atuador.

No plano Enterprise, você pode desabilitar o ponto de extremidade público de aplicativos e configurar uma regra de roteamento no VMware Spring Cloud Gateway para desabilitar o acesso público ao atuador. Para obter mais informações, veja Configurar o VMware Spring Cloud Gateway.

Próximas etapas