Spring Boot 整合 spring-boot-actuator 实现监控应用

Spring Boot提供了良好的服务监控模块，只需要通过简单的配置便可以完成服务监控和管理。但是服务监控这块内容往往是最容易被忽略的一块内容，今天我们一起来学习一下使用spring-boot-actuator进行服务监控。

spring-boot-actuator提供了监控端点，这些端点直接返回JSON字符串，通过这些端点可以查询服务运行状况，为了防止端点直接暴露，一般情况下会使用安全框架，如Spring Security来管理这些端点的安全性。

一、常用的端点

默认情况下，除了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/actuator/metrics/system.cpu.count；

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：

• Github：https://github.com/binzh303/spring-boot-route/

如果您觉得本文不错，欢迎 Star 支持！