SpringBoot---＞＞＞指标监控--＞＞定制 Endpoint 信息

定制 Endpoint 信息

之前的 endpoint 反馈信息很多，但是实际上程序肯定有某些流程会反馈数据出来以表示程序正常运行。所以需要自己定义 Endpoint 反馈的信息

1、定制 health Endpoint 信息

根据官网说法定制 health 信息，可以通过实现 HealthIndicator 接口，提供 health() 方法，里面调用 withDetail() 方法，设置详细信息。但是呢他是个接口，就进去看看类结构图，有没有实现类。发现有一个实现类 AbstractHealthIndicator ，它只要实现 doHealthCheck() 方法，判断逻辑并设置 health 信息

继承 AbstractHealthIndicator 类

这个类要是组件，它的 endpointName 就是 HealthIndicator 前面那一段首字母小写，所以要注意命名

@Component
public class MyProjectHealthIndicator extends AbstractHealthIndicator {/*** 健康检查方法，里面对逻辑进行检查，并设置 health 信息* @param builder* @throws Exception*/@Overrideprotected void doHealthCheck(Health.Builder builder) throws Exception {Map<Object,Object> mes = new HashMap<>();//  进行判断逻辑if (1==1){//直接反馈 health 状态为 UP
//            builder.up();//第二种方式builder.status(Status.UP);mes.put("code","666");mes.put("mess","逻辑通过");}else {//设置 health 状态为 DOWN
//            builder.down();//第二种方式builder.status(Status.OUT_OF_SERVICE);mes.put("code","000");mes.put("mess","逻辑不通过");}//结果builder.withDetail("num",789).withDetail("详细信息",mes);}
}

结果

-0-

实现 HealthIndicator 接口

@Component
public class MyHealthIndicator implements HealthIndicator {@Overridepublic Health health() {int errorCode = check();if (errorCode != 0) {return Health.down().withDetail("Error Code", errorCode).build();}return Health.up().build();}private int check() {// 这里写逻辑，结果返回判断return 0;}
}

2、定制 info Endpoint 信息

info 端点的作用是显示程序信息，有两种方式定制 info 信息

1、配置文件

  info:env:enabled: true
#  自定义 info 端点的先决条件是 启用 management.info.env.enabled
info:app:name: 菠萝风车version: 1.0.0.0encoding: UTF-8java:resurce: 8

结果

-0-

或者,直接去 pom 文件中拿当前程序的名称、版本

使用 @@ 在中间写想要拿到的内容，根据pom文件的标签层级

info:appName: @project.artifactId@appVersion: @project.version@

-0-

2、实现 InfoContributor 接口

官网：

https://docs.spring.io/spring-boot/docs/current/reference/html/actuator.html#actuator.endpoints.info

实现接口提供自定义应用程序信息

info 的命名跟类名没啥关系

@Component
public class MyProjectInfoContributor implements InfoContributor {@Overridepublic void contribute(Info.Builder builder) {builder.withDetail("appName1","PAPA").withDetail("appVersion1","1,2,2").withDetails(Collections.singletonMap("haha",123));}
}

3、定制 metrics 信息

官网：可以看到 Spring 支持自动适配的 metrics 类型

https://docs.spring.io/spring-boot/docs/current/reference/html/actuator.html#actuator.metrics

自定义 metrics 信息

操作 MeterRegistry 对象可以添加自定义 metrics

@Component
public class MyService {Counter counter;public MyService(MeterRegistry meterRegistry) {counter = meterRegistry.counter("这是自定义的metric");counter.increment();}}

或者使用 MeterBinder 注册 metrics 信息，以配置类方式，添加组件。默认情况下，来自所有MeterBinderbean 的指标会自动绑定到 Spring-managed MeterRegistry。

@Configuration
public class MetricsConfiguration {@Beanpublic MeterBinder heihei(Queue queue){return (registry) -> Gauge.builder("this is newMetrics", queue::size).register(registry);}}

4、定制 Endpoint

可以使用注解 @Endpoint 声明类成为一个自定义端点,用注解 @ReadOperation、@WriteOperation 修饰方法。自定义 Endpoint 会自动通过 JMX 公开，并且在 Web 应用程序中，也会通过 HTTP 公开。

类里面

@Component
@Endpoint(id = "myEndpoint")
public class MyProjectEndpoint {@ReadOperationpublic Map getJDBCConnect(){return Collections.singletonMap("read...","success");}@WriteOperationpublic void exceptionHandle(){System.out.println("出现了问题");}}

结果

访问结果

在 jconsole 中对这两个方法执行，会得到不同的反应。操作 exceptionHandle 就会输出内容。