Surveillance de Spring Boot

Les systèmes d'exploitation pris en charge par le capteur « Spring Boot » correspondent aux exigences des agents hôtes, qui peuvent être consultées dans la section « Syst èmes d'exploitation pris en charge » de chaque agent hôte, par exemple à l'adresse Linux.

Le tableau suivant présente la dernière version prise en charge et la politique d'assistance :

Pour plus d'informations sur la politique d'assistance, consultez la section « Stratégie d'assistance pour les capteurs ».

Pour cette technologie, Instana prend en charge le suivi. Pour plus d'informations, consultez la section « Frameworks et bibliothèques instrumentés ».

Pour configurer l'actionneur Spring Boot, ajoutez la dépendance suivante dans le pom.xml fichier :

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

L'Actuator d' Spring Boot génère et expose les points de terminaison opérationnels d'une application Spring Boot en cours d'exécution.

Pour les versions d' Spring Boot2.2.x et ultérieures, activez l' JMX en définissant la propriété suivante dans le application.properties fichier :

spring.jmx.enabled=true
 

L'activation de l' JMX permet d'exposer les données et les ressources de votre application Spring Boot sous forme de beans gérés (MBeans).

Si les points de terminaison sont désactivés dans le application.properties fichier avec les paramètres de configuration suivants, vous devez alors rendre accessibles les MBeans de gestion d' Spring Boot, car le capteur dépend de ces MBeans pour collecter les métriques de l'application Spring Boot :

management.endpoints.enabled-by-default=false
 

Pour exposer les MBeans, activez les points de terminaison suivants dans le application.properties fichier :

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

Instana interroge les métriques du MBean de gestion « Spring Bootorg.springframework.boot:type=Endpoint,name=Metrics ». Il n'est pas nécessaire de configurer l'authentification ni les identifiants pour les points de terminaison sécurisés des actionneurs.

Pour Spring Boot 3.x, assurez-vous que la directive suivante figure dans le application.properties fichier :

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

Pour l' Spring Boot ion 2 et les versions ultérieures, l' Spring Boot Actuator assure la gestion des dépendances et la configuration automatique de l' Micrometer. Selon la version d' Spring Boot, différents indicateurs Micrometer sont disponibles sur le tableau de bord JVM.

Pour exclure certains points de terminaison de l' HTTP, utilisez la directive suivante :

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

Pour exclure tous les points de terminaison d' HTTP, utilisez la directive suivante :

management.endpoints.web.exposure.exclude=*
 

Avant que les propriétés de configuration de l'application puissent s'afficher dans l'interface utilisateur d' Instana, vous devez apporter d'autres modifications au application.properties fichier. Sinon, ces propriétés sont affichées sous la forme ****** en raison de valeurs sensibles. Pour plus d'informations, consultez la section « Sanitiser les valeurs sensibles ».

Pour toujours afficher les valeurs sous forme de texte en clair, utilisez la configuration suivante dans le fichier application.properties :

management.endpoint.env.show-values=ALWAYS
 

Instana extrait le nom des instances de l' Spring Boot e à partir des sources suivantes :

• spring.application.name propriété : si cette propriété est définie dans la configuration de votre application, sa valeur est utilisée comme nom de l'application. Sous Spring Boot e 3, pour spécifier le nom de l'application Spring Boot, définissez la spring.application.name propriété dans le application.properties fichier comme suit :

  spring.application.name=<Your_Application_Name>
   

• build-info.properties fichier : si spring.application.name n'est pas défini, Instana récupère le nom de l'application Spring Boot à partir du build-info.properties fichier. Ce fichier peut être généré, par exemple, à l'aide de 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>
   

  Pour plus d'informations sur l'intégration avec Actuator, consultez la documentation du plugin Spring BootMaven.

Par défaut, Instana vérifie l'état de l'application Spring Boot toutes les 10 minutes en interrogeant le MBean de gestion org.springframework.boot:type=Endpoint,name=Health.

Pour configurer le paramètre health-interval souhaité, définissez la valeur en secondes :

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

Vous pouvez configurer la fréquence à laquelle l' Instana interroge Spring Boot pour collecter des données et des métriques en utilisant le poll_rate paramètre dans le fichier de configuration.yaml l'agent, comme le montre l'exemple suivant :

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

Instana Spring Boot Le capteur recueille les métriques suivantes à partir des terminaux et des sessions d' HTTP :

Instana Spring Boot Le capteur recueille les données de surveillance suivantes à partir des sources de données :

Pour chaque détecteur, une base de connaissances organisée des signatures de santé est évaluée en continu par rapport aux métriques entrantes et est utilisée pour signaler des problèmes ou des incidents qui dépendent de l'impact de l'utilisateur.

Les événements intégrés déclenchent des problèmes ou des incidents en fonction de signatures d'état de santé défaillantes sur des entités, tandis que les événements personnalisés déclenchent des problèmes ou des incidents en fonction des seuils d'une métrique spécifique de n'importe quelle entité sélectionnée.

Pour plus d'informations sur les événements générés pour le détecteur Spring Boot , voir la référence des événements intégrés.

Type de problème de surveillance : springboot_actuator_not_configured

Pour configurer l'actionneur Spring Boot , voir Configuration de l'actionneur Spring Boot.

Type de problème de surveillance : springboot_jmx_not_enabled

Pour activer l' JMX, consultez la section « Configuration de l' Spring Boot Actuator ».