如何通过Azure.Monitor.OpenTelemetry.AspNetCore基于自定义HTTP标头设置请求的操作ID

刚好我之前也碰到过一模一样的需求——不想修改上游服务的自定义correlation-id标头，直接用它作为Azure Monitor里的操作ID。用Azure.Monitor.OpenTelemetry.AspNetCore包实现的核心思路是：通过自定义中间件修改OpenTelemetry依赖的Activity对象的TraceId，因为Azure Monitor的追踪数据就是基于这个Activity来采集的。

下面是具体的实现步骤：

1. 创建自定义Correlation ID中间件 #

这个中间件会在请求进入时读取correlation-id标头，然后替换当前请求的Activity TraceId：

public class CustomCorrelationIdMiddleware
{
    private readonly RequestDelegate _next;

    public CustomCorrelationIdMiddleware(RequestDelegate next)
    {
        _next = next;
    }

    public async Task InvokeAsync(HttpContext context)
    {
        // 尝试从请求头中读取自定义correlation-id
        if (context.Request.Headers.TryGetValue("correlation-id", out var correlationIdValue) 
            && !string.IsNullOrWhiteSpace(correlationIdValue))
        {
            var correlationId = correlationIdValue.ToString().Trim();
            // 处理可能的格式问题：如果上游是GUID带分隔符，先去掉分隔符
            var cleanedId = correlationId.Replace("-", string.Empty);
            
            // 验证格式是否符合W3C TraceId要求（32位十六进制字符串）
            if (ActivityTraceId.TryParse(cleanedId, out var traceId))
            {
                var currentActivity = Activity.Current;
                if (currentActivity != null)
                {
                    // Activity的TraceId是只读的，所以需要创建新Activity替换当前实例
                    var newActivity = new Activity(currentActivity.OperationName)
                    {
                        TraceId = traceId,
                        SpanId = currentActivity.SpanId,
                        ParentSpanId = currentActivity.ParentSpanId,
                        ActivitySource = currentActivity.ActivitySource
                    };

                    // 启动新Activity并继续管道
                    using (newActivity.Start())
                    {
                        await _next(context);
                    }
                }
                else
                {
                    // 如果当前没有Activity，直接创建带自定义TraceId的新Activity
                    using (var activity = new Activity("IncomingRequest") { TraceId = traceId }.Start())
                    {
                        await _next(context);
                    }
                }
                return;
            }
        }

        // 如果没有有效自定义标头，走默认追踪逻辑
        await _next(context);
    }
}

// 扩展方法，方便注册中间件
public static class CustomCorrelationIdMiddlewareExtensions
{
    public static IApplicationBuilder UseCustomCorrelationId(this IApplicationBuilder app)
    {
        return app.UseMiddleware<CustomCorrelationIdMiddleware>();
    }
}

2. 在Program.cs中注册中间件和OpenTelemetry #

注意：中间件的注册顺序很重要，必须放在UseRouting之前，确保在OpenTelemetry采集请求数据前就完成TraceId的替换

var builder = WebApplication.CreateBuilder(args);

// 注册OpenTelemetry追踪服务
builder.Services.AddOpenTelemetry()
    .WithTracing(tracingBuilder => tracingBuilder
        .AddAspNetCoreInstrumentation(options =>
        {
            // 这里可以保留你的原有配置，比如过滤请求、记录异常等
            options.RecordException = true;
            options.Filter = httpContext => HttpMethods.IsGet(httpContext.Request.Method);
        })
        .AddAzureMonitorTraceExporter(exporterOptions =>
        {
            exporterOptions.ConnectionString = builder.Configuration["APPLICATIONINSIGHTS_CONNECTION_STRING"];
        }));

var app = builder.Build();

// 注册自定义Correlation ID中间件，务必放在UseRouting之前
app.UseCustomCorrelationId();

app.UseRouting();

// 其他请求管道配置（比如端点、授权等）
app.MapGet("/", () => "Hello World!");

app.Run();

为什么这个方案有效？ #

Azure.Monitor.OpenTelemetry.AspNetCore是基于OpenTelemetry的Activity模型来采集追踪数据的，当我们替换了请求对应的Activity的TraceId后，这个值会被自动作为Azure Monitor中的**操作ID（Operation ID）**上报，完全替代默认的traceparent标头生成的TraceId，完美适配你上游服务的自定义标头需求。

备注：内容来源于stack exchange，提问作者Shuzheng