spring-boot-starter-actuator监控接口详解

末蓝、 2022-11-07 14:34 13阅读 0赞

### 概述 ###

微服务作为一项在云中部署应用和服务的新技术是当下比较热门话题，而微服务的特点决定了功能模块的部署是分布式的，运行在不同的机器上相互通过服务调用进行交互，业务流会经过多个微服务的处理和传递，在这种框架下，微服务的监控显得尤为重要。

而[Actuator][]正是Spring Boot提供的对应用系统的监控和管理的集成功能，可以查看应用配置的详细信息，例如自动化配置信息、创建的Spring beans信息、系统环境变量的配置信以及Web请求的详细信息等。如果使用不当或者一些不经意的疏忽，可能造成信息泄露等严重的安全隐患。

### Actuator使用 ###

Actuator应用监控使用只需要添加spring-boot-starter-actuator依赖即可，如下：

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

可以在application.properties中指定actuator的访问路径，如指定路径为/monitor：

management.context-path=/monitor

此时，运行示例,访问/monitor/env即可查看系统环境变量的配置信息，之后再访问/monitor/trace即可查看所有Web请求的详细信息，包括请求方法、路径、时间戳以及请求和响应的头信息甚至cookie信息，如图:

![5be481f84d580d71f1b64d6374d53796.png][]

Actuator监控分成两类：原生端点和用户自定义扩展端点，原生的主要有：

<table> 
 <thead> 
  <tr> 
   <th>路径</th> 
   <th>描述</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>/autoconfig</td> 
   <td>提供了一份自动配置报告，记录哪些自动配置条件通过了，哪些没通过</td> 
  </tr> 
  <tr> 
   <td>/beans</td> 
   <td>描述应用程序上下文里全部的Bean，以及它们的关系</td> 
  </tr> 
  <tr> 
   <td>/env</td> 
   <td>获取全部环境属性</td> 
  </tr> 
  <tr> 
   <td>/configprops</td> 
   <td>描述配置属性(包含默认值)如何注入Bean</td> 
  </tr> 
  <tr> 
   <td>/dump</td> 
   <td>获取线程活动的快照</td> 
  </tr> 
  <tr> 
   <td>/health</td> 
   <td>报告应用程序的健康指标，这些值由HealthIndicator的实现类提供</td> 
  </tr> 
  <tr> 
   <td>/info</td> 
   <td>获取应用程序的定制信息，这些信息由info打头的属性提供</td> 
  </tr> 
  <tr> 
   <td>/mappings</td> 
   <td>描述全部的URI路径，以及它们和控制器(包含Actuator端点)的映射关系</td> 
  </tr> 
  <tr> 
   <td>/metrics</td> 
   <td>报告各种应用程序度量信息，比如内存用量和HTTP请求计数</td> 
  </tr> 
  <tr> 
   <td>/shutdown</td> 
   <td>关闭应用程序，要求endpoints.shutdown.enabled设置为true</td> 
  </tr> 
  <tr> 
   <td>/trace</td> 
   <td>提供基本的HTTP请求跟踪信息(时间戳、HTTP头等)</td> 
  </tr> 
 </tbody> 
</table>

### 安全措施 ###

如果上述请求接口不做任何安全限制，安全隐患显而易见。实际上Spring Boot也提供了安全限制功能。比如要禁用/env接口，则可设置如下：

endpoints.env.enabled= false

如果只想打开一两个接口，那就先禁用全部接口，然后启用需要的接口：

endpoints.enabled = false
    endpoints.metrics.enabled = true

另外也可以引入spring-boot-starter-security依赖

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

在application.properties中指定actuator的端口以及开启security功能，配置访问权限验证，这时再访问actuator功能时就会弹出登录窗口，需要输入账号密码验证后才允许访问。

management.port=8099
    management.security.enabled=true
    security.user.name=admin
    security.user.password=admin

### 安全建议 ###

