去年我们项目做了微服务1.0的架构转型，但是服务监控这块却没有跟上。这不，最近我就被分配了要将我们核心的微服务应用全部监控起来的任务。我们的微服务应用都是SpringBoot 应用，因此就自然而然的想到了借助Spring Boot 的Actuator 模块。

本篇是我在完成这个工单之后，对Spring Boot Actuator模块 学习应用的总结。在本篇文章中，你可以学习到：

1、Spring Boot Actuator 的快速使用入门
2、Spring Boot Actuator 的一些重要的endpoints的介绍
3、如何通过Actuator 模块实时查看当前应用的线程 dump信息
4、如何通过Actuator 模块实时查看当前应用的堆信息
5、如何通过Actuator 模块实时修改当前应用的日志打印等级
6、…

之后我还会介绍：

TODO：SpringBoot 微服务应用集成Prometheus + Grafana实现监控告警

什么是 Spring Boot Actuator

Micrometer 为 Java 平台上的性能数据收集提供了一个通用的 API，应用程序只需要使用 Micrometer 的通用 API 来收集性能指标即可。Micrometer 会负责完成与不同监控系统的适配工作。这就使得切换监控系统变得很容易。

对比 Slf4j 之于 Java Logger 中的定位。

快速开始，创建一个Spring Boot Actuator Demo

我们先创建一个demo应用。

你可以通过Spring Boot CLI 创建：

1.  
   
   spring init -d=web,actuator -n=actuator-demo actuator-demo

    

对应的maven依赖：

1.  
   
   <dependencies>

    

2.  
   
   ...

    

3.  
   
   <dependency>

    

4.  
   
   <groupId>org.springframework.boot</groupId>

    

5.  
   
   <artifactId>spring-boot-starter-actuator</artifactId>

    

6.  
   
   </dependency>

    

7.  
   
   ...

    

8.  
   
   </dependencies>

    

1.  
   
   dependencies {

    

2.  
   
   compile("org.springframework.boot:spring-boot-starter-actuator")

    

3.  
   
   }

    

Endpoints 介绍

Spring Boot 提供了所谓的 endpoints （下文翻译为端点）给外部来与应用程序进行访问和交互。

打比方来说， /health 端点 提供了关于应用健康情况的一些基础信息。metrics 端点提供了一些有用的应用程序指标（JVM 内存使用、系统CPU使用等）。

这些 Actuator 模块本来就有的端点我们称之为原生端点。根据端点的作用的话，我们大概可以分为三大类：

应用配置类：获取应用程序中加载的应用配置、环境变量、自动化配置报告等与Spring Boot应用密切相关的配置类信息。

度量指标类：获取应用程序运行过程中用于监控的度量指标，比如：内存信息、线程池信息、HTTP请求统计等。

操作控制类：提供了对应用的关闭等操作类功能。

详细的原生端点介绍，请以官网为准，这里就不赘述徒增篇幅。

需要注意的就是：

1、每一个端点都可以通过配置来单独禁用或者启动

2、不同于Actuator 1.x，Actuator 2.x 的大多数端点默认被禁掉。Actuator 2.x 中的默认端点增加了 /actuator前缀。默认暴露的两个端点为 /actuator/health和 /actuator/info

端点暴露配置

我们可以通过以下配置，来配置通过JMX 和 HTTP 暴露的端点。

可以打开所有的监控点

1.  
   
   management.endpoints.web.exposure.include=*

    

1.  
   
   management.endpoints.web.exposure.exclude=beans,trace

    

1.  
   
   management.endpoints.web.base-path=/minitor

    

1. # "*" 代表暴露所有的端点 如果指定多个端点，用","分开
2. management.endpoints.web.exposure.include=*
3. # 赋值规则同上
4. management.endpoints.web.exposure.exclude=

启动DEMO程序，访问 http://localhost:8080/actuator，查看暴露出来的端点：

上面这样显示是因为chrome 浏览器安装了 JSON-handle 插件，实际上就是返回一大段json

