学习Spring Boot：（二十七）Spring Boot 2.0 中使用 Actuator

待我称王封你为后i 2023-10-02 16:01 16阅读 0赞

#### 前言 ####

主要是完成微服务的监控，完成监控治理。可以查看微服务间的数据处理和调用，当它们之间出现了异常，就可以快速定位到出现问题的地方。

*  springboot - version: 2.0

#### 正文 ####

##### 依赖 #####

maven 项目 在 `pom.xml` 文件中加入 actuator 的依赖：

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

使用 Gradle 构建：也可以使用Maven

dependencies {
        
    	compile("org.springframework.boot:spring-boot-starter-actuator")
    }

##### 配置 #####

需要注意的是 Spring Boot 2.0 相对于上个版本， Actuator 发生很多变化，

###### keys 的配置改变 ######

<table> 
 <thead> 
  <tr> 
   <th>旧的属性</th> 
   <th>新的属性</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td><code>endpoints..*</code></td> 
   <td><code>management.endpoint..*</code></td> 
  </tr> 
  <tr> 
   <td><code>endpoints.cors.*</code></td> 
   <td><code>management.endpoints.web.cors.*</code></td> 
  </tr> 
  <tr> 
   <td><code>endpoints.jmx.*</code></td> 
   <td><code>management.endpoints.jmx.*</code></td> 
  </tr> 
  <tr> 
   <td><code>management.address</code></td> 
   <td><code>management.server.address</code></td> 
  </tr> 
  <tr> 
   <td><code>management.context-path</code></td> 
   <td><code>management.server.servlet.context-path</code></td> 
  </tr> 
  <tr> 
   <td><code>management.ssl.*</code></td> 
   <td><code>management.server.ssl.*</code></td> 
  </tr> 
  <tr> 
   <td><code>management.port</code></td> 
   <td><code>management.server.port</code></td> 
  </tr> 
 </tbody> 
</table>

###### 基本路径 ######

1.  所有 endpoints 默认情况下都已移至 `/actuator`。就是多了跟路径 `actuator` ；
2.  上个版本中的 `management/context-path:` 和 `management/port:` 改为 :
    
        management:
          server:
            port: 8004
            servlet:
              context-path: /xxx # 只有在设置了 management.server.port 时才有效
    
    另外，您还可以使用新的单独属性 `management.endpoints.web.base-path` 为管理端点设置基本路径。
    
    例如，如果你设置`management.server.servlet.context-path=/management`和`management.endpoints.web.base-path=/application`，你就可以在下面的路径到达终点健康：`/management/application/health`。
    
    如果你想恢复 1.x 的行为（即具有`/health`代替`/actuator/health`），设置以下属性：`management.endpoints.web.base-path=/`

###### ENDPOINTS ######

1.X 的时候属性：

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

2.0 部分更改：

<table> 
 <thead> 
  <tr> 
   <th>1.x 端点</th> 
   <th>2.0 端点（改变）</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td><code>/actuator</code></td> 
   <td>不再可用。 但是，在 <code>management.endpoints.web.base-path</code> 的根目录中有一个映射，它提供了到所有暴露端点的链接。</td> 
  </tr> 
  <tr> 
   <td><code>/auditevents</code></td> 
   <td>该<code>after</code>参数不再需要</td> 
  </tr> 
  <tr> 
   <td><code>/autoconfig</code></td> 
   <td>重命名为 <code>/conditions</code></td> 
  </tr> 
  <tr> 
   <td><code>/docs</code></td> 
   <td>不再可用</td> 
  </tr> 
  <tr> 
   <td><code>/health</code></td> 
   <td>现在有一个 <code>management.endpoint.health.show-details</code> 选项 <code>never</code>, <code>always</code>, <code>when-authenticated</code>，而不是依靠 <code>sensitive</code> 标志来确定 <code>health</code> 端点是否必须显示全部细节。 默认情况下，<code>/actuator/health</code>公开并且不显示细节。</td> 
  </tr> 
  <tr> 
   <td><code>/trace</code></td> 
   <td>重命名为 <code>/httptrace</code></td> 
  </tr> 
 </tbody> 
</table>

默认端点 path 前面多了一级 `/actuator` 。

**同时注意只有端点`/health`和`/info`端点是暴露的。**

<table> 
 <thead> 
  <tr> 
   <th>Property</th> 
   <th>Default</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td><code>management.endpoints.jmx.exposure.exclude</code></td> 
   <td></td> 
  </tr> 
  <tr> 
   <td><code>management.endpoints.jmx.exposure.include</code></td> 
   <td><code>*</code></td> 
  </tr> 
  <tr> 
   <td><code>management.endpoints.web.exposure.exclude</code></td> 
   <td></td> 
  </tr> 
  <tr> 
   <td><code>management.endpoints.web.exposure.include</code></td> 
   <td><code>info, health</code></td> 
  </tr> 
 </tbody> 
</table>

1.  您可以按如下方式公开所有端点：`management.endpoints.web.exposure.include=*`
2.  您可以通过以下方式显式启用`/shutdown`端点：`management.endpoint.shutdown.enabled=true`
3.  要公开所有（已启用）网络端点除`env`端点之外：

management.endpoints.web.exposure.include=*
    management.endpoints.web.exposure.exclude=env

例如：

我现在开启所有的端点：

management:
      endpoints:
        web:
          exposure:
            include: "*" # * 在yaml 文件属于关键字

执行 `localhost:${port}/actuator`，可以看到所有可以执行查看的端点监控的 Url，然后我们尝试执行关闭应用进程的指令：`shutdown`：

![image][]

###### 端点格式 ######

1.  `/actuator/mappings` 端点大改变  
    JSON 格式已经更改为现在正确地包含有关上下文层次结构，多个`DispatcherServlets，`部署的 Servlet 和 Servlet 过滤器的信息。详情请参阅[＃9979][9979]。  
    Actuator API 文档的[相关部分][Link 1]提供了一个示例文档。
2.  `/actuator/httptrace` 端点大改变  
    响应的结构已经过改进，以反映端点关注跟踪 HTTP 请求 - 响应交换的情况。

#### 总结 ####

主要是 Spring Boot 2.0 版本升级在 Actuator 上面有许多改动，需要记录下。

#### 参考文章 ####

*  [Part V. Spring Boot Actuator: Production-ready features][Part V. Spring Boot Actuator_ Production-ready features]
 *  [Spring Boot 2.0系列文章(一)：Spring Boot 2.0 迁移指南][Spring Boot 2.0_Spring Boot 2.0]

[image]: https://imgconvert.csdnimg.cn/aHR0cHM6Ly96cW5pZ2h0LmdpdGVlLmlvL2thaW16LmdpdGh1Yi5pby9pbWFnZS9oZXhvL3NwcmluZ2Jvb3QtYWN0dWF0b3Ivc2hvdGRvd24ucG5n?x-oss-process=image/format,png
[9979]: https://github.com/spring-projects/spring-boot/issues/9979#issuecomment-357930821
[Link 1]: https://docs.spring.io/spring-boot/docs/current-SNAPSHOT/actuator-api/html/#mappings
[Part V. Spring Boot Actuator_ Production-ready features]: https://docs.spring.io/spring-boot/docs/current-SNAPSHOT/reference/htmlsingle/#production-ready-endpoints
[Spring Boot 2.0_Spring Boot 2.0]: http://www.54tianzhisheng.cn/2018/03/06/SpringBoot2-Migration-Guide/