微服务学习笔记（三）— Spring Boot 运行状态监控 Actuator

浅浅的花香味﹌ 2022-01-26 07:45 443阅读 0赞

Spring Boot有四大神器，分别是auto-configuration、starters、cli、actuator，本文主要讲actuator。

actuator是spring boot提供的对应用系统的自省和监控的集成功能，可以对应用系统进行配置查看、相关功能统计等。 Actuator 的监控数据可以通过阻REST 、远程shell 和JMX方式获得。本文只介绍REST方式。

**本文基于spring boot 2.0 以上版本，相对较低版本actuator变化较大，请读者注意。**

**1、开启Actuator**

在pom文件中引入Actuator的起步依赖spring-boot-starter-actuator.

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

**2、修改配置application.yml文件**

这两个配置分别配置了Actuator 对外暴露REST API 接口的端口号和Actuator 采取非安全验证方式

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0xVQ0tXWEY_size_16_color_FFFFFF_t_70][]

Spring Boot Actuator 的关键特性是在应用程序里提供众多的Web 节点，通过这些节点可以实时地了解应用程序的运行状况。有了Actuator ，你可以知道Bean 在Spring 应用程序上下文里是如何组装在一起的，并且可以获取环境属性的信息和运行时度量信息等。

spring-boot 2.0 版本当中，作为安全性考虑，将actuator 控件中的端口，只默认开放/health 和/info 两个端口，其他端口默认关闭。当你需要使用气短监控端口时，需要手动在application.properties 文件中添加配置。配置形式为 management.endpoints.web.exposure.include=xxx 开启xxx端口的访问 ， 如果去掉所有的端口访问限制，则配置形式为 management.endpoints.web.exposure.include=\*

spring-boot 2.0 版本当中还有一个变动，所有的端口 默认访问形式都是 actuator/XXX 例如actuator/health

**3、启动应用程序**

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0xVQ0tXWEY_size_16_color_FFFFFF_t_70 1][]

**4、访问测试: localhost:9002/autuator**

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0xVQ0tXWEY_size_16_color_FFFFFF_t_70 2][]

**5、监控端点说明**

<table> 
 <thead> 
  <tr> 
   <th>ID</th> 
   <th>描述</th> 
   <th>默认启用</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>auditevents</td> 
   <td>显示当前应用程序的审计事件信息</td> 
   <td>Yes</td> 
  </tr> 
  <tr> 
   <td>beans</td> 
   <td>显示一个应用中<code>所有Spring Beans</code>的完整列表</td> 
   <td>Yes</td> 
  </tr> 
  <tr> 
   <td>conditions</td> 
   <td>显示<code>配置类和自动配置类</code>(configuration and auto-configuration classes)的状态及它们被应用或未被应用的原因</td> 
   <td>Yes</td> 
  </tr> 
  <tr> 
   <td>configprops</td> 
   <td>显示一个所有<code>@ConfigurationProperties</code>的集合列表</td> 
   <td>Yes</td> 
  </tr> 
  <tr> 
   <td>env</td> 
   <td>显示来自Spring的 <code>ConfigurableEnvironment</code>的属性</td> 
   <td>Yes</td> 
  </tr> 
  <tr> 
   <td>flyway</td> 
   <td>显示数据库迁移路径，如果有的话</td> 
   <td>Yes</td> 
  </tr> 
  <tr> 
   <td>health</td> 
   <td>显示应用的<code>健康信息</code>（当使用一个未认证连接访问时显示一个简单的’status’，使用认证连接访问则显示全部信息详情）</td> 
   <td>Yes</td> 
  </tr> 
  <tr> 
   <td>info</td> 
   <td>显示任意的<code>应用信息</code></td> 
   <td>Yes</td> 
  </tr> 
  <tr> 
   <td>liquibase</td> 
   <td>展示任何Liquibase数据库迁移路径，如果有的话</td> 
   <td>Yes</td> 
  </tr> 
  <tr> 
   <td>metrics</td> 
   <td>展示当前应用的<code>metrics</code>信息</td> 
   <td>Yes</td> 
  </tr> 
  <tr> 
   <td>mappings</td> 
   <td>显示一个所有<code>@RequestMapping</code>路径的集合列表</td> 
   <td>Yes</td> 
  </tr> 
  <tr> 
   <td>scheduledtasks</td> 
   <td>显示应用程序中的<code>计划任务</code></td> 
   <td>Yes</td> 
  </tr> 
  <tr> 
   <td>sessions</td> 
   <td>允许从Spring会话支持的会话存储中检索和删除(retrieval and deletion)用户会话。使用Spring Session对反应性Web应用程序的支持时不可用。</td> 
   <td>Yes</td> 
  </tr> 
  <tr> 
   <td>shutdown</td> 
   <td>允许应用以优雅的方式关闭（默认情况下不启用）</td> 
   <td>No</td> 
  </tr> 
  <tr> 
   <td>threaddump</td> 
   <td>执行一个线程dump</td> 
   <td>Yes</td> 
  </tr> 
 </tbody> 
</table>

推荐中文翻译详细说明

[https://blog.csdn.net/alinyua/article/details/80009435][https_blog.csdn.net_alinyua_article_details_80009435]

[https://www.cnblogs.com/ityouknow/p/8423590.html][https_www.cnblogs.com_ityouknow_p_8423590.html]

（本章结束）

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0xVQ0tXWEY_size_16_color_FFFFFF_t_70]: /images/20220126/6a0a02ca303048a7bd58fbcc29e31e38.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0xVQ0tXWEY_size_16_color_FFFFFF_t_70 1]: /images/20220126/ce13858b48e844a1b892c31a89a69b3b.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0xVQ0tXWEY_size_16_color_FFFFFF_t_70 2]: /images/20220126/73af8ca294d4411d9f29b80b5126d1e2.png
[https_blog.csdn.net_alinyua_article_details_80009435]: https://blog.csdn.net/alinyua/article/details/80009435
[https_www.cnblogs.com_ityouknow_p_8423590.html]: https://www.cnblogs.com/ityouknow/p/8423590.html