如何通过OpenTelemetry Collector和Java Agent为默认指标添加自定义标签

针对你在Spring Boot插件场景下，需要给OpenTelemetry（OTel）生成的默认指标添加自定义标签的需求，以下是经过验证的可行方案：

方案1：通过OTel Java Agent配置文件添加静态全局标签 #

这是最简单的无代码方案，适合添加固定值的标签，会自动应用到所有指标（包括OTel默认指标和你的自定义指标）。

配置步骤： #

1. 创建或修改OTel Agent的配置文件（支持otel.properties或otel.yaml格式）
2. 添加全局资源属性：

   # otel.properties示例
   otel.resource.attributes=service.name=你的主服务名,plugin.name=你的SpringBoot插件标识,env=生产环境
   

   或YAML格式：

   # otel.yaml示例
   otel:
     resource:
       attributes:
         - key: service.name
           value: "你的主服务名"
         - key: plugin.name
           value: "你的SpringBoot插件标识"
         - key: env
           value: "生产环境"
   

3. 启动应用时指定配置文件路径：

   java -javaagent:opentelemetry-javaagent.jar -Dotel.config.file=./otel.properties -jar 你的应用.jar
   

方案2：通过自定义Spring Bean动态修改指标标签 #

适合需要从Spring上下文、环境变量或业务逻辑中动态获取标签值的场景，仅需在你的Spring Boot插件中添加配置类：

步骤1：确保依赖版本匹配 #

确认你的插件依赖的OTel API/SDK版本与Java Agent版本一致（参考你的依赖截图版本）：

<dependency>
    <groupId>io.opentelemetry</groupId>
    <artifactId>opentelemetry-api</artifactId>
    <version>1.32.0</version> <!-- 替换为你的Agent版本 -->
</dependency>
<dependency>
    <groupId>io.opentelemetry</groupId>
    <artifactId>opentelemetry-sdk-metrics</artifactId>
    <version>1.32.0</version>
</dependency>

步骤2：编写自定义标签配置类 #

import io.opentelemetry.sdk.metrics.SdkMeterProvider;
import io.opentelemetry.sdk.metrics.view.View;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

@Configuration
public class OtelCustomTagConfig {

    // 可从Spring配置文件动态注入标签值
    @Value("${plugin.custom.tag}")
    private String customTagValue;

    @Bean
    public SdkMeterProvider customMeterProvider(SdkMeterProvider defaultMeterProvider) {
        // 创建视图，为所有默认指标添加自定义标签
        View customTagView = View.builder()
                .setAttributesProcessor(attributes -> attributes.toBuilder()
                        .put("plugin_custom_tag", customTagValue)
                        .put("plugin_version", "1.0.0") // 固定值标签
                        .build())
                .build();

        return defaultMeterProvider.toBuilder()
                .registerView(customTagView)
                .build();
    }
}

方案3：通过OTel Collector统一添加标签 #

如果你的指标是通过OTel Collector上报的，可在Collector层面统一为所有指标添加标签，无需修改应用代码：

修改Collector配置文件（otel-collector-config.yaml）： #

processors:
  # 定义添加自定义标签的处理器
  attributes/add_plugin_tags:
    actions:
      - key: plugin_name
        value: "你的SpringBoot插件标识"
        action: insert
      - key: env
        value: "生产环境"
        action: insert

service:
  pipelines:
    metrics:
      receivers: [otlp]
      processors: [attributes/add_plugin_tags] # 启用标签处理器
      exporters: [你的目标 exporter（如Sumologic）]

原Sumologic方案失效排查 #

如果你之前尝试的Sumologic方案无效，大概率是以下原因：

• OTel Agent版本与Sumologic文档要求的版本不兼容
• 配置属性名错误（需使用标准OTel属性otel.resource.attributes而非Sumologic特定配置）
• Collector配置未正确关联处理器到指标 pipeline

内容的提问来源于stack exchange，提问作者Gavin Fernando