ASP.NET Core中Serilog日志缺失Correlation ID问题求助

1. 修正CorrelationIdMiddleware的LogContext作用域 #

当前中间件中LogContext.PushProperty没有用using包裹，会导致请求结束后LogContext属性未被清理，同时无法确保请求全生命周期（包括响应阶段的日志）都能获取到Correlation ID。修改代码如下：

public async Task Invoke(HttpContext context, ICorrelationIdService correlationIdService)
{
    context.Request.Headers.TryGetValue(Constants.CORRELATION_ID_HEADER_NAME, out var correlationId);
    correlationIdService.Set(correlationId);
    context.Request.Headers.TryAdd(Constants.CORRELATION_ID_HEADER_NAME, correlationIdService.CorrelationId);

    // 使用using包裹，确保请求结束后自动清理LogContext属性
    using (LogContext.PushProperty(Constants.CORRELATION_ID, correlationIdService.CorrelationId))
    {
        await _next(context);
    }
}

2. 调整中间件注册顺序 #

中间件按注册顺序执行，必须让CorrelationIdMiddleware成为第一个被注册的中间件，这样ASP.NET Core的请求开始/结束日志（以及所有后续中间件的日志）都能获取到Correlation ID。修改Startup中的中间件注册顺序：

var app = builder.Build();

// 将外部日志中间件移到最顶部，确保CorrelationIdMiddleware最先执行
app.UseExternalLogging();

if (app.Environment.IsDevelopment())
{
    app.UseDeveloperExceptionPage();
    app.UseMigrationsEndPoint();
}
else
{
    app.UseHsts();
}

// 其他中间件依次注册
app.UseHttpsRedirection();
app.UseRouting();

// ... 后续路由、控制器映射代码

3. 适配Service Bus场景的Correlation ID传递 #

Service Bus消息不属于HTTP请求，需要在消息处理入口手动注入Correlation ID到LogContext和ICorrelationIdService：

public async Task ProcessMessageAsync(ProcessMessageEventArgs args)
{
    // 从消息属性获取Correlation ID，不存在则生成新的
    var correlationId = args.Message.ApplicationProperties.TryGetValue(Constants.CORRELATION_ID, out var id) 
        ? id.ToString() 
        : Guid.NewGuid().ToString();

    var correlationIdService = args.ServiceProvider.GetRequiredService<ICorrelationIdService>();
    correlationIdService.Set(correlationId);

    // 同样用using包裹LogContext，确保消息处理全周期的日志都带ID
    using (LogContext.PushProperty(Constants.CORRELATION_ID, correlationId))
    {
        Log.Information("处理Service Bus消息，Correlation ID: {CorrelationId}", correlationId);
        // 执行消息处理逻辑
        await args.CompleteMessageAsync(args.Message);
    }
}

4. 确保Serilog请求日志中间件顺序正确 #

如果使用了Serilog.AspNetCore的UseSerilogRequestLogging()，需要将其注册在CorrelationIdMiddleware之后，这样请求日志能自动带上Correlation ID。修改日志扩展方法：

public static WebApplication UseExternalLogging(this WebApplication webApplication)
{
    // 先注册Correlation中间件
    webApplication.UseMiddleware<CorrelationIdMiddleware>();
    // 再注册Serilog请求日志中间件
    webApplication.UseSerilogRequestLogging();
    webApplication.UseHeaderPropagation();

    return webApplication;
}

5. 验证日志模板包含Correlation ID #

在Serilog配置中确保输出模板包含{CorrelationId}，比如在appsettings.json中：

"Serilog": {
  "WriteTo": [
    {
      "Name": "Console",
      "Args": {
        "outputTemplate": "[{Timestamp:HH:mm:ss} {Level:u3}] {Message:lj} | Correlation ID: {CorrelationId}{NewLine}{Exception}"
      }
    }
  ]
}

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