下面，我会着重介绍几个比较重要的端点。

重要端点解析

1. management.endpoint.health.show-details=always

该属性可以使用以下值之一进行配置：

按照上述配置，配置成 always之后，我们启动项目，访问 http://localhost:8080/actuator/health端口，可以看到这样的信息：

是不是感觉好像健康信息有点少？先别急，那是因为我们创建的是一个最基础的Demo项目，没有依赖很多的组件。

/health端点有很多自动配置的健康指示器：如redis、rabbitmq、db等组件。当你的项目有依赖对应组件的时候，这些健康指示器就会被自动装配，继而采集对应的信息。如上面的 diskSpace 节点信息就是 DiskSpaceHealthIndicator 在起作用。

上述截图取自官方文档

这是我另一个项目的 /health端点信息。

当如上的组件有一个状态异常，应用服务的整体状态即为down。我们也可以通过配置禁用某个组件的健康监测。

1.  
   
   management.health.mongo.enabled: false

    

1.  
   
   management.health.defaults.enabled: false

    

⭐自定义 Health Indicator

1. /**
2. * @author Richard_yyf
3. * @version 1.0 2020/1/16
4. */
5. @Component
6. publicclassCustomHealthIndicatorextendsAbstractHealthIndicator{
7.  
8. @Override
9. protectedvoid doHealthCheck(Health.Builder builder) throwsException{
10. // 使用 builder 来创建健康状态信息
11. // 如果你throw 了一个 exception，那么status 就会被置为DOWN，异常信息会被记录下来
12. builder.up()
13. .withDetail("app", "这个项目很健康")
14. .withDetail("error", "Nothing, I'm very good");
15. }
16. }

最终效果：

5.2 /metrics端点

/metrics端点用来返回当前应用的各类重要度量指标，比如：内存信息、线程信息、垃圾回收信息、tomcat、数据库连接池等。

1. {
2. "names": [
3. "tomcat.threads.busy",
4. "jvm.threads.states",
5. "jdbc.connections.active",
6. "jvm.gc.memory.promoted",
7. "http.server.requests",
8. "hikaricp.connections.max",
9. "hikaricp.connections.min",
10. "jvm.memory.used",
11. "jvm.gc.max.data.size",
12. "jdbc.connections.max",
13. ....
14. ]
15. }

不同于1.x，Actuator在这个界面看不到具体的指标信息，只是展示了一个指标列表。为了获取到某个指标的详细信息，我们可以请求具体的指标信息，像这样：

1. http://localhost:8080/actuator/metrics/{MetricName}

比如我访问 /actuator/metrics/jvm.memory.max，返回信息如下：

5.3 /loggers端点

/loggers 端点暴露了我们程序内部配置的所有logger的信息。我们访问 /actuator/loggers可以看到，

你也可以通过下述方式访问单独一个logger，

1.  
   
   http://localhost:8080/actuator/loggers/{name}

    

1.  
   
   {

    

2.  
   
   "configuredLevel": "INFO",

    

3.  
   
   "effectiveLevel": "INFO"

    

4.  
   
   }

    

⭐改变运行时的日志等级

/loggers端点我最想提的就是这个功能，能够动态修改你的日志等级。

1. {
2. "configuredLevel":
   
   "DEBUG"

    

3.  
   
   }

    

如果想重置成默认值，把value 改成 null

5.4 /info端点

1. info.app.name=actuator-test-demo
2. info.app.encoding=UTF-8
3. info.app.java.source=1.8
4. info.app.java.target=1.8
5. # 在 maven 项目中你可以直接用下列方式引用 maven properties的值
6. # info.app.encoding=@project.build.sourceEncoding@
7. # info.app.java.source=@java.version@
8. # info.app.java.target=@java.version@

启动项目，访问 http://localhost:8080/actuator/info：

1. {
2. "app": {
3. "encoding": "UTF-8",
4. "java": {
5. "source": "1.8.0_131",
6. "target": "1.8.0_131"
7. },
8. "name": "actuator-test-demo"
9. }
10. }

