X

大牛带你深入SpringBoot:自定义Endpoint 及实现原理「转」

Endpoint

SpringBoot的Endpoint主要是用来监控应用服务的运行状况,并集成在Mvc中提供查看接口。内置的Endpoint比如HealthEndpoint会监控dist和db的状况,MetricsEndpoint则会监控内存和gc的状况。 Endpoint的接口如下,其中*invoke()*是主要的方法,用于返回监控的内容,*isSensitive()*用于权限控制。

public interface Endpoint {

String getId();

boolean isEnabled();

boolean isSensitive();

T invoke();

}

Endpoint的加载还是依靠spring.factories实现的。spring-boot-actuator包下的META-INF/spring.factories配置了EndpointAutoConfiguration。

org.springframework.boot.autoconfigure.EnableAutoConfiguration=\

org.springframework.boot.actuate.autoconfigure.EndpointAutoConfiguration,\

EndpointAutoConfiguration就会注入必要的Endpoint。有些Endpoint需要外部的收集类,比如TraceEndpoint。

@Bean

@ConditionalOnMissingBean

public TraceEndpoint traceEndpoint() {

return new TraceEndpoint(this.traceRepository);

}

TraceEndpoint会记录每次请求的Request和Response的状态,需要嵌入到Request的流程中,这里就主要用到了3个类。

1.TraceRepository用于保存和获取Request和Response的状态。

public interface TraceRepository {

List findAll();

void add(Map traceInfo);

}

2.WebRequestTraceFilter用于嵌入web request,收集请求的状态并保存在TraceRepository中。

3.TraceEndpoint,invoke()方法直接调用TraceRepository保存的数据。

自定义Endpoint

自定义Endpoint也是类似的原理。这里自定义Endpoint实现应用内存的定时收集。完整的代码放在Github上了。

收集内存,MemStatus是内存的存储结构,MemCollector是内存的收集类,使用Spring内置的定时功能,每5秒收集当前内存。

2.自定义Endpoint,getId是EndPoint的唯一标识,也是Mvc接口对外暴露的路径。invoke方法,取出maxMemory和totalMemory和对应的时间。