聊聊springboot项目如何实现自定义actuator端点聊聊springboot项目如何实现自定

前言用过springboot的朋友，可能会知道springboot有四大神器：自动装配、starter、cli、actuator。其中actuator可帮助你在将应用程序推送到生产环境时监控和管理应用程序。你可以选择使用 HTTP 端点或 JMX 来管理和监控你的应用程序。审计、健康和指标收集也可以自动应用于你的应用程序。
actuator默认为我们内置了以下端点

ID	描述	默认启用	默认公开
auditevents	公开当前应用程序的审计事件信息	Yes	No
beans	显示应用程序中所有Spring bean的完整列表	Yes	No
conditions	显示在配置和自动配置类上评估的条件以及它们是否匹配的原因	Yes	No
configprops	显示所有`@ConfigurationProperties`对照的列表	Yes	No
env	从Spring的`ConfigurableEnvironment`中公开属性	Yes	No
flyway	显示已应用的任何Flyway数据库迁移	Yes	No
health	显示应用程序健康信息	Yes	Yes
httptrace	显示HTTP跟踪信息（默认情况下，最后100个HTTP请求-响应交互）	Yes	No
info	显示任意应用程序信息	Yes	Yes
loggers	显示和修改应用程序中记录器的配置	Yes	No
liquibase	显示已应用的任何Liquibase数据库迁移	Yes	No
metrics	显示当前应用程序的“指标”信息	Yes	No
mappings	显示所有`@RequestMapping`路径对照的列表	Yes	No
scheduledtasks	显示应用程序中调度的任务	Yes	No
sessions	允许从Spring Session支持的会话存储中检索和删除用户会话	Yes	No
shutdown	让应用程序优雅地关闭	No	No
threaddump	执行线程转储	Yes	No

如果你的应用程序是一个web应用程序（Spring MVC、Spring WebFlux或Jersey），你可以使用以下附加端点

ID	描述	默认启用	默认公开
heapdump	返回一个GZip压缩的`hprof`堆转储文件	Yes	No
jolokia	在HTTP上公开JMX bean（当Jolokia在类路径上时，WebFlux不可用）	Yes	No
logfile	返回日志文件的内容，支持使用HTTP `Range` header来检索日志文件内容的一部分	Yes	No
prometheus	公开指标，该格式可以被Prometheus服务器采集	Yes	No

注： actuator 在springboot 1.X 和springboot 2.X 存在较大的差异，本文以springboot 2.X 作为本文的讲解
通常情况下，actuator内置的端点就可以满足我们的日常需求了，但有时候我们需要自定义端点。下面就列举一下几种常用的自定义端点
自定义端点
自定义前置条件，在pom.xml引入

org.springframework.boot spring-boot-starter-actuator

1、自定义health

【聊聊springboot项目如何实现自定义actuator端点】当内置的health端点信息不满足用来判断我们项目是否健康时，我们可以自定义health
通过实现org.springframework.boot.actuate.health.HealthIndicator接口，形如

@Component public class CustomHealthIndicator implements HealthIndicator {@Override public Health health() { int errorCode = check(); if (errorCode == 1) { return Health.down().withDetail("Error Code", errorCode).build(); } return Health.up().build(); }private int check() { // perform some specific health check return ThreadLocalRandom.current().nextInt(5); }}

或者通过继承org.springframework.boot.actuate.health.AbstractHealthIndicator，形如

@Component("otherCustom") public class CustomAbstractHealthIndicator extends AbstractHealthIndicator { @Override protected void doHealthCheck(Health.Builder builder) throws Exception {int errorCode = check(); if (errorCode == 1) { builder.down().down().withDetail("Error Code", errorCode).build(); return; } builder.up().build(); }private int check() { // perform some specific health check return ThreadLocalRandom.current().nextInt(5); } }

推荐使用继承AbstractHealthIndicator 这种方式。在配置文件中作如下配置，可以查看详细的健康信息

management: endpoint: health: show-details: always

通过访问http://ip:port/actuator/health进行查看，形如下

文章图片

从图片我们可以看出，我们自定义的health端点信息，如果@Component不指定name，形如CustomHealthIndicator ，默认是取custom作为自定义端点对象

2、自定义info

我们可以通过实现org.springframework.boot.actuate.info.InfoContributor接口，来暴露一些我们想展示的信息。形如

@Component public class CustomInfoContributor implements InfoContributor {@Override public void contribute(Info.Builder builder) { builder.withDetail("customInfo", Collections.singletonMap("hello", "world")); }}

通过访问http://ip:port/actuator/info进行查看，形如下

文章图片

3、自定义endpoint

有时候我们需要自定义自己的端点，我们可以通过
@Endpoint注解 + @ReadOperation、@WriteOperation、@DeleteOperation注解来实现自定义端点。形如下

@Component @Endpoint(id = "customEndpoint") public class CustomEndpoint {// @ReadOperation 对应GET请求/** * 请求示例： * GET http://localhost:8080/actuator/customEndpoint/zhangsan/20 * @param username * @param age * * @return */ @ReadOperation public Map endpointByGet(@Selector String username,@Selector Integer age) { Map customMap = new HashMap<>(); customMap.put("httpMethod", HttpMethod.GET.toString()); customMap.put("username",username); customMap.put("age",age); return customMap; }// @WriteOperation 对应POST请求/** * 请求示例： * POST http://localhost:8080/actuator/customEndpoint * * 请求参数为json格式 * * { *"username": "zhangsan", *"age": 20 * } * * @param username 参数都为必填项 * @param age 参数都为必填项 * @return */ @WriteOperation public Map endpointByPost(String username,Integer age) { Map customMap = new HashMap<>(); customMap.put("httpMethod", HttpMethod.POST.toString()); customMap.put("username",username); customMap.put("age",age); return customMap; }// @DeleteOperation 对应Delete请求/** * 请求示例： * DELETE http://localhost:8080/actuator/customEndpoint * * @return */ @DeleteOperation public Map endpointByDelete() { Map customMap = new HashMap<>(); customMap.put("httpMethod", HttpMethod.DELETE.toString()); return customMap; }

代码片段里面有比较详细的注释，这边就不在论述。这边有个细节就是，我们需要在yml作如下配置来暴露我们自定义的端点
通过

management: endpoints: web: exposure: include: customEndpoint

或者

management: endpoints: web: exposure: include: "*"

总结本文仅介绍几种相对通用的自定义端点，更详细的端点介绍可以查看官网，链接如下
https://docs.spring.io/spring-boot/docs/current/reference/html/actuator.html#actuator
demo链接 https://github.com/lyb-geek/springboot-learning/tree/master/springboot-custom-actuator-endpoint