Microsoft Word - 朱晔和你聊Spring系列S1E7：简单好用的Spring Boot Actuator.docx

Size: px

Start display at page:

Download "Microsoft Word - 朱晔和你聊Spring系列S1E7：简单好用的Spring Boot Actuator.docx"

徘戚
5 years ago
Views:

1 朱晔和你聊 Spring 系列 S1E7: 简单好用的 Spring Boot Actuator 本文会来看一下 Spring Boot Actuator 提供给我们的监控端点 Endpoint 健康检查 Health 和打点指标 Metrics 等所谓的 Production-ready( 生产环境必要的一些 ) 功能监控端点我们先来新建一个模块 : <?xml version="1.0" encoding="utf-8"?> <project xmlns=" xmlns:xsi=" xsi:schemalocation=" <modelversion>4.0.0</modelversion> <groupid>me.josephzhu</groupid> <artifactid>spring101-ops</artifactid> <version>0.0.1-snapshot</version> <packaging>jar</packaging> <name>spring101-ops</name> <description>demo project for Spring Boot</description> <parent> <groupid>me.josephzhu</groupid> <artifactid>spring101</artifactid>

2 <version>0.0.1-snapshot</version> </parent> <dependencies> <dependency> <groupid>org.springframework.boot</groupid> <artifactid>spring-boot-starter-web</artifactid> </dependency> <dependency> <groupid>org.springframework.boot</groupid> <artifactid>spring-boot-starter-data-redis</artifactid> </dependency> <dependency> <groupid>org.springframework.boot</groupid> <artifactid>spring-boot-starter-actuator</artifactid> </dependency> </dependencies> </project> 引入了必要的 actuator 和 web 启动器, 此外, 还引入了 data-redis 启动器用于测试一些功能然后创建主程序 : package me.josephzhu.spring101ops; import org.springframework.boot.springapplication; import org.springframework.boot.autoconfigure.springbootapplication; import org.springframework.boot.web.client.resttemplatebuilder; import org.springframework.context.annotation.bean; import org.springframework.context.annotation.configuration; import

