如何采集Jar包内Micrometer指标到Spring Boot并上报Datadog

基于Spring Boot 2.4.4版本，可按以下步骤实现指标上报：

• 引入所需依赖
  主应用的pom.xml中添加Actuator和Datadog注册中心依赖，版本跟随Spring Boot 2.4.4内置的Micrometer版本即可，无需手动指定：

  <dependency>
      <groupId>org.springframework.boot</groupId>
      <artifactId>spring-boot-starter-actuator</artifactId>
  </dependency>
  <dependency>
      <groupId>io.micrometer</groupId>
      <artifactId>micrometer-registry-datadog</artifactId>
  </dependency>
  

• 配置Datadog上报参数
  在application.yml中补充Datadog连接配置：

  management:
    endpoints:
      web:
        exposure:
          include: "*"
    metrics:
      enable:
        all: true
      export:
        datadog:
          enabled: true
          api-key: 替换为实际Datadog账号的API Key
          application-key: 替换为实际Datadog账号的Application Key
          step: 1m # 指标上报周期，可根据业务需求调整
  

• 独立Jar包的指标注册规范
  Jar包内的Micrometer Timer必须注册到Spring容器管理的MeterRegistry实例上，禁止手动new独立的Registry实例。参考实现：

  // Jar包内的业务类通过构造器注入MeterRegistry
  @Component
  public class BusinessProcessService {
      private final Timer processTimer;
  
      // 直接注入Spring托管的MeterRegistry
      public BusinessProcessService(MeterRegistry meterRegistry) {
          this.processTimer = Timer.builder("business.process.duration")
                  .publishPercentiles(0.5, 0.95, 0.99)
                  .description("业务链路执行耗时")
                  .register(meterRegistry);
      }
  
      public void executeProcess() {
          // 业务逻辑执行时用Timer记录耗时
          processTimer.record(() -> {
              // 实际业务代码
          });
      }
  }
  

按优先级依次排查以下问题：

• 检查Bean扫描范围
  Spring Boot默认仅扫描启动类所在包及其子包下的Bean，如果独立Jar包的类路径不在扫描范围内，Jar包内的指标注册逻辑不会执行。两种解决方式：
  1. 主应用启动类添加@ComponentScan注解，指定独立Jar包的根包路径
  2. 在独立Jar包的resources/META-INF/spring.factories文件中注册自动配置类，无需主应用手动扫描：

     org.springframework.boot.autoconfigure.EnableAutoConfiguration=\
     com.your.custom.jar.config.MetricsAutoConfiguration
     

• 检查MeterRegistry实例是否唯一
  如果Jar包内手动创建了SimpleMeterRegistry等非Spring托管的Registry实例注册Timer，指标不会同步到Spring Boot的全局Registry，Actuator端点自然无法识别。所有指标必须注册到Spring注入的MeterRegistry实例上。
• 检查指标是否被实际调用
  Micrometer中仅完成注册、从未执行过record等记录操作的Timer，不会被纳入指标列表返回。可手动触发一次对应业务链路，再访问端点验证。
• 检查全局注册表配置
  确认management.metrics.use-global-registry配置未被手动设置为false，该参数默认值为true，关闭后会导致Spring托管的Registry无法收集全局指标。

内容的提问来源于stack exchange，提问作者Shivansh shandilya