总结：Springboot 2.1监控Actuator相关

一、介绍

Actuator是Springboot提供的用来对应用系统进行监控的功能模块，借助于Actuator开发者可以很方便地对应用系统某些监控指标进行查看、统计等。

Actuator 的核心是端点Endpoint。

Endpoint可以让我们监视应用程序并与其交互。SpringBoot包含许多内置端点，并允许您添加自己的端点。

我们可以启用或禁用每个端点，启用或禁用端点控制是否创建端点并且其bean存在于应用程序上下文中。要进行远程访问，还必须通过JMX或HTTP公开端点。大多数断点HTTP访问默认是关闭的。

二、启用与暴露的区别

启用端点：会创建对应的bean并进行数据采集（但是未必会暴露）

暴露：是在启用的前提下，暴露是指对外可以访问到这些数据

三、endpoints端点介绍 1、端点介绍

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

如果您的应用程序是Web应用程序（Spring MVC，Spring WebFlux或Jersey），则可以使用以下附加端点：

ID	描述	默认情况下是否启用
heapdump	返回一个hprof堆转储文件。	Yes
jolokia	通过HTTP公开JMX bean（当Jolokia在类路径上时，不适用于WebFlux）。	Yes
logfile	返回日志文件的内容（如果已设置logging.file或logging.path属性）。支持使用HTTP Range标头来检索部分日志文件的内容。	Yes
prometheus	以Prometheus服务器可以抓取的格式公开指标。	Yes

2、启用端点

要配置端点的启用，请使用management.endpoint.xxx.enabled属性。以下示例启用关闭端点：

management.endpoint.shutdown.enabled=true

如果您希望端点启用是选择加入而不是选择退出，请将management.endpoints.enabled-by-default属性设置为false，并使用启用了各个端点的属性重新加入。以下示例启用info端点并禁用所有其他端点：

management.endpoints.enabled-by-default=false
management.endpoint.info.enabled=true

四、端点的默认暴露规则

由于端点可能包含敏感信息，因此应仔细考虑何时公开它们。下表显示了内置端点的默认暴露规则：

ID	JMX	Web
auditevents	Yes	No
beans	Yes	No
caches	Yes	No
conditions	Yes	No
configprops	Yes	No
env	Yes	No
flyway	Yes	No
health	Yes	Yes
heapdump	N/A	No
httptrace	Yes	No
info	Yes	Yes
integrationgraph	Yes	No
jolokia	N/A	No
logfile	N/A	No
loggers	Yes	No
liquibase	Yes	No
metrics	Yes	No
mappings	Yes	No
prometheus	N/A	No
scheduledtasks	Yes	No
sessions	Yes	No
shutdown	Yes	No
threaddump	Yes	No

要更改公开的端点，请使用以下特定于技术的包含和排除属性：

Property	Default
management.endpoints.jmx.exposure.exclude
management.endpoints.jmx.exposure.include	*
management.endpoints.web.exposure.exclude
management.endpoints.web.exposure.include	info, health

案例：

#endpoints配置
management.endpoints.web.exposure.include=info,health,metrics,prometheus,threaddump,mappings,beans,loggers,autoconfig
management.metrics.tags.application=${spring.application.name}

*可用于选择所有端点。

例如：要通过HTTP公开除env和beans端点之外的所有内容：

management.endpoints.web.exposure.include=*
management.endpoints.web.exposure.exclude=env,beans

参考：5.2 Endpoints - Spring Boot 参考文档 v2.1 - 文江博客

总结：Springboot 2.1监控Actuator相关

Java相关栏目本月热门文章