Spring Boot Actuator 监控应用详解

不念不忘少年蓝@ 2023-02-13 11:09 125阅读 0赞

微服务的特点决定了功能模块的部署是分布式的，大部分功能模块都是运行在不同的机器上，彼此通过服务调用进行交互，前后台的业务流会经过很多个微服务的处理和传递，出现了异常如何快速定位是哪个环节出现了问题？

在这种框架下，微服务的监控显得尤为重要。本文主要结合 Spring Boot Actuator，跟大家一起分享微服务 Spring Boot Actuator 的常见用法，方便我们在日常中对我们的微服务进行监控治理。

# Actuator 监控 #

Spring Boot 使用“习惯优于配置的理念”，采用包扫描和自动化配置的机制来加载依赖 Jar 中的 Spring bean，不需要任何 Xml 配置，就可以实现 Spring 的所有配置。虽然这样做能让我们的代码变得非常简洁，但是整个应用的实例创建和依赖关系等信息都被离散到了各个配置类的注解上，这使得我们分析整个应用中资源和实例的各种关系变得非常的困难。

Actuator 是 Spring Boot 提供的对应用系统的自省和监控的集成功能，可以查看应用配置的详细信息，例如自动化配置信息、创建的 Spring beans 以及一些环境属性等。

为了保证 actuator 暴露的监控接口的安全性，需要添加安全控制的依赖`spring-boot-start-security`依赖，访问应用监控端点时，都需要输入验证信息。Security 依赖，可以选择不加，不进行安全管理，但不建议这么做。

# Actuator 的 REST 接口 #

Actuator 监控分成两类：原生端点和用户自定义端点；自定义端点主要是指扩展性，用户可以根据自己的实际应用，定义一些比较关心的指标，在运行期进行监控。

原生端点是在应用程序里提供众多 Web 接口，通过它们了解应用程序运行时的内部状况。原生端点又可以分成三类：

*  应用配置类：可以查看应用在运行期的静态信息：例如自动配置信息、加载的 springbean 信息、yml 文件配置信息、环境信息、请求映射信息；
 *  度量指标类：主要是运行期的动态信息，例如堆栈、请求连、一些健康指标、metrics 信息等；
 *  操作控制类：主要是指 shutdown,用户可以发送一个请求将应用的监控功能关闭。

Actuator 提供了 13 个接口，具体如下表所示。

**默认情况下除了`shutdown`是关闭的，其它端点都是启用的。**

<table> 
 <thead> 
  <tr> 
   <th>HTTP 方法</th> 
   <th>路径</th> 
   <th>描述</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>GET</td> 
   <td>/auditevents</td> 
   <td>显示应用暴露的审计事件 (比如认证进入、订单失败)</td> 
  </tr> 
  <tr> 
   <td>GET</td> 
   <td>/beans</td> 
   <td>描述应用程序上下文里全部的 Bean，以及它们的关系</td> 
  </tr> 
  <tr> 
   <td>GET</td> 
   <td>/conditions</td> 
   <td>就是 1.0 的 /autoconfig ，提供一份自动配置生效的条件情况，记录哪些自动配置条件通过了，哪些没通过</td> 
  </tr> 
  <tr> 
   <td>GET</td> 
   <td>/configprops</td> 
   <td>描述配置属性(包含默认值)如何注入Bean</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>/flyway</td> 
   <td>提供一份 Flyway 数据库迁移信息</td> 
  </tr> 
  <tr> 
   <td>GET</td> 
   <td>/liquidbase</td> 
   <td>显示Liquibase 数据库迁移的纤细信息</td> 
  </tr> 
  <tr> 
   <td>GET</td> 
   <td>/health</td> 
   <td>报告应用程序的健康指标，这些值由 HealthIndicator 的实现类提供</td> 
  </tr> 
  <tr> 
   <td>GET</td> 
   <td>/heapdump</td> 
   <td>dump 一份应用的 JVM 堆信息</td> 
  </tr> 
  <tr> 
   <td>GET</td> 
   <td>/httptrace</td> 
   <td>显示HTTP足迹，最近100个HTTP request/repsponse</td> 
  </tr> 
  <tr> 
   <td>GET</td> 
   <td>/info</td> 
   <td>获取应用程序的定制信息，这些信息由info打头的属性提供</td> 
  </tr> 
  <tr> 
   <td>GET</td> 
   <td>/logfile</td> 
   <td>返回log file中的内容(如果 logging.file 或者 logging.path 被设置)</td> 
  </tr> 
  <tr> 
   <td>GET</td> 
   <td>/loggers</td> 
   <td>显示和修改配置的loggers</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>GET</td> 
   <td>/scheduledtasks</td> 
   <td>展示应用中的定时任务信息</td> 
  </tr> 
  <tr> 
   <td>GET</td> 
   <td>/sessions</td> 
   <td>如果我们使用了 Spring Session 展示应用中的 HTTP sessions 信息</td> 
  </tr> 
  <tr> 
   <td><strong><span style="color:#f33b45;">POST</span></strong></td> 
   <td><strong><span style="color:#f33b45;">/shutdown</span></strong></td> 
   <td><strong><span style="color:#f33b45;">关闭应用程序，要求endpoints.shutdown.enabled设置为true</span></strong></td> 
  </tr> 
  <tr> 
   <td>GET</td> 
   <td>/mappings</td> 
   <td>描述全部的 URI路径，以及它们和控制器(包含Actuator端点)的映射关系</td> 
  </tr> 
  <tr> 
   <td>GET</td> 
   <td>/threaddump</td> 
   <td>获取线程活动的快照</td> 
  </tr> 
 </tbody> 
