如何使用Serilog将单次请求内的所有日志消息合并为单条日志条目

可以实现该需求，Serilog没有内置自动合并单请求所有日志的开关，但可通过以下两种方案实现：

方案1：全局请求日志缓冲聚合（推荐，无业务代码侵入） #

该方案通过自定义中间件+Scoped缓冲容器实现全链路日志自动收集合并，不需要修改现有业务代码。

• 第一步：定义Scoped生命周期的日志缓冲容器

// 单次请求内的日志缓冲容器，Scoped生命周期保证每个请求独有一个实例
public class RequestLogBuffer
{
    private readonly List<Serilog.Events.LogEvent> _logEvents = new();
    public void AddLog(Serilog.Events.LogEvent logEvent) => _logEvents.Add(logEvent);
    public List<Serilog.Events.LogEvent> GetAllLogs() => _logEvents.ToList();
}

在Program.cs中注册该服务：

builder.Services.AddScoped<RequestLogBuffer>();

• 第二步：自定义Serilog Sink收集日志到缓冲

public class RequestBufferSink : Serilog.Core.ILogEventSink
{
    private readonly IHttpContextAccessor _httpContextAccessor;
    public RequestBufferSink(IHttpContextAccessor httpContextAccessor)
    {
        _httpContextAccessor = httpContextAccessor;
    }
    public void Emit(Serilog.Events.LogEvent logEvent)
    {
        var context = _httpContextAccessor.HttpContext;
        if (context == null) return;
        var buffer = context.RequestServices.GetService<RequestLogBuffer>();
        buffer?.AddLog(logEvent);
    }
}

• 第三步：编写中间件，请求结束后合并输出日志

public class RequestLogMergeMiddleware
{
    private readonly RequestDelegate _next;
    public RequestLogMergeMiddleware(RequestDelegate next)
    {
        _next = next;
    }
    public async Task InvokeAsync(HttpContext context, RequestLogBuffer buffer)
    {
        try
        {
            await _next(context);
        }
        finally
        {
            var logs = buffer.GetAllLogs();
            if (logs.Any())
            {
                // 可根据需求自定义合并格式，比如拼接消息、合并属性等
                var mergedMessage = string.Join("\n", logs.Select(e => e.RenderMessage()));
                // 合并后输出日志
                Log.Information("请求[{RequestMethod}]{RequestPath}合并日志：\n{MergedLog}", 
                    context.Request.Method, context.Request.Path, mergedMessage);
            }
        }
    }
}

• 第四步：配置服务和中间件

// 注册HttpContextAccessor
builder.Services.AddHttpContextAccessor();
// 配置Serilog，启用自定义缓冲Sink，如果你不需要原来的单条日志输出，可以移除原有Console/File等Sink
Log.Logger = new LoggerConfiguration()
    .Enrich.FromLogContext()
    .WriteTo.Sink<RequestBufferSink>()
    // 保留原有其他配置即可
    .CreateLogger();
// 中间件注册要放在路由匹配之前，保证覆盖完整请求链路
app.UseMiddleware<RequestLogMergeMiddleware>();

方案2：操作范围包装（轻量场景适用） #

如果仅需要部分接口合并日志，可以用操作范围包装接口逻辑，侵入性较低：

[HttpGet]
public async Task<IActionResult> Get([FromQuery(Name = "Id")] List<string> ids)
{          
    // 开启操作范围，所有范围内的日志都会被关联到该操作
    using var op = _logger.BeginOperation("处理Id请求");
    _myService.DoSomething();
    _logger.LogInformation("Some controller logs here");
    // 操作完成后自动输出合并后的日志条目
    op.Complete();
    return new OkObjectResult();
}

注意：该方案需要提前安装Serilog.Extensions.Operation Nuget包，且仅会合并操作范围内的日志。
两种方案都可以实现你示例中两条日志合并为一条输出的需求，不需要调整原有服务和控制器的日志打印逻辑。 #

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