应用监控之 SpringBoot Actuator 使用及配置

水深无声 2023-07-24 02:55 283阅读 0赞

# 前言 #

1.  一般JavaWeb应用都需要被管理以及监控，比如：查看应用所占的内存，还有查看应用的运行状态等等，这样做的目的就是对应用进行实时监控，避免应用出现问题了都无从查起。
2.  我们都知道SpringBoot最牛的地方就是快速整合第三方技术，让我们能够快速开发，避免一些繁琐的配置。所有在SpringBoot中，也集成了监控功能的插件，就是**SpringBoot Actuator**。

# SpringBoot Actuator简介 #

1.  Actuator是SpringBoot项目中一个非常强大一个功能，有助于对应用程序进行监视和管理，通过restful api请求来监管、审计、收集应用的运行情况。
2.  Actuator的核心是端点Endpoint，它用来监视应用程序及交互，spring-boot-actuator中已经内置了非常多的Endpoint（health、info、beans、metrics、httptrace、shutdown等等），同时也允许我们自己扩展自己的Endpoints。
3.  每个Endpoint都可以启用和禁用。要远程访问Endpoint，还必须通过JMX或HTTP进行暴露，大部分应用选择HTTP，Endpoint 的ID默认映射到一个带/actuator前缀的URL。例如，health端点默认映射到/actuator/health。

# Endpoint端点介绍 #

Actuator的核心就是Endpoint，每一个Endpoint都代表着监控某一项数据。

<table> 
 <thead> 
  <tr> 
   <th>端点</th> 
   <th>描述</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>auditevents</td> 
   <td>获取当前应用暴露的审计事件信息</td> 
  </tr> 
  <tr> 
   <td>beans</td> 
   <td>获取应用中所有的 Spring Beans 的完整关系列表</td> 
  </tr> 
  <tr> 
   <td>caches</td> 
   <td>获取公开可以用的缓存</td> 
  </tr> 
  <tr> 
   <td>conditions</td> 
   <td>获取自动配置条件信息，记录哪些自动配置条件通过和没通过的原因</td> 
  </tr> 
  <tr> 
   <td>configprops</td> 
   <td>获取所有配置属性，包括默认配置，显示一个所有 @ConfigurationProperties 的整理列版本</td> 
  </tr> 
  <tr> 
   <td>env</td> 
   <td>获取所有环境变量</td> 
  </tr> 
  <tr> 
   <td>flyway</td> 
   <td>获取已应用的所有Flyway数据库迁移信息，需要一个或多个 Flyway Bean</td> 
  </tr> 
  <tr> 
   <td>liquibase</td> 
   <td>获取已应用的所有Liquibase数据库迁移。需要一个或多个 Liquibase Bean</td> 
  </tr> 
  <tr> 
   <td>health</td> 
   <td>获取应用程序健康指标（运行状况信息）</td> 
  </tr> 
  <tr> 
   <td>httptrace</td> 
   <td>获取HTTP跟踪信息（默认情况下，最近100个HTTP请求-响应交换）。需要 HttpTraceRepository Bean</td> 
  </tr> 
  <tr> 
   <td>info</td> 
   <td>获取应用程序信息</td> 
  </tr> 
  <tr> 
   <td>integrationgraph</td> 
   <td>显示 Spring Integration 图。需要依赖 spring-integration-core</td> 
  </tr> 
  <tr> 
   <td>loggers</td> 
   <td>显示和修改应用程序中日志的配置</td> 
  </tr> 
  <tr> 
   <td>logfile</td> 
   <td>返回日志文件的内容（如果已设置logging.file.name或logging.file.path属性）</td> 
  </tr> 
  <tr> 
   <td>metrics</td> 
   <td>获取系统度量指标信息</td> 
  </tr> 
  <tr> 
   <td>mappings</td> 
   <td>显示所有@RequestMapping路径的整理列表</td> 
  </tr> 
  <tr> 
   <td>scheduledtasks</td> 
   <td>显示应用程序中的计划任务</td> 
  </tr> 
  <tr> 
   <td>sessions</td> 
   <td>允许从Spring Session支持的会话存储中检索和删除用户会话。需要使用Spring Session的基于Servlet的Web应用程序</td> 
  </tr> 
  <tr> 
   <td>shutdown</td> 
   <td>关闭应用，要求endpoints.shutdown.enabled设置为true，默认为 false</td> 
  </tr> 
  <tr> 
   <td>threaddump</td> 
   <td>获取系统线程转储信息</td> 
  </tr> 
  <tr> 
   <td>heapdump</td> 
   <td>返回hprof堆转储文件</td> 
  </tr> 
  <tr> 
   <td>jolokia</td> 
   <td>通过HTTP公开JMX bean（当Jolokia在类路径上时，不适用于WebFlux）。需要依赖 jolokia-core</td> 
  </tr> 
  <tr> 
   <td>prometheus</td> 
   <td>以Prometheus服务器可以抓取的格式公开指标。需要依赖 micrometer-registry-prometheus</td> 
  </tr> 
 </tbody> 