</table>

# 快速上手 #

### 相关配置 ###

**项目依赖**

<dependencies>
      <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>
    </dependencies>

**配置文件**

info.app.name=spring-boot-actuator
    info.app.version= 1.0.0
    info.app.test=test
    
    management.endpoints.web.exposure.include=*
    management.endpoint.health.show-details=always
    #management.endpoints.web.base-path=/monitor
    
    management.endpoint.shutdown.enabled=true

*  `management.endpoints.web.base-path=/monitor` 代表启用单独的url地址来监控 Spring Boot 应用，为了安全一般都启用独立的端口来访问后端的监控信息
 *  `management.endpoint.shutdown.enabled=true` 启用接口关闭 Spring Boot

配置完成之后，启动项目就可以继续验证各个监控功能了。

# 使用 #

### 启用与关闭 ###

**默认情况下，除 `shutdown` 以外的所有端点均已启用。**  
**注意，这里仅仅是开启支持，并不是暴露为Web端点，端点必须暴露为Web端点才能被访问。**

个别端点的启用依赖其他组件，比如我们上篇文章介绍的Prometheus。

**我们可以在Spring Boot 配置文件中通过配置（id参见上表）`management.endpoint.<id>.enabled`来配置端点是否启用。**

**另外我们可以通过`management.endpoints.enabled-by-default`来修改全局端口默认配置,以下示例启用info端点并禁用所有其他端点：**

# 先设置所有的端点默认为关闭
    management.endpoints.enabled-by-default=false
    # 然后开启info 端点
    management.endpoint.info.enabled=true

### 开放与封闭 ###

特别需要我们注意的是，以上只是我们开启的端点功能，并不意味我们把这些端点暴露给应用之外的环境中去。暴露的配置规则是 `management.endpoints.<web|jmx>.exposure.<include|exclude>`我们以web为例，通过以下方式来暴露web端点：

#  * 为暴露所有web端点，如果暴露的是一个列表请使用端点 id 并以逗号隔开 
    management.endpoints.web.exposure.include='*'

同样的如果我们要排除一些web端点请用 `management.endpoints.web.exposure.exclude`来配置。我们可以通过`/actuator`来列举暴露的端点。当然这个路径取决于我们对`management.endpoints.web.basePath`的配置。

### 安全性 ###

对于生产环境来说端点都是敏感的。我们当然不希望非法的访问端点，特别如`/shutdown`这种端点。我们可以通过上面3.1、3.2进行关闭、封闭操作。也可直接配置`management.server.port=-1` 来关闭管理端点。或者确保在外面的安全框架诸如Spring security的控制之下。即保证 `EndpointRequest.toAnyEndpoint()`的安全性。

# 命令详解 #

在 Spring Boot 2.x 中为了安全期间，Actuator 只开放了两个端点 `/actuator/health` 和 `/actuator/info`。可以在配置文件中设置打开。

可以打开所有的监控点

management.endpoints.web.exposure.include=*

也可以选择打开部分

management.endpoints.web.exposure.exclude=beans,trace

Actuator 默认所有的监控点路径都在`/actuator/*`，当然如果有需要这个路径也支持定制。

management.endpoints.web.base-path=/manage

设置完重启后，再次访问地址就会变成`/manage/*`

