ASP.NET MVC 5/6实现W3C TraceId自动传播的方案咨询

一、是否必须使用 OWIN？ #

不需要。ASP.NET MVC 5/Web API 有内置机制可以在控制器执行前运行代码，比如HttpModule或全局动作过滤器。但如果你已经尝试 OWIN 方案，我们先解决你当前的问题，再提供非 OWIN 替代方案。

二、修复你的 OWIN 中间件问题 #

你的代码出现 Activity.Current 和 GetOwinContext() 为 null 的核心原因是OWIN 与 Web API 的集成不完整，以及 Activity 生命周期管理不当。

1. 安装必要的 NuGet 包 #

确保项目已安装以下包：

• Microsoft.Owin.Host.SystemWeb：让 OWIN 能在 IIS 的 System.Web 管道中运行
• Microsoft.AspNet.WebApi.Owin：实现 Web API 与 OWIN 的集成
• System.Diagnostics.DiagnosticSource：提供 Activity 相关支持

2. 修正中间件代码 #

调整 Activity 的创建、父上下文解析和生命周期管理：

public void Configuration(IAppBuilder app)
{
    Activity.DefaultIdFormat = ActivityIdFormat.W3C;
    
    app.Use(async (ctx, next) =>
    {
        ActivityContext activityCtx = default;
        string traceparent = ctx.Request.Headers.Get("traceparent");
        
        if (!string.IsNullOrEmpty(traceparent))
        {
            try
            {
                string tracestate = ctx.Request.Headers.Get("tracestate");
                if (ActivityContext.TryParse(traceparent, tracestate, out var parsedCtx))
                {
                    activityCtx = parsedCtx;
                }
            }
            catch { }
        }

        // 使用 using 确保 Activity 正确释放，维持 AsyncLocal 上下文
        using (var activity = new Activity("ReceiveHttpRequest"))
        {
            if (activityCtx != default)
            {
                activity.SetParentId(activityCtx);
            }
            activity.Start();

            ctx.Environment["traceparent"] = traceparent;
            await next();
        }
    });

    var config = new HttpConfiguration();
    config.MapHttpAttributeRoutes();
    app.UseWebApi(config);
}

3. 验证 OWIN 集成配置 #

在 web.config 中添加 OWIN 模块注册：

<system.webServer>
  <modules>
    <add name="Owin" type="Microsoft.Owin.Host.SystemWeb.OwinHttpModule, Microsoft.Owin.Host.SystemWeb" />
  </modules>
</system.webServer>

完成以上步骤后，Activity.Current 和 Request.GetOwinContext() 应该能在控制器中正常获取值。

三、非 OWIN 替代方案 #

如果你不想使用 OWIN，以下两种方案可以实现相同功能：

方案 1：HttpModule（全局请求拦截） #

创建自定义 HttpModule 拦截所有请求，在请求开始时初始化 Activity：

public class TraceIdModule : IHttpModule
{
    public void Init(HttpApplication context)
    {
        context.BeginRequest += OnBeginRequest;
        context.EndRequest += OnEndRequest;
    }

    private void OnBeginRequest(object sender, EventArgs e)
    {
        var app = (HttpApplication)sender;
        string traceparent = app.Request.Headers["traceparent"];
        ActivityContext activityCtx = default;

        if (!string.IsNullOrEmpty(traceparent))
        {
            try
            {
                string tracestate = app.Request.Headers["tracestate"];
                if (ActivityContext.TryParse(traceparent, tracestate, out var parsedCtx))
                {
                    activityCtx = parsedCtx;
                }
            }
            catch { }
        }

        var activity = new Activity("ReceiveHttpRequest");
        if (activityCtx != default)
        {
            activity.SetParentId(activityCtx);
        }
        activity.Start();

        // 存储 Activity 以便请求结束时释放
        app.Context.Items["CurrentActivity"] = activity;
    }

    private void OnEndRequest(object sender, EventArgs e)
    {
        var app = (HttpApplication)sender;
        if (app.Context.Items.TryGetValue("CurrentActivity", out var obj) && obj is Activity activity)
        {
            activity.Dispose();
        }
    }

    public void Dispose() { }
}

在 web.config 中注册模块：

<system.web>
  <httpModules>
    <add name="TraceIdModule" type="ActivityDemo.TraceIdModule, ActivityDemo" />
  </httpModules>
</system.web>
<system.webServer>
  <modules>
    <add name="TraceIdModule" type="ActivityDemo.TraceIdModule, ActivityDemo" preCondition="managedHandler" />
  </modules>
</system.webServer>

方案 2：Web API 全局动作过滤器 #

仅针对 Web API 控制器执行前初始化 Activity：

public class TraceIdActionFilter : ActionFilterAttribute
{
    private static readonly AsyncLocal<Activity> _currentActivity = new AsyncLocal<Activity>();

    public override void OnActionExecuting(HttpActionContext actionContext)
    {
        string traceparent = actionContext.Request.Headers.GetValues("traceparent")?.FirstOrDefault();
        ActivityContext activityCtx = default;

        if (!string.IsNullOrEmpty(traceparent))
        {
            try
            {
                string tracestate = actionContext.Request.Headers.GetValues("tracestate")?.FirstOrDefault();
                if (ActivityContext.TryParse(traceparent, tracestate, out var parsedCtx))
                {
                    activityCtx = parsedCtx;
                }
            }
            catch { }
        }

        var activity = new Activity("ReceiveHttpRequest");
        if (activityCtx != default)
        {
            activity.SetParentId(activityCtx);
        }
        activity.Start();

        _currentActivity.Value = activity;
        base.OnActionExecuting(actionContext);
    }

    public override void OnActionExecuted(HttpActionExecutedContext actionExecutedContext)
    {
        if (_currentActivity.Value != null)
        {
            _currentActivity.Value.Dispose();
            _currentActivity.Value = null;
        }
        base.OnActionExecuted(actionExecutedContext);
    }
}

在 WebApiConfig.cs 中注册过滤器：

public static class WebApiConfig
{
    public static void Register(HttpConfiguration config)
    {
        config.Filters.Add(new TraceIdActionFilter());
        // 其他 Web API 配置...
    }
}

四、关键注意事项 #

• Activity 生命周期：必须确保 Activity 在请求结束时被释放，避免资源泄漏和上下文混乱。
• AsyncLocal 上下文：Activity.Current 基于 AsyncLocal<T> 实现，会自动在 async/await 调用中保留上下文。
• 日志集成：配置完成后，Serilog 等日志框架可以自动提取 Activity.Current 中的 TraceId 加入日志（需安装对应 enricher 包）。

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