SpringBoot中如何对actuator进行关闭

SpringBoot对actuator进行关闭

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

SpringBoot actuator知识梳理

Spring Boot的Actuator。它提供了很多生产级的特性，比如监控和度量Spring Boot应用程序。Actuator的这些特性可以通过众多REST端点、远程shell和JMX获得。

【使用环境】

【1】SpringBoot版本2.5.0、jdk11

【2】服务端口 9999

添加依赖

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

启动项目，访问/actuator端点，SpringBoot2.X版本默认只开启了如下端点

可以通过下面的方式开启其他的端点，如果需要关闭某些端点可以在exclude中设置。

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

重新启动项目，可以看到现在展示的端点增加了很多

官方文档：

https://docs.spring.io/spring-boot/docs/current/reference/html/actuator.html#actuator.endpoints

Actuator端点整理

/autoconfig和/conditions 获取自动配置条件

提供了一份自动配置报告，记录哪些自动配置条件通过了，哪些没通过。新版本已经调整为conditions。Spring Boot自动配置构建于Spring的条件化配置之上。它提供了众多带有@Conditional注解的配置类，根据条件决定是否要自动配置这些Bean。/autoconfig端点提供了一个报告，列出了计算过的所有条件，根据条件是否通过进行分组。

端点：Http://localhost:9999/actuator/conditions

【举例】

上面是失败的一个条件示例，如图所示是JdbcTemplate，这个类可以帮助我们操作数据库。因为未引入相关的依赖类所以正如它的提示信息所说：

“message”: “@ConditionalOnClass did not find required class ‘org.springframework.jdbc.core.JdbcTemplate’”

检查Classpath没有要求的JdbcTemplate条件不成立，则不会进行自动配置

/beans 获得Bean装配报告

要了解应用程序中Spring上下文的情况，最重要的端点就是/beans。它会返回一个JSON文档，描述上下文里每个Bean的情况，包括其Java类型以及注入的其他Bean。

请求端点：/actuator/beans

/env端点查看配置属性

/env端点会生成应用程序可用的所有环境属性的列表，无论这些属性是否用到。这其中包括环境变量、JVM属性、命令行参数，以及applicaition.properties或application.yml文件提供的属性。

端点：/actuator/env

/env提供了一些安全策略保护配置的隐私性。为了避免此类信息暴露到/env里，所有名为passWord、secret、key（或者名字中最后一段是这些）的属性在/env里都会加上“*”，参考如下：

/mapping请求URL映射

/mapping端点展示了所有@RequestMapping 请求路径

请求端点：/actuator/mappings

【测试接口】

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

每个映射的值都有两个属性：bean和method。bean属性标识了Spring

Bean的名字，映射源自这个Bean。method属性是映射对应方法的全限定方法签名。

/metrics运行时指标监控

/metrics为我们提供了对运行时度量情况的一个监控，能够在运行时快速检查应用程序。

端点：/actuator/metrics

主要的监控事项如下：

/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】前面我们使用了Actuator所提供好的一些内置端点，我们也可以根据自己的需求扩展定制Actuator。

• 实际上，Actuator有多种定制方式，包括以下五项。
• 1：重命名端点。将默认的端点修改为我们自定义的端点地址。
• 2：启用和禁用端点。
• 3：自定义度量信息。
• 4：创建自定义仓库来存储跟踪数据。
• 5：插入自定义的健康指示器。

【7】到这里我们可以看到通过Actuator我们可以看到系统的很多信息，这对于开发者而言很好，但是在安全层面来说，如果不加以限制，那么系统的安全将会有很大隐患。Actuator的端点保护可以用和其他URL路径一样的方式——使用Spring Security。在Spring Boot应用程序中，这意味着将Security起步依赖作为构建依赖加入，然后让安全相关的自动配置来保护应用程序，其中当然也包括了Actuator端点。举例来说，你想要保护/shutdown端点，仅允许拥有ADMIN权限的用户访问

总结

以上为个人经验，希望能给大家一个参考，也希望大家多多支持编程网。