spring boot Actuator之自定义Endpoint

本文基于spring boot 2.2.0 release版本。

在上一篇文章《spring boot Actuator原理详解之启动》详细介绍了在web环境下，Actuator是如何启动的，这里对流程做一个简单的总结：

扫描所有@Endpoint注解的类，这些类都是Endpoint；
使用过滤器对Endpoint对象进行过滤，没有被过滤掉的才可以进入下一步；
读取Endpoint对象的每个方法，判断是否有@ReadOperation、@WriteOperation、@DeleteOperation三个注解，如果有，则针对每个被注解的方法创建操作对象Operation；
根据操作对象、Endpoint对象、Endpoint名创建为RequestMappingInfo，并将其注册到spring mvc中；
注册成功之后，Endpoint对象便可以对外提供服务。

明白了上面整个启动流程之后，我们也可以编写一个自定义的Endpoint。
自定义Endpoint的关键点：

类上必须有注解@Endpoint，注解必须设置id值，否则启动抛出如下异常：Caused by: java.lang.IllegalStateException: No @Endpoint id attribute specified for XXXClass；
必须指定方法注解为下面三个中一个：@ReadOperation、@WriteOperation、@DeleteOperation；
注解@Selector可以指定路径参数，比如/actuator/caches/{cache}花括号里面的内容是路径参数，我们可以在方法入参上添加@Selector来指定路径参数，比如public String counters(@Selector int value)；
默认Endpoint对象的方法都是以json格式返回客户端，可以通过设置@ReadOperation、@WriteOperation、@DeleteOperation的produces属性指定其他格式。

下面给出一个自定义Endpoint的例子：

/*** 统计方法该Endpoint对象的次数*/
@Component
@Endpoint(id="counter")
public class Counter  {private AtomicInteger cnt=new AtomicInteger(0);@ReadOperationpublic int counter() {return cnt.getAndAdd(1);}@ReadOperationpublic int counters(@Selector int value) {return cnt.getAndAdd(value);}
}

上面这个类只是一个示例，并没有实际意义。运行起来后，访问http://localhost:8079/actuator/counter，每次访问都会返回一个比之前大1的数字。

我们还可以使用注解@EndpointWebExtension扩展已有的Endpoint。
下面是spring提供的对EnvironmentEndpoint的扩展：

@EndpointWebExtension(endpoint = EnvironmentEndpoint.class)
public class EnvironmentEndpointWebExtension {private final EnvironmentEndpoint delegate;public EnvironmentEndpointWebExtension(EnvironmentEndpoint delegate) {this.delegate = delegate;}@ReadOperationpublic WebEndpointResponse<EnvironmentEntryDescriptor> environmentEntry(@Selector String toMatch) {EnvironmentEntryDescriptor descriptor = this.delegate.environmentEntry(toMatch);return new WebEndpointResponse<>(descriptor, getStatus(descriptor));}private int getStatus(EnvironmentEntryDescriptor descriptor) {if (descriptor.getProperty() == null) {return WebEndpointResponse.STATUS_NOT_FOUND;}return WebEndpointResponse.STATUS_OK;}
}

就web环境下来说，如果扩展类的方法有与原类相同的http请求路径，那么扩展类会替换掉原来的方法，也就是说，访问该路径时，不会访问到原类的方法，而是访问到扩展类。

spring boot Actuator之自定义Endpoint相关推荐

Spring Boot Actuator：自定义端点，其顶部具有MVC层
Spring Boot Actuator端点允许您监视应用程序并与之交互. Spring Boot包含许多内置端点,您也可以添加自己的端点. 添加自定义端点就像创建一个从org.springframe ...
警惕 Spring Boot Actuator 引发的安全问题
前言一年一度的 HW 行动开始了,最近也是被各种安全漏洞搞的特别闹心,一周能收到几十封安全团队扫描出来的漏洞邮件,这其中有一类漏洞很容易被人忽视,但影响面却极广,危害也极大,我说出它的名字你应该也不 ...
SpringBoot2.x系列教程（七十）Spring Boot Actuator集成及自定义Endpoint详解
前言曾经看到Spring Boot Actuator这个框架时,一直在想,它到底有什么作用呢?虽然知道它提供了很多端点,有助于应用程序的监控和管理,但如果没有直接的实践案例,还是很难有说服力的. 直 ...
Spring Boot Actuator：在其顶部具有MVC层的自定义端点
Spring Boot Actuator端点允许您监视应用程序并与之交互. Spring Boot包含许多内置端点,您也可以添加自己的端点. 添加自定义端点就像创建一个从org.springframe ...
朱晔和你聊Spring系列S1E7：简单好用的Spring Boot Actuator
本文会来看一下Spring Boot Actuator提供给我们的监控端点Endpoint.健康检查Health和打点指标Metrics等所谓的Production-ready(生产环境必要的一些)功 ...
actuator的原理_使用Spring Boot Actuator监视Java应用程序
actuator的原理朋友不允许朋友写用户身份验证. 厌倦了管理自己的用户? 立即尝试Okta的API和Java SDK. 数分钟之内即可在任何应用程序中对用户进行身份验证,管理和保护. 您是否曾与 ...
如何将 Spring Boot Actuator 的指标信息输出到 InfluxDB 和 Prometheus
来源:SpringForAll社区 Spring Boot Actuator是Spring Boot 2发布后修改最多的项目之一.它经过了主要的改进,旨在简化定制,并包括一些新功能,如支持其他Web技 ...
spring boot actuator工作原理之http服务暴露源码分析
spring boot actuator的官方文档地址:https://docs.spring.io/spring-boot/docs/current/reference/html/productio ...
spring Boot Actuator使用
spring Boot Actuator使用 Spring Boot 的 Actuator 提供了很多生产级的特性,比如监控和度量Spring Boot 应用程序. 官网参考文档Spring Boot ...

spring boot Actuator之自定义Endpoint

spring boot Actuator之自定义Endpoint相关推荐

最新文章

热门文章