在使用Actuator时，不正确的使用或者一些不经意的疏忽，就会造成严重的信息泄露等安全隐患。在代码审计时如果是springboot项目并且遇到actuator依赖，则有必要对安全依赖及配置进行复查。也可作为一条规则添加到黑盒扫描器中进一步把控。  
安全的做法是一定要引入security依赖，打开安全限制并进行身份验证。同时设置单独的Actuator管理端口并配置不对外网开放。

参考：[https://www.jianshu.com/p/481134c3fab7][https_www.jianshu.com_p_481134c3fab7]

# spring-boot-starter-actuator功能简介 #

根据应用依赖和配置自动创建出来的监控和管理端点。通过这些端点，我们可以实时获取系统应用的各项监控指标。

# spring-boot-starter-actuator功能集成 #

## 第一步：添加相关jar包依赖 ##

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

## 第二步：application.properties 配置Spring-Boot-Actuator配置 ##

1.  `#spring-boot-actuator配置`
2.  `#开放所有的web Endpoints`
3.  `management.endpoints.web.exposure.include=*`

## 第三步：获取监控端点详细信息和效果展示 ##

通过访问：[http://localhost:8082/actuator][http_localhost_8082_actuator],获取监控端点详细信息

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3pob3V6aGl3ZW5nYW5n_size_16_color_FFFFFF_t_70][]

字符串格式化：

1.  `{`
2.  `"_links":{`
3.  `"self":{`
4.  `"href":"http://localhost:8082/actuator",`
5.  `"templated":false`
6.  `},`
7.  `"archaius":{`
8.  `"href":"http://localhost:8082/actuator/archaius",`
9.  `"templated":false`
10. `},`
11. `"auditevents":{`
12. `"href":"http://localhost:8082/actuator/auditevents",`
13. `"templated":false`
14. `},`
15. `"beans":{`
16. `"href":"http://localhost:8082/actuator/beans",`
17. `"templated":false`
18. `},`
19. `"caches-cache":{`
20. `"href":"http://localhost:8082/actuator/caches/{cache}",`
21. `"templated":true`
22. `},`
23. `"caches":{`
24. `"href":"http://localhost:8082/actuator/caches",`
25. `"templated":false`
26. `},`
27. `"health":{`
28. `"href":"http://localhost:8082/actuator/health",`
29. `"templated":false`
30. `},`
31. `"health-component":{`
32. `"href":"http://localhost:8082/actuator/health/{component}",`
33. `"templated":true`
34. `},`
35. `"health-component-instance":{`
36. `"href":"http://localhost:8082/actuator/health/{component}/{instance}",`
37. `"templated":true`
38. `},`
39. `"conditions":{`
40. `"href":"http://localhost:8082/actuator/conditions",`
41. `"templated":false`
42. `},`
43. `"configprops":{`
44. `"href":"http://localhost:8082/actuator/configprops",`
45. `"templated":false`
46. `},`
47. `"env":{`
48. `"href":"http://localhost:8082/actuator/env",`
49. `"templated":false`
50. `},`
51. `"env-toMatch":{`
52. `"href":"http://localhost:8082/actuator/env/{toMatch}",`
53. `"templated":true`
54. `},`
55. `"info":{`
56. `"href":"http://localhost:8082/actuator/info",`
57. `"templated":false`
58. `},`
59. `"loggers":{`
60. `"href":"http://localhost:8082/actuator/loggers",`
61. `"templated":false`
62. `},`
63. `"loggers-name":{`
64. `"href":"http://localhost:8082/actuator/loggers/{name}",`
65. `"templated":true`
66. `},`
67. `"heapdump":{`
68. `"href":"http://localhost:8082/actuator/heapdump",`
69. `"templated":false`
70. `},`
71. `"threaddump":{`
72. `"href":"http://localhost:8082/actuator/threaddump",`
73. `"templated":false`
74. `},`
75. `"metrics-requiredMetricName":{`
76. `"href":"http://localhost:8082/actuator/metrics/{requiredMetricName}",`
77. `"templated":true`
78. `},`
79. `"metrics":{`
80. `"href":"http://localhost:8082/actuator/metrics",`
81. `"templated":false`
82. `},`
83. `"scheduledtasks":{`
84. `"href":"http://localhost:8082/actuator/scheduledtasks",`
85. `"templated":false`
86. `},`
87. `"httptrace":{`
88. `"href":"http://localhost:8082/actuator/httptrace",`
89. `"templated":false`
90. `},`
91. `"mappings":{`
92. `"href":"http://localhost:8082/actuator/mappings",`
93. `"templated":false`
94. `},`
95. `"refresh":{`
96. `"href":"http://localhost:8082/actuator/refresh",`
97. `"templated":false`
98. `},`
99. `"features":{`
100. `"href":"http://localhost:8082/actuator/features",`
101. `"templated":false`
102. `},`
103. `"service-registry":{`
104. `"href":"http://localhost:8082/actuator/service-registry",`
105. `"templated":false`
106. `}`
107. `}`
108. `}`

spring-boot-starter-actuator模块生成的原生监控端点，分为三大类：

1.  应用配置类：获取应用程序中加载的应用配置、环境变量、自动化配置报告等与SpringBoot应用密切相关的配置类信息；这类端点可以帮助我们获取一系列关于Spring应用配置内容的详细报告，比如自动化配置的报告、Bean创建的报告、环境属性的报告等。
2.  度量指标类：获取应用程序运行过程中用于监控的度量指标，比如内存信息、线程池信息、HTTP请求统计等；
3.  操作监控类：提供了对应用的关闭等操作类功能；

以上三类监控端点的详细信息，下面我们详细来说明。

## 第四步：监控端点信息描述 ##

### **应用配置类：默认启用** ###

1.  /autoconfig: 该端点用来获取应用的自动化配置报告，其中包括所有自动化配置的候选项，同时列举了每个候选项是否满足自动化配置的各个先决条件。该端点可以帮助我们方便地找到一些自动化配置为什么没有生效的具体原因。报告内容分为两部分，如下：  
    (1)positiveMatches中返回的是条件匹配成功的自动化配置；  
    (2)negativeMathches中返回的是条件匹配不成功的自动化配置。
2.  /beans: 该端点用来获取应用上下文中创建的所有Bean。包含的具体信息如下：  
    (1)bean：Bean的名称；  
    (2)scope: Bean的作用域；  
    (3)type: Bean的Java类型；  
    (4)resource: class文件的具体路径；  
    (5)dependencies: 依赖的Bean的名称;
3.  /configprops: 该端点用来获取应用中配置的属性信息报告。我们可以通过该报告来看到各个属性的配置路径，比如我们要关闭端点，就可以使用endpoints.configprops.enabled=false来完成设置。
4.  /env: 该端点用来获取应用所有可用的环境属性报告，具体包括环境变量、JVM属性、应用的配置属性、命令行中的参数。通过该端点返回的信息，我们可以看到当前应用加载的配置信息，可以结合@ConfigurationProperties注解将它们引入到应用程序中使用。对于一些敏感属性信息，比如在属性名中包含password,secret,key这些关键词，在返回的时候会使用\*来替换。
5.  /mappings: 该端点用来返回所有Spring MVC的控制器映射关系报告。返回的信息有：  
    (1)bean属性: 标识该映射关系的请求处理器；  
    (2)method属性：标识该映射关系的具体处理类和处理函数；
6.  /info:该端点用来返回一些应用自定义的信息。默认情况下，该端点只会返回一个空的JSON内容。我们可以在application.properties配置文件中设置一些以info为前缀的属性配置信息，就能看到效果。

### **度量指标类：默认启用** ###

1.  /metrics: 该端点用来返回当前应用的各类重要度量指标，比如内存信息、线程信息、垃圾回收信息等。具体信息包含如下：  
    (1)系统信息：包括处理器数量processors、运行时间uptime和instance.uptime、系统平均负载systemload.average;  
    (2)mem.\*: 内存概要信息，包括分配给应用的总内存数量以及当前空闲的内存数量，这些信息来自java.lang.Runtime;  
    (3)heap.\*: 堆内存使用情况。这些信息来自java.lang.management.MemoryMXBean接口中getHeapMemoryUsage方法获取的java.lang.management.MemoryUsage;  
    (4)nonheap.\*: 非堆内存使用情况。这些信息来自java.lang.management.MemoryMXBean接口中getNonHeapMemoryUsage方法获取java.lang.management.MemoryUsage;  
    (5)threads.\*: 线程使用情况，包括线程数、守护线程（daemon)、线程峰值（peak)等，这些信息来自java.lang.management.ThreadMXBean;  
    (6)classes.\*: 应用加载和卸载的类统计，这些信息来自java.lang.managemeng.ClassLoadingMXBean;  
    (7)gc.\*: 垃圾收集器的详细信息，包括垃圾回收次数gc.ps\_scavenge.count、垃圾回收消耗时间gc.ps\_scavenge.time、标记-清除算法的次数gc.ps\_marksweep.count、标记-清除算法的消耗时间gc.ps\_marksweep.time。这些信息来自java.lang.management.GarbageCollectorMXBean;  
    (8)httpsessions.\*: Tomcat容器的会话使用情况。包括最大会话数httpsessions.max和活跃会话数httpsessions.active。该度量指标信息仅在引入嵌入式Tomcat作为应用容器的时候才会提供；  
    (9)gauge.\*: HTTP请求的性能指标之一，它主要用来反映一个绝对值。  
    (10)counter.\*: HTTP请求的性能指标之一，它主要作为计数器来使用，记录了增加量和减少量。  
    报告的具体内容如下：
