springboot(十)-监控应用

时间：2021-05-12 00:23:59

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

在这种框架下，微服务的监控显得尤为重要。本文主要结合 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 接口

Spring Boot Actuator提供了很多监控端点。可使用http://{ip}:{port}/{endpoint}的形式访问这些端点，从而了解应用程序的运行状况。

Actuator提供的端点如下：

端点 描述 http方法 是否敏感
autoconfig 显示自动配置的信息 GET 是
beans　 显示应用程序上下文所有的Spring bean  GET 是
configprops 显示所有@ConfigurationProperties的配置属性列表 GET 是
dump 显示线程活动的快照 GET 是
env 显示应用的环境变量 GET 是
health

显示应用程序的健康指标，这些值由HealthIndicator的实现类提供。当应用开启安全保护时，对于未经用户认证的请求，只会显示简单的状态；

如已认证，则会展示健康详情。

 GET 否
info 显示应用的信息，可使用info.*属性自定义info端点公开的数据 GET 否
mappings 显示所有@RequestMapping的路径列表 GET 是
metrics 显示应用的度量标准信息 GET 是
shutdown 关闭应用（默认情况下不启用，如需启用，需设置end-point.shutdown.enabled=true） POST 是
trace 显示跟踪信息（默认情况下为最近100个HTTP请求） GET 是

相关配置

项目依赖

<dependency>

      <groupId>org.springframework.boot</groupId>

      <artifactId>spring-boot-starter-actuator</artifactId>

  </dependency>

配置文件

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.exposure.include=*代表打开所有的监控点
  • management.endpoints.web.base-path=/monitor 代表启用单独的url地址来监控 Spring Boot 应用，为了安全一般都启用独立的端口来访问后端的监控信息
  • management.endpoint.shutdown.enabled=true 启用接口关闭 Spring Boot

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

命令详解

在 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

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

shutdown

上表中所有的端点除了shutdown都是GET请求方式，那shutdown的post请求方式也无妨。

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

management.endpoint.shutdown.enabled=true

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

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

curl -X POST "http://localhost:8080/actuator/shutdown"

{

    "message": "Shutting down, bye..."

}

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

相关文章