Comment fermer l'actionneur dans SpringBoot

SpringBoot ferme l'actionneur

management:
  endpoint:
    health:
      show-details: ALWAYS
  endpoints:
    enabled-by-default: false #关闭监控
    web:
      exposure:
        include: '*'

Les connaissances de l'actionneur SpringBoot peignent

L'actionneur de Spring Boot. Il fournit de nombreuses fonctionnalités de niveau production, telles que la surveillance et la mesure des applications Spring Boot. Ces fonctionnalités d'Actuator sont disponibles via de nombreux points de terminaison REST, des shells distants et JMX.

【Environnement d'utilisation】

【1】SpringBoot version 2.5.0, JDK11

【2】Port de service 9999

Ajouter des dépendances

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

Démarrez le projet et accédez au point de terminaison /actuator La version SpringBoot2.X est uniquement. activé comme suit par défaut. Les points de terminaison

peuvent ouvrir d'autres points de terminaison des manières suivantes. Si vous devez fermer certains points de terminaison, vous pouvez les définir en exclusion.

management:
  endpoints:
    web:
      exposure:
        include: "*"
        exclude: ""

Redémarrez le projet et vous pouvez voir que les points de terminaison affichés ont beaucoup augmenté

Organisation des points de terminaison de l'actionneur

/autoconfig et /conditions pour obtenir les conditions de configuration automatiques

fournit un rapport de configuration automatique pour enregistrer lesquelles Les conditions de configuration automatique ont réussi et celles qui ont échoué. La nouvelle version a été adaptée aux conditions. La configuration automatique de Spring Boot est basée sur la configuration conditionnelle de Spring. Il fournit de nombreuses classes de configuration avec des annotations @Conditional et détermine s'il faut configurer automatiquement ces beans en fonction des conditions. Le point de terminaison /autoconfig fournit un rapport répertoriant toutes les conditions qui ont été évaluées, regroupées selon que la condition a réussi ou échoué.

Endpoint : http://localhost:9999/actuator/conditions

[Exemple]

Ce qui précède est un exemple de condition d'échec, comme le montre l'image est JdbcTemplate, cette classe peut aider nous exploitons la base de données. Parce que les classes dépendantes pertinentes n'ont pas été introduites, comme le dit son message d'invite :

"message": "@ConditionalOnClass n'a pas trouvé la classe requise ‘org.springframework.jdbc.core.JdbcTemplate’

Vérifiez le chemin de classe et" il n'y a aucune exigence Si la condition JdbcTemplate n'est pas remplie, la configuration automatique ne sera pas effectuée

/beans Obtenez le rapport d'assemblage du Bean

Pour comprendre le contexte Spring dans l'application, le point de terminaison le plus important est /beans. Il renvoie un document JSON décrivant chaque bean dans le contexte, y compris son type Java et les autres beans injectés.

Request endpoint : /actuator/beans

/env endpoint Afficher les propriétés de configuration

/env endpoint génère une liste de toutes les propriétés d'environnement disponibles pour l'application, qu'elles soient utilisées ou non. Cela inclut les variables d'environnement, les propriétés JVM, les paramètres de ligne de commande et les propriétés fournies par les fichiers application.properties ou application.yml.

Endpoint:/actuator/env

/env fournit des politiques de sécurité pour protéger la confidentialité de la configuration. Afin d'éviter que de telles informations ne soient exposées dans /env, tous les attributs nommés mot de passe, secret, clé (ou le dernier paragraphe du nom sont ceux-ci) seront ajoutés avec "*" dans /env, la référence est la suivante :

Le mappage d'URL de requête /mapping

/mapping endpoint affiche tous les chemins de requête @RequestMapping

Point de terminaison de requête : /actuator/mappings

[Interface de test]

    @GetMapping(value = "/hello", produces = "application/json;charset=utf-8")
    public String hello(@RequestParam("name") String name) {
        return "hello world";
    }

La valeur de chaque mappage a deux attributs : bean et méthode. L'attribut bean identifie le nom du Spring

Bean d'où provient le mappage. L'attribut méthode est la signature de méthode pleinement qualifiée de la méthode de mappage correspondante.

/metrics Surveillance des indicateurs d'exécution

/metrics nous fournit une surveillance des métriques d'exécution, qui peuvent vérifier rapidement l'application au moment de l'exécution.

Point final : /actuator/metrics

Les principaux éléments de surveillance sont les suivants :

/metrics端点会返回所有的可用度量值，但你也可能只对某个值感兴趣。要获取单个值，请求时可以在URL后加上对应的键名。

如上图所示，查询jvm最大内存，结果值大约为6G。

/httptrace 追踪Web请求

/httptrace端点能报告所有Web请求的详细信息，包括请求方法、路径、时间戳以及请求和响应的头信息。

【请求端点】/actuator/httptrace

默认情况下httptrace没有启用，它要求一个HttpTraceRepository 的对象Bean.

在系统中创建如下配置，提供一个HttpTraceRepository 类型的Bean,这里选择的是InMemoryHttpTraceRepository内存存储的方式。该方式默认提供最新的100条请求记录。

