如何自动将ASP.NET的TraceIdentifier写入日志以归集单请求日志？

一、通过中间件注入TraceIdentifier到日志作用域 #

这是最通用的方案，能让整个请求周期内的所有日志自动带上TraceId，适配内置ILogger及多数日志框架。

实现代码：

public class TraceIdentifierMiddleware
{
    private readonly RequestDelegate _next;
    private readonly ILogger<TraceIdentifierMiddleware> _logger;

    public TraceIdentifierMiddleware(RequestDelegate next, ILogger<TraceIdentifierMiddleware> logger)
    {
        _next = next;
        _logger = logger;
    }

    public async Task InvokeAsync(HttpContext context)
    {
        var traceId = context.TraceIdentifier;
        // 将TraceId注入日志作用域，后续所有日志都会自动包含该字段
        using (_logger.BeginScope(new Dictionary<string, object> { ["TraceId"] = traceId }))
        {
            await _next(context);
        }
    }
}

// 扩展方法用于注册中间件
public static class TraceIdentifierMiddlewareExtensions
{
    public static IApplicationBuilder UseTraceIdentifierLogging(this IApplicationBuilder app)
    {
        return app.UseMiddleware<TraceIdentifierMiddleware>();
    }
}

使用方式：在Program.cs的管道配置中，将此中间件放在最靠前的位置（早于其他业务中间件）：

var app = builder.Build();
app.UseTraceIdentifierLogging();
// 其他中间件注册...
app.Run();

二、Serilog框架直接集成TraceIdentifier #

如果项目使用Serilog作为日志框架，可通过配置直接提取TraceId，无需手动编写中间件：

1. 先安装依赖包Serilog.AspNetCore
2. 在Program.cs中配置：

var builder = WebApplication.CreateBuilder(args);

builder.Host.UseSerilog((ctx, config) => config
    .WriteTo.Console(outputTemplate: "[{Timestamp:HH:mm:ss} {Level:u3}] {TraceId} {Message:lj}{NewLine}{Exception}")
    .Enrich.FromLogContext()
    // 从HttpContext提取TraceIdentifier并添加到日志字段
    .Enrich.WithAspNetCoreHttpContext(ctx => ctx.TraceIdentifier, "TraceId"));

// 启用Serilog请求日志，确保TraceId自动关联
builder.Services.AddSerilogRequestLogging(options =>
{
    options.EnrichDiagnosticContext = (diagnosticContext, httpContext) =>
    {
        diagnosticContext.Set("TraceId", httpContext.TraceIdentifier);
    };
});

var app = builder.Build();
// 其他配置...
app.Run();

配置完成后，所有日志条目都会自动带上TraceId字段，直接用于请求日志归集。

三、自定义日志提供器（进阶定制场景） #

如果需要完全自定义日志输出逻辑，可以实现自己的日志提供器，自动在每条日志中附加TraceId：

public class TraceIdLoggerProvider : ILoggerProvider
{
    private readonly IHttpContextAccessor _httpContextAccessor;

    public TraceIdLoggerProvider(IHttpContextAccessor httpContextAccessor)
    {
        _httpContextAccessor = httpContextAccessor;
    }

    public ILogger CreateLogger(string categoryName)
    {
        return new TraceIdLogger(_httpContextAccessor, categoryName);
    }

    public void Dispose() { }
}

public class TraceIdLogger : ILogger
{
    private readonly IHttpContextAccessor _httpContextAccessor;
    private readonly string _categoryName;

    public TraceIdLogger(IHttpContextAccessor httpContextAccessor, string categoryName)
    {
        _httpContextAccessor = httpContextAccessor;
        _categoryName = categoryName;
    }

    public IDisposable BeginScope<TState>(TState state) => default!;

    public bool IsEnabled(LogLevel logLevel) => true;

    public void Log<TState>(LogLevel logLevel, EventId eventId, TState state, Exception? exception, Func<TState, Exception?, string> formatter)
    {
        // 获取当前请求的TraceId，无上下文时标记为Unknown
        var traceId = _httpContextAccessor.HttpContext?.TraceIdentifier ?? "UnknownTraceId";
        var finalMessage = $"[{traceId}] {formatter(state, exception)}";
        
        // 这里替换为实际的日志输出逻辑（如写入文件、数据库等）
        Console.WriteLine($"[{DateTime.Now:HH:mm:ss}] {logLevel} [{_categoryName}] {finalMessage}");
    }
}

注册方式：在Program.cs中添加服务注册：

builder.Services.AddSingleton<ILoggerProvider, TraceIdLoggerProvider>();
builder.Services.AddHttpContextAccessor();

四、关键注意事项 #

• 中间件顺序：TraceIdentifier相关中间件必须注册在管道最前端，确保后续所有组件的日志都能获取到TraceId。
• 异步上下文：ASP.NET默认会维护异步操作的HttpContext上下文，异步方法中的日志可正常获取TraceId；但后台独立任务需手动传递TraceId。
• 日志筛选：建议将TraceId设为日志的固定字段，方便后续通过日志分析工具（如ELK、Seq）快速筛选同一请求的所有日志。

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