OpenTracing 中 HTTP 状态码重复记录问题的解决方案

本文介绍如何解决 opentracing 中 `http.status_code` 标签被重复写入（一次为字符串、一次为整数）的问题，核心方法是配置 `tracingpolicy.ignore` 以禁用自动

http 状态码注入。

在基于 io.opentracing 的分布式追踪实践中，开发者常通过手动设置 Tags.HTTP_STATUS_CODE.set(span, statusCode) 来记录 HTTP 状态码。然而，若底层 Tracer（如 Jaeger、Zipkin 的 OpenTracing 封装实现）同时启用了自动 HTTP 标签注入机制（例如通过 HttpServerTracing 或 HttpClientTracing 拦截器），就会导致 http.status_code 被写入两次：一次由业务代码显式设置为整型（如 200），另一次由框架自动注入为字符串（如 "200"）。这不仅造成数据冗余，还可能影响下游监控系统（如 Prometheus、ELK）对状态码字段的类型解析与聚合。

根本原因在于 OpenTracing 生态中部分 Tracer 实现（尤其是与 Spring Cloud Sleuth 或某些 HTTP 自动埋点库集成时）默认启用 TracingPolicy.DEFAULT，该策略会主动从 HttpServletResponse 或 HttpRequest 中提取状态码并以字符串形式打标。而业务层又习惯性调用：

import io.opentracing.tag.Tags;
// ...
Tags.HTTP_STATUS_CODE.set(span, 200); // ✅ 正确：传入 int 类型

此时两者叠加，便出现类型不一致的重复标签。

解决方案：显式配置 TracingPolicy.IGNORE

在初始化 Tracer 或构建 HTTP 自动埋点组件时，禁用框架自动注入状态码的行为，将控制权完全交还给业务代码：

// 示例：使用 Jaeger Tracer + HttpTracing（如 Brave 或 OpenTracing Contrib）
HttpTracing httpTracing = HttpTracing.newBuilder(tracer)
    .serverParser(new HttpServerParser() {
        @Override
        public void parseRequest(HttpServerRequest request, Span span) {
            // 手动解析 URL、Method 等，但跳过 status_code
            Tags.HTTP_URL.set(span, request.url());
            Tags.HTTP_METHOD.set(span, request.method().name());
        }

        @Override
        public void parseResponse(HttpServerResponse response, Span span) {
            // ✅ 不调用 super.parseResponse(...)，避免自动写入 http.status_code
            // 由业务逻辑统一设置：Tags.HTTP_STATUS_CODE.set(span, response.statusCode());
        }
    })
    .policy(TracingPolicy.IGNORE) // ⚠️ 关键：禁用自动标签注入
    .build();

注意事项：TracingPolicy.IGNORE 并非所有 OpenTracing 库原生支持，需确认所用 Tracer 版本（如 opentracing-contrib/java-web-servlet-filter v0.3.0+ 或 brave-instrumentation-http 支持该策略）；启用后，务必在业务逻辑中显式、且仅一次调用 Tags.HTTP_STATUS_CODE.set(span, intStatusCode)，推荐在请求处理完成、响应已确定之后执行；若使用 Spring Boot + Sleuth，可通过配置 spring.sleuth.web.skip-pattern=.* 或自定义 TracingFilter 替换默认行为，本质仍是绕过自动状态码采集。

总结：重复的 http.status_code 标签源于“手动设置”与“框架自动注入”的双重写入。通过 TracingPolicy.IGNORE 关闭自动注入，并统一由业务侧以整型方式设置，即可确保标签类型一致、结构规范，符合 OpenTracing 规范中对 http.status_code 应为整数的语义要求。