</table>

# SpringBoot Actuator使用及配置 #

1.  上面介绍了Actuator以及Endpoint，接下来就开始使用它，只需要引入下面启动器依赖就可以使用Actuator了。
    
        <dependency>
        	<groupId>org.springframework.boot</groupId>
        	<artifactId>spring-boot-starter-web</artifactId>
        </dependency>
        
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-actuator</artifactId>
        </dependency>
2.  在SpringBoot2.X中，Actuator 默认只开放 health 和 info 两个端点。我们先不做任何配置，直接启动SpringBoot项目，然后在浏览器输入：**http://localhost:8080/actuator**查看默认开放的端点，如下图所示：  
    ![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NDE3NjE2OQ_size_16_color_FFFFFF_t_70]
3.  我们可以看到端点的访问地址都是以\*\*/actuator\*\*为前缀，这是SpringBoot默认设置的地址，我们可以在配置文件中修改，如下配置：
    
        management:
          endpoints:
            web:
              base-path: /myActuator
    
    ![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NDE3NjE2OQ_size_16_color_FFFFFF_t_70 1]
4.  恢复默认的访问路径，然后在浏览器上访问**http://localhost:8080/actuator/health**，如果出现**UP**表示应用程序正常运行。  
    ![在这里插入图片描述][2020040912211752.png]
5.  接下来暴露所有的端点Endpoint，如下配置：
    
        management:
        	  endpoints:
        	    web:
        	      base-path: /actuator #配置端点访问前缀
        	      exposure:
        	        include: '*' #暴露所有端点
    
    ![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NDE3NjE2OQ_size_16_color_FFFFFF_t_70 2]
6.  当然也可以禁用所有端点，如下配置：
    
        management:
          endpoints:
            web:
              base-path: /actuator #配置端点访问前缀
              exposure:
                include: '*' #暴露所有端点
            enabled-by-default: false #禁用所有端点
    
    ![在这里插入图片描述][20200409133812157.png]
7.  关闭所有端点之后，可以指定暴露某个端点，如下配置：
    
        management:
          endpoints:
            web:
              base-path: /actuator #配置端点访问前缀
              exposure:
                include: '*' #暴露所有端点
            enabled-by-default: false #禁用所有端点
          endpoint:
            info:
              enabled: true #上面关闭所有端点之后，又暴露指定的端点，这里暴露info端点
8.  还可以指定不暴露某个端点，下面首先暴露所有端点，然后又指定不暴露：**info**，**beans**，**env**这三个端点。
    
        management:
          endpoints:
            web:
              base-path: /actuator #配置端点访问前缀
              exposure:
                include: '*'  #暴露所有端点
                exclude: info,beans,env #在暴露所有端点的前提下，可以排除某个端点(不暴露)

# 详细介绍Endpoint #

上面介绍了Actuator的使用，以及端点Endpoint的配置(暴露与不暴露)，接下来再详细介绍常用的Endpoint。

### health ###