import org.springframework.boot.actuate.trace.http.HttpTraceRepository;
import org.springframework.boot.actuate.trace.http.InMemoryHttpTraceRepository;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

@Configuration
public class HttpTraceActuatorConfiguration {

    @Bean
    public HttpTraceRepository httpTraceRepository() {
        return new InMemoryHttpTraceRepository();
    }

}

/dump 导出线程快照

/dump端点会生成当前线程活动的快照。完整的线程导出报告里会包含应用程序的每个线程。其中包含很多线程的特定信息，还有线程相关的阻塞和锁状态。

【请求端点】/threaddump

【测试】

     Thread thread = new Thread(() -> {
            try {
                Thread.sleep(1000000);
            } catch (InterruptedException e) {
                e.printStackTrace();
            }
        }, "测试线程");
        thread.start();

/shutdown 优雅的关闭应用程序

/shutdown可以让应用服务优雅的关闭，默认是关闭的。假设你要关闭运行中的应用程序。比方说，在微服务架构中，你有多个微服务应用的实例运行在云上，其中某个实例有问题了，你决定关闭该实例并重启这个有问题的应用程序。在这个场景中，Actuator的/shutdown端点就很有用了。

优雅的关闭和kill -9的方式是相对的，它不会粗暴的立马关闭应用，而是会释放相关链接以及执行SpringBoot容器停止后的一些操作，然后再关闭应用。

【端点】/actuator/shutdown 要求POST请求方式

【示例】

在应用中添加一个关闭前处理的钩子方法

        Runtime.getRuntime().addShutdownHook(new Thread(() -> {
            System.out.println("关闭应用，释放资源");
        }));

可以看到通过/actuator/shutdown关闭应用可以触发这些关闭处理的钩子函数，方便我们在应用停止时关闭一些连接以及做一些其他的处理。

整理

【1】上面实践了一些Actuator端点示例，虽然Actuator提供的功能很强大，但是在如今的集群化，K8S容器化应用部署下，这些直接访问某些应用的情况就变得很少了，比如监控Zipkin 、Spring Cloud Sleuth等等，内存监控这一块K8S容器化平台也有很多。但是，去学习实践这样的一个工具也是很值得的，如果后面有类似监控、关闭应用、获取请求URL映射、获取配置等等，那么我们就可以去看看Actuator是如何做的，学习和扩展。

【2】本次的学习时看的《SpringBoot实战》书籍的学习笔记，该书Actuator章节后在后面也提及了很多进阶的知识，因为具体应用场景不多，下面就简单的整理下，把一些知识点记录下来，如果后面需要在重点实践学习下。

【3】《SpringBoot实战》书籍关于Actuator介绍的一些使用可能在当下的版本中有些出入，这里贴上官方文档地址，参考对比下https://docs.spring.io/spring-boot/docs/current/reference/html/actuator.html#actuator.enabling

【4】Actuator通过REST端点提供了不少非常有用的信息。另一个深入运行中应用程序内部的方式是使用远程shell。Spring Boot集成了CRaSH，一种能嵌入任意Java应用程序的shell。Spring Boot还扩展了CRaSH，添加了不少Spring Boot特有的命令，提供了与Actuator端点类似的功能。该工具附上应用上，会在启动时提供一个访问秘钥，我们通过ssh user@localhost -p 2000 的方式就可以去访问，并且执行一些命令去查看应用数据。

【5】除了REST端点和远程shell，Actuator还把它的端点以MBean的方式发布了出来，可以通过JMX来查看和管理。使用JMX是管理Spring Boot应用程序的一个好方法，如果你已在用JMX管理应用程序中的其他MBean，则尤其如此。

[6] Plus tôt, nous avons utilisé certains des bons points de terminaison intégrés fournis par Actuator. Nous pouvons également étendre et personnaliser Actuator en fonction de nos propres besoins.

• En fait, Actuator propose de nombreuses façons de le personnaliser, dont les cinq suivantes.

• 1 : Renommez le point de terminaison. Remplacez le point de terminaison par défaut par notre adresse de point de terminaison personnalisée.

• 2 : Activer et désactiver les points de terminaison.

• 3 : Informations de mesure personnalisées.

• 4 : Créez un entrepôt personnalisé pour stocker les données de suivi.

• 5 : Insérez des indicateurs de santé personnalisés.

【7】À ce stade, nous pouvons voir que grâce à Actuator, nous pouvons voir beaucoup d'informations sur le système, ce qui est bon pour les développeurs, mais du point de vue de la sécurité, si ce n'est pas restreint, la sécurité du système sera Il y aura de grands risques. La protection des points de terminaison d'Actuator peut être utilisée de la même manière que les autres chemins d'URL - en utilisant Spring Security. Dans une application Spring Boot, cela signifie ajouter la dépendance Security Starter en tant que dépendance de build, puis laisser la configuration automatique liée à la sécurité protéger l'application, y compris le point de terminaison Actuator. Par exemple, vous souhaitez protéger le point de terminaison /shutdown et autoriser l'accès uniquement aux utilisateurs disposant des privilèges ADMIN.

Ce qui précède est le contenu détaillé de. pour plus d'informations, suivez d'autres articles connexes sur le site Web de PHP en chinois!