5：SpringBoot-Actuator-Java Spring

- 日理万妓 2024-04-03 08:32 66阅读 0赞

#### 目录 ####

*  5.1 SpringBoot-Actuator介绍
 *  5.2 Endpoints 介绍
 *  5.3 Actuator原理
 *  5.4 Actuator依赖引入

## 5.1 SpringBoot-Actuator介绍 ##

Actuator是Spring Boot 的监控系统健康情况的工具，可帮将应用程序推送到生产环境时对其进行监控和管理，可以选择使用 HTTP 端点或 JMX 来管理和监视您的应用程序

由`spring-boot-starter-actuator` 提供很多监控所需的接口，可以对应用系统进行配置查看，例如自动化配置信息、创建的Spring beans信息、系统环境变量的配置信息等

> **Actuator 参考文档：[Spring Boot Actuator: Production-ready Features][Spring Boot Actuator_ Production-ready Features]**

## 5.2 Endpoints 介绍 ##

Spring Boot 提供了 Endpoints （端点）给外部与应用程序进行访问和交互

例如health端点可以提供基本的应用程序健康信息，映射到`/actuator/health`

默认情况下，除shutdown之外的所有端点都启用了，可使用`management.endpoint.<id>.enabled`属性配置端点的启动，例如启用shutdown端点`management.endpoint.shutdown.enabled=true`

Sensors类Endpoints

<table> 
 <thead> 
  <tr> 
   <th align="left">名称</th> 
   <th align="left">说明</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td align="left">autoconfig</td> 
   <td align="left">提供 SpringBoot 的自动配置报告，告诉我们哪些自动配置模块生效了，以及哪些 没有生效，原因是什么</td> 
  </tr> 
  <tr> 
   <td align="left">beans</td> 
   <td align="left">给出当前应用的容器中所有 bean 的信息</td> 
  </tr> 
  <tr> 
   <td align="left">configprops</td> 
   <td align="left">对现有容器中的 ConfigurationProperties 提供的信息进行“消毒”处理后给出汇总信息</td> 
  </tr> 
  <tr> 
   <td align="left">info</td> 
   <td align="left">提供当前 SpringBoot 应用的任意信息</td> 
  </tr> 
  <tr> 
   <td align="left">health</td> 
   <td align="left">针对当前 SpringBoot 应用的健康检查用的 endpoint</td> 
  </tr> 
  <tr> 
   <td align="left">env</td> 
   <td align="left">关于当前 SpringBoot 应用对应的 Environment 信息</td> 
  </tr> 
  <tr> 
   <td align="left">metrics</td> 
   <td align="left">显示应用多样的度量信息</td> 
  </tr> 
  <tr> 
   <td align="left">trace</td> 
   <td align="left">当前 SpringBoot 应用的 trace 信息</td> 
  </tr> 
  <tr> 
   <td align="left">mapping</td> 
   <td align="left">如果是基于 SpringMVC 的 Web 应用，将给出 @RequestMapping 相关信息</td> 
  </tr> 
 </tbody> 
</table>

Actuator类Endpoints

<table> 
 <thead> 
  <tr> 
   <th align="left">名称</th> 
   <th align="left">说明</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td align="left">shutdown</td> 
   <td align="left">用于关闭当前 SpringBoot 应用的 endpoint</td> 
  </tr> 
  <tr> 
   <td align="left">dump</td> 
   <td align="left">用于执行线程的 dump 操作</td> 
  </tr> 
 </tbody> 
</table>

## 5.3 Actuator原理 ##

Spring Boot Actuator 提供了一些 Actuator Endpoints端点用于应用程序交互，比如在项目出错时，自动报警、监控内容况等，Actuator原理可以归结为执行器端点的实现原理

*  将端点适配委托给MVC层策略端点(MvcEndpoint)
 *  通过端点MVC适配器(EndpointMvcAdapter)，将端点暴露为HTTP请求方式的MVC端点
 *  分别使用端点自动配置(EndpointAutoConfiguration)和MVC方式暴露端点的配置(EndpointWebMvcManagementContextConfiguration)
 *  注入端点组件和端点处理程序映射组件、MVC端点注册表组件、MVC端点组件
 *  其中，端点处理程序映射(EndpointHandlerMapping)通过SpringMVC方式来暴露MVC端点

> **以上原理参考：[Spring Boot之执行器端点(Actuator Endpoint)实现剖析][Spring Boot_Actuator Endpoint]**

使用Actuator

*  健康检查
 *  审计
 *  统计
 *  监控

## 5.4 Actuator依赖引入 ##

要实现SpringBoot应用程序启用Actuator Endpoints，需要在构建配置文件中添加`spring-boot-starter-actuator`依赖项

Pom文件添加依赖

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

使用HTTP调用

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

例如导入Actuator依赖后，想要监控或操作Actuator的所有功能，将所有的端点开放，访问`http://localhost:8080/actuator`查看暴露出来的端点

server:
      port: 8080
    management:
      endpoints:
        web:
          exposure:
            include: "*" # 暴露所有端点

[Spring Boot Actuator_ Production-ready Features]: https://docs.spring.io/spring-boot/docs/2.3.3.RELEASE/reference/html/production-ready-features.html#production-ready
[Spring Boot_Actuator Endpoint]: https://blog.csdn.net/shupili141005/article/details/61476546