1.  **health**主要用来检测应用的运行状况，是使用最多的一个监控点。
2.  监控软件通常使用该接口实时监测应用运行状况，在系统出现故障时把报警信息推送给相关人员，如磁盘空间使用情况、数据库和缓存等的一些健康指标。
3.  默认情况下health端点是开放的，访问**http://127.0.0.1:8080/actuator/health**即可看到应用运行状态。
4.  如果应用程序正常时，默认访问会显示：\{“status”:“UP”\}。如果需要更详细的信息，需要配置如下内容：
    
        management:
          endpoint:
            health:
              show-details: always
    
    ![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NDE3NjE2OQ_size_16_color_FFFFFF_t_70 3]

### info ###

查看应用信息是否在配置文件中配置。如我们在项目中配置是：

info:
      app:
        name: SpringBoot Actuator
        version: v1.0.0
        description: this is a SpringBoot Actuator Project

![在这里插入图片描述][20200409140613651.png]

### env ###

1.  通过 env 可以获取到所有关于当前 SpringBoot 应用程序的运行环境信息，如：操作系统信息（systemProperties）、环境变量信息、JDK 版本及 ClassPath 信息、当前启用的配置文件（activeProfiles）、propertySources、应用程序配置信息（applicationConfig）等。
2.  可以通过**http://127.0.0.1:8080/actuator/env/\{name\}**，name表示想要查看的信息，可以独立显示。  
    ![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NDE3NjE2OQ_size_16_color_FFFFFF_t_70 4]

### beans ###

1.  **beans**显示应用程序启动之后，SpringIOC容器注册了哪些Bean。
2.  主要展示了 bean 的别名、类型、是否单例、类的地址、依赖等信息。  
    ![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NDE3NjE2OQ_size_16_color_FFFFFF_t_70 5]

# 总结 #

1.  上面几种是比较常用的Endpoint，其他的Endpoint可以点击链接进行查看。附上官方说明文档：  
    [https://docs.spring.io/spring-boot/docs/2.2.1.RELEASE/reference/html/production-ready-features.html][https_docs.spring.io_spring-boot_docs_2.2.1.RELEASE_reference_html_production-ready-features.html]
2.  此篇博客也为下面一篇博客打基础。  
    [SpringBoot2.X监控和管理神器：SpringBoot Admin][SpringBoot2.X_SpringBoot Admin]
3.  [本篇博客源代码][Link 1]

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NDE3NjE2OQ_size_16_color_FFFFFF_t_70]: /images/20230528/1b9c0edae8764efb983e34c418ce775a.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NDE3NjE2OQ_size_16_color_FFFFFF_t_70 1]: /images/20230528/8c586b3b419449c1925cc7ce804ea4c8.png
[2020040912211752.png]: /images/20230528/152ed612053d436bb6cdef6c1df2878a.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NDE3NjE2OQ_size_16_color_FFFFFF_t_70 2]: /images/20230528/d07738a1392c4b319336991296e7d247.png
[20200409133812157.png]: /images/20230528/cbfac3c500fe44b794c6fdf6249dea63.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NDE3NjE2OQ_size_16_color_FFFFFF_t_70 3]: /images/20230528/f17ace86811b46e7816db1d385df7639.png
[20200409140613651.png]: /images/20230528/40d1e35aed26494bb8a5965684c43162.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NDE3NjE2OQ_size_16_color_FFFFFF_t_70 4]: /images/20230528/fadb970670484333a10163795fcbdf91.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NDE3NjE2OQ_size_16_color_FFFFFF_t_70 5]: /images/20230528/0944d210b1e5489e988b8b152ab4e052.png
[https_docs.spring.io_spring-boot_docs_2.2.1.RELEASE_reference_html_production-ready-features.html]: https://docs.spring.io/spring-boot/docs/2.2.1.RELEASE/reference/html/production-ready-features.html
[SpringBoot2.X_SpringBoot Admin]: https://blog.csdn.net/weixin_44176169/article/details/105400526
[Link 1]: https://github.com/ZhengWenQi98/SpringBoot