3 @Configuration public class Spring101OpsApplication { public static void main(string[] args) { SpringApplication.run(Spring101OpsApplication.class, RestTemplate resttemplate(resttemplatebuilder builder){ return builder.build(); 创建一个测试 Controller: package me.josephzhu.spring101ops; import io.micrometer.core.instrument.meterregistry; import org.springframework.beans.factory.annotation.autowired; import org.springframework.data.redis.core.stringredistemplate; import org.springframework.web.bind.annotation.getmapping; import org.springframework.web.bind.annotation.requestmapping; import org.springframework.web.bind.annotation.requestparam; import org.springframework.web.bind.annotation.restcontroller; import java.util.list; import java.util.stream.collectors; public class MyController

4 StringRedisTemplate public List<MyItem> = "count",defaultvalue = "10") int count){ stringredistemplate.opsforvalue().set("testkey", "value" + count); return IntStream.rangeClosed(1,count).mapToObj(i->new MyItem("name" + i,i)).collect(collectors.tolist()); 这里有用到一个 MyItem: package me.josephzhu.spring101ops; import lombok.allargsconstructor; public class MyItem { private String name; private Integer price; 最后配置一下 application.properties: management.server.port=8081 management.endpoints.web.exposure.include=* management.endpoint.health.show-details=always 这里做了几个配置 : 1. 修改 actuator 的访问端口为开放所有的访问端点, 引入 Spring Security 后可以对暴露的断点进行更多安全配置, 生产环境不建议直接开启所有端点 3. 健康检查端点显示详细信息, 如果不展开显示详细信息, 那么只会有一个总的状态信息

5 启动程序访问如下地址可以看到页面列出了支持功能的链接, 常用的有 : 1. auditevents: 查看审计事件 2. beans: 查看 Spring 中的 Bean 清单 3. conditions: 查看 Spring Boot 自动配置匹配过程 4. configprops: 查看所有的配置

6 5. env: 查看 Spring 的 ConfigurableEnvironment 6. health: 查看程序健康情况, 后面细说 7. httptrace: 查看 HTTP 请求响应明细 ( 默认 100 条 )

7 8. info: 查看程序信息, 后面细说 9. loggers: 查看日志配置, 支持动态修改日志级别 10. metrics: 查看所有的 metrics 信息, 后面细说 11. mappings: 查看 MVC 配置

8 12. scheduledtasks: 查看定时任务 13. sessions: 查看和删除用户 session 14. shutdown: 优雅停止程序 15. threaddump: 线程 Dump 16. heapdump: 下载 GZIP 压缩的 hprof 文件 17. logfile: 查看日志文件, 需要先配置日志文件路径

还有一些其它的自带的端点, 这里就不说了, 比如用于数据迁移的 flyway, 用于给 prometheus 拉取 metrics 数据的端点, 端点还可以自定义别小看这些功能, 这些功能使得我们线上对应用程序进行运维可以很方便 : 1. 可以排查配置环境问题 2. 可以对线程 Dump 排查 High CPU 问题 3.

9 还有一些其它的自带的端点, 这里就不说了, 比如用于数据迁移的 flyway, 用于给 prometheus 拉取 metrics 数据的端点, 端点还可以自定义别小看这些功能, 这些功能使得我们线上对应用程序进行运维可以很方便 : 1. 可以排查配置环境问题 2. 可以对线程 Dump 排查 High CPU 问题 3. 可以对堆 Dump 排查 Memory Leak 问题 4. 可以修改日志级别, 排查程序问题 5. 可以查看定时任务 RequestMapping 等信息 6. 可以让负载均衡器有统一的端口检查应用状态 7. 可以暴露收集汇总程序内部的各种指标用于绘制监控面板 8. 其它各种程序内部的信息健康检查先来访问 /actuator/health 重点看一下健康检查 :

10 这里可以看到不但 Spring Boot 帮我们自动配置收集了 redis 和磁盘的监控信息, 而且我们还自定义了一个叫做 myservice 的检查项这里因为我们程序有使用到 Redis, 所以自动配置了相应的检查, 自动支持自动配置的 HealthIndicator 有下面这些 ( 基本各种 Spring Data 支持的数据源都有了 ):

11 下面我们看一下如何自定义监控检查项 : package me.josephzhu.spring101ops; import org.springframework.beans.factory.annotation.autowired; import org.springframework.boot.actuate.health.health; import org.springframework.boot.actuate.health.healthindicator; import org.springframework.core.parameterizedtypereference; import org.springframework.http.httpmethod; import org.springframework.http.responseentity; import org.springframework.stereotype.component; import org.springframework.web.client.resttemplate; import public class MyServiceHealthIndicator implements HealthIndicator

12 private RestTemplate public Health health() { try { ResponseEntity<List<MyItem>> responseentity = resttemplate.exchange(" HttpMethod.GET, null, new ParameterizedTypeReference<List<MyItem>>() {); if (responseentity.getstatuscode().is2xxsuccessful()) return Health.up().build(); else return Health.down().status(responseEntity.getStatusCode().toString()).build(); catch (Exception ex) { return Health.down(ex).build(); 实现很简单, 实现 HealthIndicator 接口即可, 我们的类是 XXHealthIndicator, 那么自动就会加入一个叫 XX 的项在这里, 我们访问了远程的一个服务, 当服务出现非 2XX 的响应或调用服务出现异常的时候, 我们认为这个服务的健康是 DOWN 的, 否则就是 UP 状态在 down 的时候我们可以传入状态异常等补充信息, 比如这是一个 DOWN 的情况 :

13 因为某一项 DOWN 了, 整个应用的状态认为是 DOWN 之前也说过, 如果每一个程序都有统一的 health 入口可以监控程序状态的话, 我们的负载均衡就可以依靠这个来做应用的故障下线之所以我们需要定义自己的 HealthIndicator 加入是因为很多时候程序启动成功并不代表程序正常工作, 程序是否真正工作正常往往依赖于外部的一些关键服务和内部的一些关键组件 ( 线程池队列等 ) 应用信息在本节中, 我们来看一下如何进行简单配置实现暴露如下应用信息的功能 : 1. 通过配置方式暴露自定义的信息 2. 通过程序方式暴露自定义的信息 3. 暴露应用构建信息 4. 暴露应用 git 版本信息访问 /actuator/info 可以看到下面的信息 :

14 在截图中第一项可以看到 app 这个 JSON 暴露了一些自定义的信息, 我们可以在 application.properties 配置文件中加入这样的配置来实现 : info.app.name=test SpringBoot Actuator info.app.description=test how to configure Health/Info/Metrics etc. with Spring Boot Actuator info.app.version=1.0.1 info.app.author=josephzhu 截图中第二项可以看到 git 这个 JSON 暴露了程序 git 相关的信息, 实现方式是加入一个插件到 pom 中 : <plugin> <groupid>pl.project13.maven</groupid> <artifactid>git-commit-id-plugin</artifactid>

<version>2.1.15</version> </plugin> 此外, 如果需要查看 git 详细信息的话需要加入如下配置到配置文件 : management.info.git.mode=full 截图中第三项可以看到 build 这个 JSON 暴露了程序构建一些信息, 这个通过 Spring Boot 的 maven 插件就可以实现, 加入 build-info 这个 Goal 来生成 : <plugin> <groupid>org.

15 <version>2.1.15</version> </plugin> 此外, 如果需要查看 git 详细信息的话需要加入如下配置到配置文件 : management.info.git.mode=full 截图中第三项可以看到 build 这个 JSON 暴露了程序构建一些信息, 这个通过 Spring Boot 的 maven 插件就可以实现, 加入 build-info 这个 Goal 来生成 : <plugin> <groupid>org.springframework.boot</groupid> <artifactid>spring-boot-maven-plugin</artifactid> <executions> <execution> <goals> <goal>build-info</goal> </goals> </execution> </executions> </plugin> 我们使用 maven 运行一下这两个插件, 可以看到编译后多了 build-info.properties 和 git.properties, 这也就是 Actuator 获取信息的来源 : 截图中最后我们看到有一个 key 项的信息, 这是我们通过程序定义的, 实现方式是实现 InfoContributor 接口 : package me.josephzhu.spring101ops; import org.springframework.boot.actuate.info.info; import org.springframework.boot.actuate.info.infocontributor; import org.springframework.stereotype.component;

16 @Component public class MyInfoContributor implements InfoContributor public void contribute(info.builder builder) { builder.withdetail("key","value").build(); 对外暴露一些程序内部的重要信息往往也是很重要排查线上问题的手段 Info 适合展示不太会变动的一些复杂信息, 如果希望整个历史状态信息都能保留和监控的话更适合采用下面的打点方式监控打点访问 /actuator/metrics 可以看到下面的信息 :

17 Spring Boot 集成了一个叫做 MicroMeter 的库用于 Metrics 这个库号称是 Metrics 界的 SLF4J, 它的作用在于 : 1. 可以适配多达 10+ 的监控数据库, 包括 Graphite Influx StatsD 等等 2. 以统一的语言定义了打点这个事情 3. 自动集成了很多 JVM 的信息, 包括内存 GC CPU 线程等我们可以随便点一个 Metrics 进去查看 :

18 下面, 我们来看一下如何通过简单的几个配置实现把所有的打点信息发送到 InfluxDb 中去第一步, 在 pom 中引入 influx 依赖 : <dependency> <groupid>io.micrometer</groupid> <artifactid>micrometer-registry-influx</artifactid> </dependency> 当然, 需要先在本机安装一下 influxdb,macos 也就是一行命令,brew install influxdb 即可第二步, 加入配置 :

19 management.metrics.web.server.auto-time-requests=true management.metrics.export.influx.enabled=true management.metrics.export.influx.auto-create-db=true management.metrics.export.influx.db=myapp management.metrics.export.influx.step=10s 逐一说明一下这些配置 : 1. 第一个配置用于自动开启所有 Web 请求的执行时间记录, 如果不这么配的话可以手动在 Controller 注解 2. 第二个配置用于开启 micrometer 的 influx 的支持 3. 第三个配置用于自动创建 influxdb 的数据库 4. 第四个配置指定了 influxdb 的数据库名称为 myapp 5. 第五个配置指定了汇总上报数据到 influxdb 的周期我们可以启动程序, 多访问几次然后打开查看, 可以看到具体请求的执行次数和执行时间 ( 证明 1):

20 同时, 我们可以在日志中看到 ( 证明 5): :49: INFO [pool-1-thread-1] i.micrometer.influx.influxmeterregistry : successfully sent 73 metrics to influx :49: INFO [pool-1-thread-1] i.micrometer.influx.influxmeterregistry : successfully sent 73 metrics to influx 有 73 个监控指标每隔 10 秒发送到一次 influxdb, 我们可以进入 influx 客户端, 查看这个 measurement 的信息 ( 先输入命令 use myapp):

21 还记得吗, 我们实现了一个自定义的 HealthIndicator, 里面有用到 RestTemplate 来访问远程服务, 现在可以尝试多访问几次然后打开可以看到的确有信息 :

22 说明 RestTemplat 默认为我们集成了 Metrics, 记录客户端 HTTP 请求的执行情况数据收集和上发的工作完成了, 最后我们可以 brew install grafana, 使用 Grafna 连接 InfluxDb 来配置一下我们的监控面板首先配置一下数据源 :

23 然后就可以配置图表了 : 有关 Grafana 的使用方式这里不详述了自定义监控打点我们再来看一下如何自定义 Metrics 项实现自己的打点, 修改一下我们的 Controller:

@Autowired MeterRegistry meterregistry; @GetMapping("items") public List<MyItem> items(@requestparam(value = "count",defaultvalue = "10") int count){ stringredistemplate.opsforvalue().

24 @Autowired MeterRegistry public List<MyItem> = "count",defaultvalue = "10") int count){ stringredistemplate.opsforvalue().set("testkey", "value" + count); meterregistry.timer("mytimer").record(()-> { try { Thread.sleep(count); catch (InterruptedException e) { ); meterregistry.counter("mycounter").increment(count); meterregistry.gauge("currentvalue1", count); return IntStream.rangeClosed(1,count).mapToObj(i->new MyItem("name" + i,i)).collect(collectors.tolist()); 在这里, 我们注入了 MeterRegistry 类, 然后通过这个类我们可以方便进行各种信息的上报在 MicroMeter 中, 信息抽象为了这么几种 : 1. 状态信息, 所谓状态信息就是每次上报的是信息的当前值, 数据是不能累计的比如当前线程数 48,1 分钟后是 50, 这个值如果进行汇总聚合的话没有太大意义 ( 总计 98 个线程? 平均 49 个线程?), 在展现的时候只能展现某个时刻的某个值

/actuator/health 的信息转换成打点上报的例子, 我们可以通过获得所有的 HealthIndicator, 交由 CompositeHealthIndicator 汇总健康信息结果, 然后通过 MeterRegistry 上报监控信息的打点 : package me.josephzhu.spring101ops; import io.

25 2. 数量信息, 比如请求执行的次数, 一次上报可以 +1 也可以 +N, 这个数据是可以聚合的比如如果我们在 1 分钟内上报了 2 次, 一次 10, 一次 20, 那么 1 分钟的聚合就是总数 30, 每次上报记录的是聚合的总和信息 3. 执行时间信息, 可以方便的统计方法执行时间上报的信息会比数量信息丰富, 除了次数之外还有总执行时间平均执行时间最长执行时间 c 是不是很方便, 使用 MicroMeter 统一的 API, 我们只要根据需要收集指标数据即可, 剩下的数据整理汇总以及和后端数据库交互上报数据的过程都自动完成最后, 我们再来看一个把 /actuator/health 的信息转换成打点上报的例子, 我们可以通过获得所有的 HealthIndicator, 交由 CompositeHealthIndicator 汇总健康信息结果, 然后通过 MeterRegistry 上报监控信息的打点 : package me.josephzhu.spring101ops; import io.micrometer.core.instrument.meterregistry; import org.springframework.boot.actuate.health.compositehealthindicator; import org.springframework.boot.actuate.health.healthaggregator; import org.springframework.boot.actuate.health.healthindicator;

26 import org.springframework.boot.actuate.health.status; import org.springframework.context.annotation.configuration; import java.util.list; import static class HealthMetricsConfiguration { private CompositeHealthIndicator compositehealthindicator; public HealthMetricsConfiguration(HealthAggregator healthaggregator, List<HealthIndicator> healthindicators, MeterRegistry registry) { compositehealthindicator = new CompositeHealthIndicator(healthAggregator); for (Integer i = 0; i < healthindicators.size(); i++) { compositehealthindicator.addhealthindicator(i.tostring(), healthindicators.get(i)); registry.gauge("health", emptylist(), compositehealthindicator, health -> { Status status = health.health().getstatus(); switch (status.getcode()) { case "UP": return 3; case "OUT_OF_SERVICE": return 2; case "DOWN": return 1; case "UNKNOWN": default:

return 0; ); 重启应用后稍等一下, 看一下 InfluxDb 中的数据, 的确是一些值为 3 的记录, 代表 UP: 总结本文我们通过一些例子覆盖了如下内容 : 1. Actuator 模块的功能 2. 详述了健康检查端点, 自定义健康检查项 3. 详述了数据信息端点, 为程序添加各种附加数据项 4. 详述了监控打点, 程序方式上报自定义的三种形式的打点 5.

27 return 0; ); 重启应用后稍等一下, 看一下 InfluxDb 中的数据, 的确是一些值为 3 的记录, 代表 UP: 总结本文我们通过一些例子覆盖了如下内容 : 1. Actuator 模块的功能 2. 详述了健康检查端点, 自定义健康检查项 3. 详述了数据信息端点, 为程序添加各种附加数据项 4. 详述了监控打点, 程序方式上报自定义的三种形式的打点 5. InfluxDb 和 Grafana 的简单使用的确, 每一个功能都是简单的几步配置,Spring Boot Actuator 真的很方便, 这些功能是一个真正的可用于生产环境的程序必不可少的一些功能,Spring Boot 不仅仅为我们提供了方便, 而且为我们定义了架构模板, 让每一个开发人员都能有意识, 应该做一些什么, 这也就是我为什么一直说 Spring 引领了企业级单机开发,Spring Boot 引领了互联网微服务开发

28 但是,Spring Boot 因为在高速发展, 会不断吸收好的开源项目整合到生态中去, 所以在 API 上变化会较多,API 一直在修改, 增加了不少学习成本和坑任何事情都有两面性, 我们在要求 Spring 生态为我们提供越来越多功能的时候, 享受到便利的同时, 也必须去适应 Spring 的快速变化老样子, 本系列文章代码见我的 github:

将 MD5 的工具类拷贝到项目中二微服务模块的搭建我们将权限的查询放到一个单独的模块中, 这个模块提供接口供给消费者远程调用 (RPC), 这次范例是微服开发的雏形, 在以后你使用 springcloud 的时候会使用到今天的概念 1 使用 maven 创建新的模块 (microboot-sh

将 MD5 的工具类拷贝到项目中二微服务模块的搭建我们将权限的查询放到一个单独的模块中, 这个模块提供接口供给消费者远程调用 (RPC), 这次范例是微服开发的雏形, 在以后你使用 springcloud 的时候会使用到今天的概念 1 使用 maven 创建新的模块 (microboot-sh Shiro 的环境搭建一公共模块的搭建在实际的开发中, 一个项目可能会分多个模块进行实际的开发, 但是这些模块需要使用一些公共的操作, 那么这些公共的操作不应该在每个模块中重新定义, 而是将这些公共的操作专门定义在一个公共的模块之后哦在模块中的 pom 文件里面引入这个公共的模块, 比如说 vo 类就是一个公共的模块, 所以定义到公共类中 1. 定义公共模块 (microboot-shiro-api)maven