Actuator 几乎监控了应用涉及的方方面面，我们重点讲述一些经常在项目中常用的命令。

### health ###

health 主要用来检查应用的运行状态，这是我们使用最高频的一个监控点。通常使用此接口提醒我们应用实例的运行状态，以及应用不”健康“的原因，比如数据库连接、磁盘空间不够等。

默认情况下 health 的状态是开放的，添加依赖后启动项目，访问：`http://localhost:8080/actuator/health`即可看到应用的状态。

{
        "status" : "UP"
    }

默认情况下，最终的 Spring Boot 应用的状态是由 HealthAggregator 汇总而成的，汇总的算法是：

*  1 设置状态码顺序：`setStatusOrder(Status.DOWN, Status.OUT_OF_SERVICE, Status.UP, Status.UNKNOWN);`。
 *  2 过滤掉不能识别的状态码。
 *  3 如果无任何状态码，整个 Spring Boot 应用的状态是 UNKNOWN。
 *  4 将所有收集到的状态码按照 1 中的顺序排序。
 *  5 返回有序状态码序列中的第一个状态码，作为整个 Spring Boot 应用的状态。

health 通过合并几个健康指数检查应用的健康情况。Spring Boot Actuator 有几个预定义的健康指标比如`DataSourceHealthIndicator`, `DiskSpaceHealthIndicator`, `MongoHealthIndicator`, `RedisHealthIndicator`等，它使用这些健康指标作为健康检查的一部分。

举个例子，如果你的应用使用 Redis，`RedisHealthindicator` 将被当作检查的一部分；如果使用 MongoDB，那么`MongoHealthIndicator` 将被当作检查的一部分。

可以在配置文件中关闭特定的健康检查指标，比如关闭 redis 的健康检查：

management.health.redise.enabled=false

默认，所有的这些健康指标被当作健康检查的一部分。

### info ###

info 就是我们自己配置在配置文件中以 info 开头的配置信息，比如我们在示例项目中的配置是：

info.app.name=spring-boot-actuator
    info.app.version= 1.0.0
    info.app.test= test

启动示例项目，访问：`http://localhost:8080/actuator/info`返回部分信息如下：

{
      "app": {
        "name": "spring-boot-actuator",
        "version": "1.0.0",
        "test":"test"
      }
    }

### beans ###

根据示例就可以看出，展示了 bean 的别名、类型、是否单例、类的地址、依赖等信息。

启动示例项目，访问：`http://localhost:8080/actuator/beans`返回部分信息如下：

