如何配置Serilog同时记录ASP.NET Core的请求与响应体？

在ASP.NET Core Web API中，使用Microsoft.AspNetCore.HttpLogging组件可以轻松记录请求和响应体，但它仅支持控制台输出，无法写入文件等其他目标。我尝试多种方案后，通过自定义中间件结合EnrichDiagnosticContext实现了用Serilog记录的需求，但还有几个疑问：

1. 是否必须采用这种复杂方式，有无更简便的配置？
2. 为响应体创建的MemoryStream及原响应流如何正确释放？
3. 能否通过其他方式让LogContext中的属性出现在日志中，以便清理自定义流？

回答 #

1. 有没有更简便的配置方式？ #

有两种更轻量的替代方案：

• 利用Serilog原生扩展简化配置：Serilog.AspNetCore包自带的UseSerilogRequestLogging()扩展，默认虽不记录请求/响应体，但可通过配置EnrichDiagnosticContext手动添加内容，无需编写完整自定义中间件。示例代码：

  app.UseSerilogRequestLogging(options =>
  {
      options.EnrichDiagnosticContext = (ctx, httpContext) =>
      {
          // 读取请求体并添加到诊断上下文
          httpContext.Request.EnableBuffering();
          using var reader = new StreamReader(httpContext.Request.Body, leaveOpen: true);
          var requestBody = reader.ReadToEndAsync().Result;
          httpContext.Request.Body.Position = 0;
          ctx.Set("RequestBody", requestBody);
          
          // 响应体可通过轻量流包装逻辑添加，复杂度远低于自定义中间件
      };
  });
  

• 使用社区封装的Serilog Http日志库：比如Serilog.Enrichers.AspNetCore.HttpRequest这类第三方包，已经封装了请求响应体的完整记录逻辑，直接配置即可使用，无需自行实现核心逻辑。

2. 如何正确释放MemoryStream和原响应流？ #

需遵循流生命周期的关键规则：

• MemoryStream的释放：如果是你创建的MemoryStream，不能在中间件逻辑中直接Dispose——因为后续管道还需要使用它。正确做法是在响应完成后，通过OnCompleted回调释放：

  var originalStream = httpContext.Response.Body;
  var memoryStream = new MemoryStream();
  httpContext.Response.Body = memoryStream;
  
  await _next(httpContext);
  
  // 记录响应体后，将内容写回原流
  memoryStream.Position = 0;
  await memoryStream.CopyToAsync(originalStream);
  
  // 注册响应完成回调，释放流资源
  httpContext.Response.OnCompleted(() =>
  {
      memoryStream.Dispose();
      return Task.CompletedTask;
  });
  

• 原响应流的释放：多数情况下原流由框架管理生命周期，但如果你手动替换了它，建议在OnCompleted回调中显式释放，避免资源泄漏风险。

3. 让LogContext属性出现在日志中的方法 #

只需在Serilog初始化配置中添加Enrich.FromLogContext()，即可自动提取LogContext中的属性并附加到日志事件：

Log.Logger = new LoggerConfiguration()
    .Enrich.FromLogContext() // 启用LogContext属性提取
    .WriteTo.File("logs/log.txt")
    .CreateLogger();

之后在代码中使用LogContext.PushProperty("PropertyName", value)添加的属性，会自动出现在后续的所有日志里。你可以把流清理所需的标识信息放入LogContext，在响应完成回调中读取并处理，无需依赖自定义中间件的上下文传递。

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