spring-boot-route（十八）spring-boot-adtuator监控应用

Spring Boot提供了良好的服务监控模块，只需要通过简单的配置便可以完成服务监控和管理。但是服务监控这块内容往往是最容易被忽略的一块内容，今天我们一起来学习一下使用spring-boot-actuator进行服务监控。spring-boot-actuator提供了监控端点，这些端点直接返回JSON字符串，通过这些端点可以查询服务运行状况，为了防止端点直接暴露，一般情况下会使用安全框架，如Spring Security来管理这些端点的安全性。

一 常用的端点

端点地址	描述	默认启用
auditevents	获取当前应用暴露的审计事件信息	是
beans	获取应用中所有的bean的完整关系列表	是
caches	获取公开可以用的缓存	是
conditions	获取自动配置条件信息，记录哪些自动配置条件通过和没通过的原因	是
configprops	获取所有配置属性，包括默认配置，显示一个所有 @ConfigurationProperties 的整理列版本	是
env	获取所有环境变量	是
flyway	获取已应用的所有Flyway数据库迁移信息，需要一个或多个 Flyway Bean	是
health	获取应用程序健康指标（运行状况信息）	是
httptrace	获取HTTP跟踪信息（默认情况下，最近100个HTTP请求-响应交换）。需要 HttpTraceRepository Bean	是
info	获取应用程序信息	是
integrationgraph	显示 Spring Integration 图。需要依赖 spring-integration-core	是
loggers	显示和修改应用程序中日志的配置	是
liquibase	获取应用的所有Liquibase数据库迁移。需要一个或多个 Liquibase Bean	是
metrics	获取系统度量指标信息	是
mappings	显示所有@RequestMapping路径的整理列表	是
scheduledtasks	显示应用程序中的计划任务	是
sessions	允许从Spring Session支持的会话存储中检索和删除用户会话。需要使用Spring Session的基于Servlet的Web应用程序	是
shutdown	关闭应用	否
threaddump	获取系统线程转储信息	是

默认情况下，除了shutdown，其他端点都是启动状态。

1.1 如何使用

在项目中引入spring-boot-actuator的依赖，就可以正常使用了

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

1.2 如何访问

/actuator+端点地址

例如想要访问health端点，则访问http://ip:port/actuator/health；

1.3 端点开启/关闭

management:
  endpoint:
      # 开启shutdown端点
    shutdown:
      enabled: true

启用/禁用所有端点

management:
  endpoints:
    enabled-by-default: true

1.4 端点暴露

默认情况下，只有health和info暴露了http端口，这些端点支持通过http和JMX访问，如果需要访问具体的端点则需要配置暴露。

暴露http端点

management:
  endpoints:
    web:
      exposure:
        include: health,info

暴露JMX端点

management:
  endpoints:
    jmx:
      exposure:
        include: health,info

二 常用端点解析

2.1 health

health包含的健康检查项有DataSourceHealthIndicator，DiskSpaceHealthIndicator，MongoHealthIndicator，ReidsHealthIndicator，CassandraHealthIndicator。

关闭特定的检查项配置如下，关闭redis检查项：

management:
  health:
    redis:
      enabled: false

默认情况下health只是简单的展示了UP和DOWN两种状态，如果想要看详细信息，则需要配置

management:
  endpoint:
    health:
      show-details: always

2.2 metrics

metrics可以使用带PathVariable参数，参数为具体的度量值，如查看cpu大小，http://localhost:8080/actuato...

2.3 info

info使用的时候需要在配置文件中自定义信息，自定义信息以info开头。

例如在配置文件中增加如下内容：

info:
  person:
    name: Java旅途
    age: 18

访问info端点显示的是去掉info的一个JSON串：

person:
  name: Java旅途
  age: 18

Spring-Boot-acturator使用起来很方便，但是缺点也很明显，就是没有图形化界面。使用起来也不是很友好，下一章中，我们将使用有图形化的Spring-Boot-Admin来进行服务监控。

---

本文示例代码已上传至github，点个star支持一下！

Spring Boot系列教程目录

spring-boot-route（一）Controller接收参数的几种方式

spring-boot-route（二）读取配置文件的几种方式

spring-boot-route（三）实现多文件上传

spring-boot-route（四）全局异常处理

spring-boot-route（五）整合swagger生成接口文档

spring-boot-route（六）整合JApiDocs生成接口文档

spring-boot-route（七）整合jdbcTemplate操作数据库

spring-boot-route（八）整合mybatis操作数据库

spring-boot-route（九）整合JPA操作数据库

spring-boot-route（十）多数据源切换

spring-boot-route（十一）数据库配置信息加密

spring-boot-route（十二）整合redis做为缓存

spring-boot-route（十三）整合RabbitMQ

spring-boot-route（十四）整合Kafka

spring-boot-route（十五）整合RocketMQ

spring-boot-route（十六）使用logback生产日志文件

spring-boot-route（十七）使用aop记录操作日志

spring-boot-route（十八）spring-boot-adtuator监控应用

spring-boot-route（十九）spring-boot-admin监控服务

spring-boot-route（二十）Spring Task实现简单定时任务

spring-boot-route（二十一）quartz实现动态定时任务

spring-boot-route（二十二）实现邮件发送功能

spring-boot-route（二十三）开发微信公众号

spring-boot-route（二十四）分布式session的一致性处理

spring-boot-route（二十五）两行代码实现国际化

spring-boot-route（二十六）整合webSocket

这个系列的文章都是工作中频繁用到的知识，学完这个系列，应付日常开发绰绰有余。如果还想了解其他内容，扫面下方二维码告诉我，我会进一步完善这个系列的文章！