【监控】spring actuator源码速读
目次1.前言
2.先搂一眼EndPoint
3.EndPoint如何被注入
4.EndPoint如何被暴露
4.1.如何通过http暴露
4.2.如何通过jmx暴露
5.EndPoint是怎么实现监控能力的
6.知道这些的意义是什么
1.前言
版本：spring-boot-starter-actuator 2.6.3
阅读源码肯定要带着疑问去阅读，这个疑问就是你阅读的主线，否则在浩如烟海的源码里面很轻易迷路。我们当前的疑问是什么？之前我们已经聊过spring actuator的利用了：
Spring Boot 监控_springboot 监控-CSDN博客
本文要搞清晰的两个题目在于：
[*] EndPoint是怎么被注入IOC又怎么暴露出去能通过HTTP访问到的？
[*] EndPoint是怎么实现监控能力的？
2.先搂一眼EndPoint
首先我们找一个EndPoint来看看，此处以HealthEndPoint为例。点看源码我们可以看到这个EndPoint被@EndPoint注解所解释，id为health。然后此中的2个方法被@ReadOperation所解释：
https://i-blog.csdnimg.cn/blog_migrate/7d094a6e93eb3ccd216e7cb35bc73cb5.png
这里其实猜都能猜到被@EndPoint注解，然后被注解的类被归类为EndPoint，然后被集中暴露出去，变成可访问的。
3.EndPoint如何被注入
我们是通过stater来引入actuator的，Spring Boot体系内如何注入stater的？那肯定是通过autoConfiguration来的撒。点进actuator的配置文件也可以看到：
https://i-blog.csdnimg.cn/blog_migrate/7ce23f43da501ca2f025c48453e24db4.png
于是我们来到spring-boot-starter-actuator来看看，看看它的spring.factories里面注入了些什么：
见名知意了，这些浩繁的XXXautoConfiguration是拿来做什么的就不必多说了吧，health、metrics…分门别类，各种EndPoint的autoConfiguration。
https://i-blog.csdnimg.cn/blog_migrate/0d325e6d8d6b0cf9d5ad0e5be108f0d2.png
我们来看看HealthEndpointAutoConfiguration里面做了什么：
其实就是加载了HealthEndpointConfiguration、ReactiveHealthEndpointConfiguration、HealthEndpointWebExtensionConfiguration、HealthEndpointReactiveWebExtensionConfiguration这几个类
@Configuration(
?proxyBeanMethods = false
)
@ConditionalOnAvailableEndpoint(
?endpoint = HealthEndpoint.class
)
@EnableConfigurationProperties({HealthEndpointProperties.class})
@Import({HealthEndpointConfiguration.class, ReactiveHealthEndpointConfiguration.class, HealthEndpointWebExtensionConfiguration.class, HealthEndpointReactiveWebExtensionConfiguration.class})
public class HealthEndpointAutoConfiguration {
?public HealthEndpointAutoConfiguration() {
?}
}
我们先看HealthEndpointConfiguration，它里面向IOC中注入了health的Registry，HealthContributorRegistry中注册了HealthContributor类型的实体。
https://i-blog.csdnimg.cn/blog_migrate/3c2064ef06dee00ad4c0fb09a95f9ee5.png
我们任意打开一个health的EndPoint，发现它都继续同一个父类：
https://i-blog.csdnimg.cn/blog_migrate/886945dcf008336d7b13889c469a002d.png
而这个父类实现了HealthContributor接口：
https://i-blog.csdnimg.cn/blog_migrate/697b69c3993efc30b0ee410008ceb9d3.png
以是其实就是在将注册器注入IOC的时间，就将所有属于该类型的EndPoint注册到注册器中了。
4.EndPoint如何被暴露
4.1.如何通过http暴露
在SpringBoot体系中，谁来负责http哀求？那当然是SpringMVC的DispatcherServlet。把path和对应处理的类注册到DispatcherServlet中就行了。spring actuator就是这样对外通过HTTP的方式暴露EndPoint的。
回到spring.factories，找ManagementContextAutoConfiguration，这个类中完成了通过HTTP的方式来暴露EndPoint的过程：
https://i-blog.csdnimg.cn/blog_migrate/ca931976161ca184a0d85387d482321e.png
这个类的代码并不多，我们去掉不要的部分，把和对外暴露EndPoint干系的代码保留，来读一下：
@ManagementContextConfiguration(
?proxyBeanMethods = false
)
@ConditionalOnWebApplication(
?type = Type.SERVLET
)//只能在Web环境中生效
public class ServletEndpointManagementContextConfiguration {
?public ServletEndpointManagementContextConfiguration() {
?}
?
?@Configuration(
? ? ?proxyBeanMethods = false
?)
?@ConditionalOnClass({DispatcherServlet.class})//当SpringMVC存在时向IOC中注入
?public static class WebMvcServletEndpointManagementContextConfiguration {
? ? ?public WebMvcServletEndpointManagementContextConfiguration() {
? ? ?}
? ? ?@Bean
? ? ?public ServletEndpointRegistrar servletEndpointRegistrar(WebEndpointProperties properties, ServletEndpointsSupplier servletEndpointsSupplier, DispatcherServletPath dispatcherServletPath) {
? ? ? ? ?return new ServletEndpointRegistrar(dispatcherServletPath.getRelativePath(properties.getBasePath()), servletEndpointsSupplier.getEndpoints());//核心的一步，将EndPoint和对于的Path注册给DispatcherServlet
? ? ?}
?}
}
末了就是开头我们看见的在HealthEndPoint被@ReadOperation注解的方法，就相称于@RequetMapping，拿来处理读哀求的。
4.2.如何通过jmx暴露
jmx的对外暴露更简单。直接找JmxEndpointAutoConfiguration：
https://i-blog.csdnimg.cn/blog_migrate/32122aad246abb12bec61359d07a4c91.png
进去整个逻辑一览无余，去扫Jmx的EndPoint然后注册进mBeanServer里：
https://i-blog.csdnimg.cn/blog_migrate/dc01369ea3cbcc7841e0eded921ad72f.png
5.EndPoint是怎么实现监控能力的
spring actuator获取各种监控的值是怎么获取到的？
[*] 内置指标获取： Spring Boot 提供了一些内置的监控指标获取器，用于获取常见的监控数据，比如 JVM 内存利用情况、系统负载、数据库连接池状态等。这些指标获取器会周期性地获取数据，并将其暴露为 Actuator 端点，以便外部系统大概工具可以通过相应的接口来获取。比方，MemoryHealthIndicator 获取 JVM 内存利用情况，DataSourceHealthIndicator 获取数据库连接池状态等。
[*] 自定义指标获取： 除了内置的指标获取器外，开发者还可以通过实现 HealthIndicator 接口来自定义监控指标获取器，用于获取应用程序特定的监控数据。HealthIndicator 接口定义了一个 health() 方法，用于返回健康状态信息。开发者可以在 health() 方法中编写自定义的监控逻辑，比如查抄某个依赖服务的可用性、计算某个指标的值等。
[*] JMX 获取： Spring Actuator 还可以通过 Java Management Extensions (JMX) API 来获取一些系统级的监控数据，比如 JVM 运行时信息、操作系统信息等。Spring Actuator 中的一些监控指标获取器会利用 JMX API 来获取数据，然后将其暴露为 Actuator 端点。比方，JvmInfoContributor 利用 JMX API 来获取 JVM 运行时信息。
[*] 系统调用获取： 有些监控数据大概必要通过系统调用来获取，比如获取操作系统的 CPU 利用率、磁盘利用情况等。Spring Actuator 中的一些监控指标获取器会利用系统调用来获取这些数据，然后将其暴露为 Actuator 端点。
6.知道这些的意义是什么
本文是作者java监控系列文章的第三篇，之前两篇文章我们着重讲了java监控的基石——JMX。
【JMX】JAVA监控的基石-CSDN博客
详解tomcat中的jmx监控-CSDN博客
在spring actuator里面我们知道了现在市面上一个成熟的框架是如何通过http、JMX等不同方式来对外暴露监控能力的。基本上走到这里我们就已经对JAVA整个的监控技术体系最核心的部分有了熟悉了。作为监控框架来说核心点有哪些？无非是：
[*] 获取数据
[*] 对外暴露口子
监控的核心肯定是怎么获取数据以及如何将获取的数据暴露出去，只要这两点搞定了，后面的对接各种可视化平台就很好办了。所有知道为啥这篇文章为啥要关心spring actuator这些地方了吧，主要是看看实现思想。
免责声明：如果侵犯了您的权益，请联系站长，我们会及时删除侵权内容，谢谢合作！更多信息从访问主页：qidao123.com:ToB企服之家，中国第一个企服评测及商务社交产业平台。
页:
[1]