Monitorando o Spring Boot

Os sistemas operacionais compatíveis com Spring Boot o sensor estão de acordo com os requisitos dos agentes de host, que podem ser verificados na seção “Sistemas operacionais compatíveis” de cada agente de host, como Sistemas operacionais compatíveis Linux.

A tabela a seguir mostra a versão mais recente compatível e a política de suporte:

Para obter mais informações sobre a política de suporte, consulte a estratégia de suporte para sensores.

Nessa tecnologia, o ` Instana ` oferece suporte ao rastreamento. Para obter mais informações, consulte Estruturas e bibliotecas instrumentadas.

Para configurar um atuador d Spring Boot, adicione a seguinte dependência no pom.xml arquivo:

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

O Actuator do Spring Boot gera e expõe pontos de extremidade operacionais de uma aplicação do Spring Boot em execução.

Para o Spring Boot, 2.2.x e versões posteriores, habilite o JMX definindo a seguinte propriedade no application.properties arquivo:

spring.jmx.enabled=true
 

Ao ativar o recurso " JMX ", os dados e recursos da sua aplicação Spring Boot são expostos como beans gerenciados (MBeans).

Se os pontos finais estiverem desativados no application.properties arquivo com as seguintes configurações, será necessário expor os MBeans de gerenciamento do Spring Boot, pois o sensor depende desses MBeans para coletar métricas da aplicação Spring Boot :

management.endpoints.enabled-by-default=false
 

Para expor os MBeans, habilite os seguintes pontos de extremidade no application.properties arquivo:

management.endpoint.info.enabled=true
management.endpoint.health.enabled=true
management.endpoint.metrics.enabled=true
management.endpoint.env.enabled=true
 

Instana consulta métricas do MBean de gerenciamento do Spring Bootorg.springframework.boot:type=Endpoint,name=Metrics. Não é necessário configurar a autenticação ou as credenciais para pontos de extremidade de atuadores protegidos.

Para o ` Spring Boot ` e ` 3.x `, certifique-se de que a seguinte diretiva esteja presente no application.properties arquivo:

management.endpoints.jmx.exposure.include=env,health,info,metrics
 

Para o Spring Boot e 2 e versões posteriores, o Spring Boot Actuator oferece gerenciamento de dependências e configuração automática para o Micrometer. Dependendo da versão do Spring Boot, diferentes métricas do Micrometer estão disponíveis no painel do JVM.

Para excluir pontos de extremidade específicos de HTTP, use a seguinte diretiva:

management.endpoints.web.exposure.exclude=health,info
 

Para excluir todos os pontos finais de HTTP, use a seguinte diretiva:

management.endpoints.web.exposure.exclude=*
 

Antes que as propriedades de configuração do aplicativo possam ser exibidas na interface do usuário do Instana, é necessário fazer mais alterações no application.properties arquivo. Caso contrário, essas propriedades serão mostradas como ****** por causa de valores sensíveis Para obter mais informações, consulte Sanitizar valores confidenciais.

Para sempre mostrar os valores como texto não criptografado, use a seguinte configuração no arquivo application.properties :

management.endpoint.env.show-values=ALWAYS
 

Instana extrai o nome das instâncias de ` Spring Boot ` das seguintes fontes:

• spring.application.name propriedade: Se essa propriedade estiver definida na configuração do seu aplicativo, seu valor será usado como nome do aplicativo. No Spring Boot 3, para especificar o nome do aplicativo Spring Boot, defina a spring.application.name propriedade no application.properties arquivo da seguinte forma:

  spring.application.name=<Your_Application_Name>
   

• build-info.properties arquivo: Se não spring.application.name estiver definido, o ` Instana ` recupera o nome do aplicativo ` Spring Boot ` a partir do build-info.properties arquivo. Este arquivo pode ser gerado, por exemplo, com spring-boot-maven-plugin:

  <plugin>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-maven-plugin</artifactId>
    <configuration>
      <executable>true</executable>
    </configuration>
    <executions>
      <execution>
        <goals>
          <goal>build-info</goal>
        </goals>
        <configuration>
          <additionalProperties>
            <name>${project.artifactId}</name>
            <version>${project.version}</version>
          </additionalProperties>
        </configuration>
      </execution>
    </executions>
  </plugin>
   

  Para obter mais informações sobre a integração com o Actuator, consulte a documentação do plugin Spring Boot Maven.

Por padrão, a Instana verifica o funcionamento do app Spring Boot a cada 10 minutos consultando o MBean de gerenciamento org.springframework.boot:type=Endpoint,name=Health.

Para configurar o parâmetro health-interval desejado, defina o valor em segundos:

com.instana.plugin.springboot:
  health-interval: 30
 

Você pode definir a frequência com que o Instana consulta o Spring Boot para coletar dados e métricas usando o poll_rate parâmetro no arquivo configuration.yaml do agente, conforme mostrado no exemplo a seguir:

com.instana.plugin.springboot:
  poll_rate: 1 # values are in seconds. Default value is 1 second.

Instana Spring Boot O sensor coleta as seguintes métricas dos terminais e das sessões do HTTP :

Instana Spring Boot O sensor coleta os seguintes dados de monitoramento das fontes de dados:

Para cada sensor, uma base de conhecimento curada de assinaturas de funcionamento é avaliada continuamente com relação às métricas recebidas e é usada para levantar problemas ou incidentes que dependem do impacto do usuário.

Os eventos integrados acionam problemas ou incidentes com base em assinaturas de integridade com falha nas entidades, enquanto os eventos personalizados acionam problemas ou incidentes com base nos limites de uma métrica específica de qualquer entidade selecionada.

Para obter mais informações sobre eventos construídos para o sensor Spring Boot , consulte a Referência de eventos integrados.

Tipo de problema de monitoramento: springboot_actuator_not_configured

Para configurar o Spring Boot Actuator, consulte Configurando o Spring Boot Actuator.

Tipo de problema de monitoramento: springboot_jmx_not_enabled

Para ativar o “ JMX ”, consulte “Ativar o ‘ Java Management Extensions ’” ( JMX ).