解决Spring Boot Actuator升级后Tomcat指标缺失问题

Spring Boot Actuator与Tomcat指标监控

spring boot actuator为spring boot应用程序提供了强大的生产级特性，其中包括对应用内部指标的监控。通过集成micrometer，actuator能够自动收集各种运行时指标，例如jvm、cpu、http请求以及web服务器（如tomcat）的性能数据。这些指标对于理解应用程序的健康状况和性能瓶颈至关重要。

在早期版本的Spring Boot Actuator中，许多Tomcat相关的详细指标，如缓存命中率、全局错误计数等，通常会自动暴露在/actuator/metrics端点下，并以tomcat.cache.access、tomcat.global.error等形式呈现。这些指标通常依赖于Tomcat内部的JMX MBean机制来收集。

Actuator升级后的Tomcat指标缺失问题

然而，当spring-boot-starter-actuator版本升级到2.7.0或更高版本时，部分用户可能会发现这些原本可用的Tomcat详细指标突然从MetricsEndpoint中消失了。例如，以下指标可能不再显示：

• tomcat.cache.access
• tomcat.cache.hit
• tomcat.global.error
• tomcat.global.sent
• tomcat.servlet.error
• tomcat.threads.current

这种现象的发生，通常是由于新版本Actuator在默认配置上有所调整，或者对Tomcat MBean的发现机制不再默认启用。

解决方案：启用Tomcat MBean注册

要解决此问题，核心在于显式地启用Tomcat的MBean注册功能。Spring Boot提供了一个配置属性来控制这一行为。

在您的application.properties或application.yml文件中添加以下配置：

# application.properties
server.tomcat.mbeanregistry.enabled=true

或者，如果您使用application.yml：

# application.yml
server:
  tomcat:
    mbeanregistry:
      enabled: true

添加并保存此配置后，重新启动您的Spring Boot应用程序。

神卷标书

神卷标书，专注于AI智能标书制作、管理与咨询服务，提供高效、专业的招投标解决方案。支持一站式标书生成、模板下载，助力企业轻松投标，提升中标率。

39

查看详情

原理阐述

server.tomcat.mbeanregistry.enabled=true配置的作用是：

1. 启用Tomcat MBean注册： Tomcat内部的许多组件（如连接器、线程池、缓存等）会将其运行时状态通过Java Management Extensions (JMX) 暴露为Managed Beans (MBeans)。当此属性设置为true时，Tomcat会确保这些MBeans被注册到JVM的平台MBeanServer中。
2. Actuator通过Micrometer采集： Spring Boot Actuator通过其集成的Micrometer库来收集指标。Micrometer能够发现并适配各种指标源，包括JMX MBeans。当Tomcat的MBeans被注册后，Micrometer就能通过JMX接口访问这些MBeans，并将其中的数据转换为标准的指标格式，最终通过/actuator/metrics端点暴露出来。

简而言之，此配置确保了Tomcat的内部状态能够以JMX MBean的形式被Actuator发现和采集，从而恢复了之前缺失的详细Tomcat指标。

验证方法

配置更改并重启应用程序后，您可以通过以下方式验证Tomcat指标是否已恢复：

1. 访问Actuator Metrics端点： 在浏览器或使用curl工具访问/actuator/metrics端点。您应该能看到包含tomcat前缀的指标列表。

   curl http://localhost:8080/actuator/metrics

   登录后复制
2. 查询特定Tomcat指标： 访问/actuator/metrics/{metricName}来查看特定指标的详细信息，例如：

   curl http://localhost:8080/actuator/metrics/tomcat.cache.access

   登录后复制

   如果指标已恢复，您将看到相应的指标数据。

注意事项

• 版本兼容性： 此配置对于Spring Boot 2.7.0及更高版本解决此类Tomcat指标缺失问题是有效的。在不同版本中，Spring Boot对默认配置的调整可能有所不同，但启用MBean注册通常是获取Tomcat详细JMX指标的通用方法。
• 性能影响： 启用Tomcat MBean注册通常对应用程序性能影响微乎其微，因为JMX MBean的注册和访问机制本身是为生产环境监控设计的。
• 全面监控： 确保除了Tomcat指标外，其他关键的应用指标（如JVM、数据库连接池、自定义业务指标等）也都被Actuator正确收集和暴露，以构建全面的监控体系。

总结

当Spring Boot Actuator升级导致Tomcat详细指标缺失时，通过在application.properties中简单添加server.tomcat.mbeanregistry.enabled=true配置，即可有效解决问题。此配置重新激活了Tomcat的JMX MBean注册机制，使Actuator能够重新发现并暴露这些重要的运行时指标。这对于维护应用程序的健康和性能监控至关重要，确保开发者和运维人员能够全面掌握Tomcat作为Web服务器的内部运行状态。

以上就是解决Spring Boot Actuator升级后Tomcat指标缺失问题的详细内容，更多请关注php中文网其它相关文章！