如何在.NET 5 Web API响应中转发分布式追踪traceparent头？

1. 分布式追踪头默认不返回的原因 #

W3C traceparent 规范没有强制要求服务端在响应中返回追踪头，.NET 默认实现不返回主要有几个考虑：

• 链路数据默认通过采集端上报到统一的可观测平台，不需要透传给客户端，避免增加不必要的响应开销
• 避免内部链路标识泄露给不可信客户端，降低安全风险
• 追踪头属于链路治理的元数据，不属于业务响应的必要字段，默认不会额外追加

2. 实现响应返回traceparent的方法 #

ASP.NET Core 处理请求时会自动初始化和当前请求绑定的Activity对象，直接读取该对象的Id即可得到符合规范的traceparent值，不需要手动拼接。最通用的实现方式是注入全局中间件：

// 注意该中间件需要放在 UseRouting 之前，确保能拿到已初始化的 Activity
app.Use(async (context, next) =>
{
    var currentActivity = Activity.Current;
    if (currentActivity != null)
    {
        context.Response.Headers["traceparent"] = currentActivity.Id;
    }
    await next();
});

如果是局部接口需要返回，也可以直接在控制器中追加：

[HttpGet]
public async Task<IActionResult> TestApi()
{
    if(Activity.Current != null)
    {
        Response.Headers.Append("traceparent", Activity.Current.Id);
    }
    // 业务逻辑
    return Ok();
}

如果涉及跨域请求，需要额外在CORS配置中暴露该响应头，否则客户端无法读取：

builder.Services.AddCors(opt =>
{
    opt.AddPolicy("允许跨域", policy =>
    {
        policy.AllowAnyOrigin()
              .AllowAnyHeader()
              .AllowAnyMethod()
              // 暴露traceparent头给客户端
              .WithExposedHeaders("traceparent");
    });
});

3. 用法合理性说明 #

你当前客户端的Activity初始化逻辑没有问题，除了手动加响应头的方案，也可以选择更标准的可观测方案：

• 客户端和服务端都接入OpenTelemetry，配置自动上报链路数据到统一观测平台，不需要手动透传链路头就能实现全链路关联
• 如果只需要客户端简单关联日志，也可以选择将traceId放到响应体的通用返回结构中，比读取响应头更便捷

内容的提问来源于stack exchange，提问作者Kasbolat Kumakhov