[
      {
        "context": "application:8080:management",
        "parent": "application:8080",
        "beans": [
          {
            "bean": "embeddedServletContainerFactory",
            "aliases": [
              
            ],
            "scope": "singleton",
            "type": "org.springframework.boot.context.embedded.tomcat.TomcatEmbeddedServletContainerFactory",
            "resource": "null",
            "dependencies": [
              
            ]
          },
          {
            "bean": "endpointWebMvcChildContextConfiguration",
            "aliases": [
              
            ],
            "scope": "singleton",
            "type": "org.springframework.boot.actuate.autoconfigure.EndpointWebMvcChildContextConfiguration$$EnhancerBySpringCGLIB$$a4a10f9d",
            "resource": "null",
            "dependencies": [
              
            ]
          }
      }
    ]

### conditions ###

Spring Boot 的自动配置功能非常便利，但有时候也意味着出问题比较难找出具体的原因。使用 conditions 可以在应用运行时查看代码了某个配置在什么条件下生效，或者某个自动配置为什么没有生效。

启动示例项目，访问：`http://localhost:8080/actuator/conditions`返回部分信息如下：

{
        "positiveMatches": {
         "DevToolsDataSourceAutoConfiguration": {
                "notMatched": [
                    {
                        "condition": "DevToolsDataSourceAutoConfiguration.DevToolsDataSourceCondition", 
                        "message": "DevTools DataSource Condition did not find a single DataSource bean"
                    }
                ], 
                "matched": [ ]
            }, 
            "RemoteDevToolsAutoConfiguration": {
                "notMatched": [
                    {
                        "condition": "OnPropertyCondition", 
                        "message": "@ConditionalOnProperty (spring.devtools.remote.secret) did not find property 'secret'"
                    }
                ], 
                "matched": [
                    {
                        "condition": "OnClassCondition", 
                        "message": "@ConditionalOnClass found required classes 'javax.servlet.Filter', 'org.springframework.http.server.ServerHttpRequest'; @ConditionalOnMissingClass did not find unwanted class"
                    }
                ]
            }
        }
    }

### heapdump ###

返回一个 GZip 压缩的 JVM 堆 dump

启动示例项目，访问：`http://localhost:8080/actuator/heapdump`会自动生成一个 Jvm 的堆文件 heapdump，我们可以使用 JDK 自带的 Jvm 监控工具 VisualVM 打开此文件查看内存快照。类似如下图：

![format_png][]

### shutdown ###

开启接口优雅关闭 Spring Boot 应用，要使用这个功能首先需要在配置文件中开启：

management.endpoint.shutdown.enabled=true

配置完成之后，启动示例项目，使用 curl 模拟 post 请求访问 shutdown 接口。

> shutdown 接口默认只支持 post 请求。

curl -X POST "http://localhost:8080/actuator/shutdown" 
    {
        "message": "Shutting down, bye..."
    }

此时你会发现应用已经被关闭。

### mappings ###

描述全部的 URI 路径，以及它们和控制器的映射关系

启动示例项目，访问：`http://localhost:8080/actuator/mappings`返回部分信息如下：

{
      "/**/favicon.ico": {
        "bean": "faviconHandlerMapping"
      },
      "{[/hello]}": {
        "bean": "requestMappingHandlerMapping",
        "method": "public java.lang.String com.neo.controller.HelloController.index()"
      },
      "{[/error]}": {
        "bean": "requestMappingHandlerMapping",
        "method": "public org.springframework.http.ResponseEntity<java.util.Map<java.lang.String, java.lang.Object>> org.springframework.boot.autoconfigure.web.BasicErrorController.error(javax.servlet.http.HttpServletRequest)"
      }
    }

### threaddump ###

/threaddump 接口会生成当前线程活动的快照。这个功能非常好，方便我们在日常定位问题的时候查看线程的情况。 主要展示了线程名、线程ID、线程的状态、是否等待锁资源等信息。

启动示例项目，访问：`http://localhost:8080/actuator/threaddump`返回部分信息如下：

[
      {
        "threadName": "http-nio-8088-exec-6",
        "threadId": 49,
        "blockedTime": -1,
        "blockedCount": 0,
        "waitedTime": -1,
        "waitedCount": 2,
        "lockName": "java.util.concurrent.locks.AbstractQueuedSynchronizer$ConditionObject@1630a501",
        "lockOwnerId": -1,
        "lockOwnerName": null,
        "inNative": false,
        "suspended": false,
        "threadState": "WAITING",
        "stackTrace": [
          {
            "methodName": "park",
            "fileName": "Unsafe.java",
            "lineNumber": -2,
            "className": "sun.misc.Unsafe",
            "nativeMethod": true
          },
          ...
          {
            "methodName": "run",
            "fileName": "TaskThread.java",
            "lineNumber": 61,
            "className": "org.apache.tomcat.util.threads.TaskThread$WrappingRunnable",
            "nativeMethod": false
          }
          ...
        ],
        "lockInfo": {
          "className": "java.util.concurrent.locks.AbstractQueuedSynchronizer$ConditionObject",
          "identityHashCode": 372286721
        }
      }
      ...
    ]

生产出现问题的时候，可以通过应用的线程快照来检测应用正在执行的任务。

> 文章内容已经升级到 Spring Boot 2.x

**[示例代码-github][-github]**

**[示例代码-码云][-]**

**转自：**

[http://www.ityouknow.com/springboot/2018/02/06/spring-boot-actuator.html][http_www.ityouknow.com_springboot_2018_02_06_spring-boot-actuator.html]

[https://juejin.im/post/5d78afa951882505e029c57e][https_juejin.im_post_5d78afa951882505e029c57e]

[format_png]: https://imgconvert.csdnimg.cn/aHR0cDovL2Zhdm9yaXRlcy5yZW4vYXNzZXRzL2ltYWdlcy8yMDE4L3NwcmluZ2Jvb3QvaGVhcGR1bXAucG5n?x-oss-process=image/format,png
[-github]: https://github.com/ityouknow/spring-boot-examples/tree/master/spring-boot-actuator
[-]: https://gitee.com/ityouknow/spring-boot-examples/tree/master/spring-boot-actuator
[http_www.ityouknow.com_springboot_2018_02_06_spring-boot-actuator.html]: http://www.ityouknow.com/springboot/2018/02/06/spring-boot-actuator.html
[https_juejin.im_post_5d78afa951882505e029c57e]: https://juejin.im/post/5d78afa951882505e029c57e