5.5 /beans端点

/beans端点会返回Spring 容器中所有bean的别名、类型、是否单例、依赖等信息。

访问 http://localhost:8080/actuator/beans，返回如下：

5.6 /heapdump 端点

5.7 /threaddump 端点

这个端点我个人觉得特别有用，方便我们在日常定位问题的时候查看线程的情况。主要展示了线程名、线程ID、线程的状态、是否等待锁资源、线程堆栈等信息。就是可能查看起来不太直观。访问 http://localhost:8080/actuator/threaddump返回如下：

5.8 /shutdown端点

这个端点属于操作控制类端点，可以优雅关闭 Spring Boot 应用。要使用这个功能首先需要在配置文件中开启：

1. management.endpoint.shutdown.enabled=true

由于 shutdown 接口默认只支持 POST 请求，我们启动Demo项目，向 http://localhost:8080/actuator/shutdown发起 POST请求。返回信息：

1.  
   
   {

    

2.  
   
   "message": "Shutting down, bye..."

    

3.  
   
   }

    

整合Spring Security 对端点进行安全校验

1. <dependency>
2. <groupId>org.springframework.boot</groupId>
3. <artifactId>spring-boot-starter-security</artifactId>
4. </dependency>

添加之后，我们需要定义安全校验规则，来覆盖Spring Security 的默认配置。

这里我给出了两个版本的模板配置：

1. import org.springframework.boot.actuate.autoconfigure.security.servlet.EndpointRequest;
2. import org.springframework.boot.actuate.context.ShutdownEndpoint;
3. import org.springframework.boot.autoconfigure.security.servlet.PathRequest;
4. import org.springframework.context.annotation.Configuration;
5. import org.springframework.security.config.annotation.web.builders.HttpSecurity;
6. import org.springframework.security.config.annotation.web.configuration.WebSecurityConfigurerAdapter;
7.  
8. /**
9. * @author Richard_yyf
10. */
11. @Configuration
12. publicclassActuatorSecurityConfigextendsWebSecurityConfigurerAdapter{
13.  
14. /*
15. * version1:
16. * 1. 限制 '/shutdown'端点的访问，只允许ACTUATOR_ADMIN访问
17. * 2. 允许外部访问其他的端点
18. * 3. 允许外部访问静态资源
19. * 4. 允许外部访问 '/'
20. * 5. 其他的访问需要被校验
21. * version2:
22. * 1. 限制所有端点的访问，只允许ACTUATOR_ADMIN访问
23. * 2. 允许外部访问静态资源
24. * 3. 允许外部访问 '/'
25. * 4. 其他的访问需要被校验
26. */
27.  
28. @Override
29. protectedvoid configure(HttpSecurity http) throwsException{
30. // version1
31. // http
32. // .authorizeRequests()
33. // .requestMatchers(EndpointRequest.to(ShutdownEndpoint.class))
34. // .hasRole("ACTUATOR_ADMIN")
35. // .requestMatchers(EndpointRequest.toAnyEndpoint())
36. // .permitAll()
37. // .requestMatchers(PathRequest.toStaticResources().atCommonLocations())
38. // .permitAll()
39. // .antMatchers("/")
40. // .permitAll()
41. // .antMatchers("/**")
42. // .authenticated()
43. // .and()
44. // .httpBasic();
45.  
46. // version2
47. http
48. .authorizeRequests()
49. .requestMatchers(EndpointRequest.toAnyEndpoint())
50. .hasRole("ACTUATOR_ADMIN")
51. .requestMatchers(PathRequest.toStaticResources().atCommonLocations())
52. .permitAll()
53. .antMatchers("/")
54. .permitAll()
55. .antMatchers("/**")
56. .authenticated()
57. .and()
58. .httpBasic();
59. }
60. }

1. # Spring Security Default user name and password
2. spring.security.user.name=actuator
3. spring.security.user.password=actuator
4. spring.security.user.roles=ACTUATOR_ADMIN