2.  /health: 该端点用来获取应用的各类健康指标信息。在spring-boot-starter-actuator模块中自带实现了一些常用资源的健康指标检测器，这些健康指标检测器都是通过HealthIndicator接口实现，并且会根据依赖关系的引入实现自动化配置。常见的一些健康指标检测器如下：  
    (1)DiskSpaceHealthIndicator: 低磁盘空间检测；  
    (2)DataSourceHealthIndicator: 检测DataSource的链接是否成功；  
    (3)MongoHealthIndicator: 检测Mongo数据库是否可用；  
    (4)RabbitHealthIndicator: 检测Rabbit服务器是否可用；  
    (5)RedisHealthIndicator: 检测Redis服务器是否可用；  
    (6)SolrHealthIndicator: 检测Solr服务器是否可用；  
    我们也可用通过实现HealthIndicator接口来自定义自己的健康指标检测器；  
    报告的具体内容如下：
3.  /dump: 该端点用来暴露程序运行中的线程信息。它使用java.lang.management.ThreadMXBean的dumpAllThreads方法来返回所有含有同步信息的活动线程详情；
4.  /trace: 该端点用来返回基本的HTTP跟踪信息。默认情况下，跟踪信息的存储采用org.springframework.boot.actuate.trace.InMemoryTraceRepository实现的内存方式，始终保留最近的100条请求记录。

### **操作控制类：需要通过属性配置来开启操作** ###

1./shutdown: 该端点用来实现关闭应用的远程操作，需要配置属性endpoints.shutdown.enable=true才能实现。该操作非常危险，不建议使用。

[Actuator]: https://docs.spring.io/spring-boot/docs/current/reference/htmlsingle/#production-ready
[5be481f84d580d71f1b64d6374d53796.png]: /images/20221023/50835afe458e497fbf30879185b5e2d2.png
[https_www.jianshu.com_p_481134c3fab7]: https://www.jianshu.com/p/481134c3fab7
[http_localhost_8082_actuator]: http://localhost:8082/actuator
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3pob3V6aGl3ZW5nYW5n_size_16_color_FFFFFF_t_70]: /images/20221023/ed2edc81bdc34b3c86c2ac30a0d953f0.png