NLog中动态修改请求日志属性的最佳实践

背景介绍

在.NET 6.0应用程序中使用NLog进行日志记录时，开发人员经常需要记录HTTP请求的相关信息，如请求路径、请求详情等。这些信息通常通过NLog的ASP.NET Core布局渲染器(如${aspnet-request-ip}、${aspnet-request-method}等)直接获取并记录到日志中。

问题场景

在实际开发中，我们可能会遇到这样的需求：在业务逻辑处理过程中，需要先获取原始的请求信息，经过处理后(如添加额外信息或修改某些值)，再将处理后的结果记录到日志中。特别是在以下场景：

1. 需要对敏感信息进行脱敏处理
2. 需要添加业务相关的上下文信息
3. 需要统一格式化请求路径
4. 在微服务架构中需要传递请求上下文

解决方案对比

1. 使用NLog配置变量(不推荐)

最初可能会想到使用NLog的配置变量(Variables)来实现：

LogManager.Configuration.Variables["user"] = "admin";

然后在NLog配置中使用${var:user}引用这个变量。

缺点：

• 变量是全局的，在多线程/多请求环境下会出现数据污染
• 不适合在Azure AKS等多实例部署环境中使用
• 缺乏请求级别的隔离性

2. 使用ScopeContext(推荐方案)

NLog提供了ScopeContext机制，可以为特定的代码块提供上下文属性：

using (NLog.ScopeContext.PushProperty("RequestPath", "My Request")) 
{
    Logger.Info("Hello World");
}

在NLog配置中可以通过${scopeProperty:RequestPath}引用这个属性。

优势：

• 属性作用域限定在using块内
• 线程安全，适合并发环境
• 可以与默认值结合使用，如：${scopeProperty:RequestPath:whenEmpty=${aspnet-request-url}}

3. 使用结构化日志记录

另一种简洁的方式是直接使用结构化日志记录：

Logger.Info("Hello from {RequestDetail}", "My Detail");

这种方式直接在日志语句中注入属性，简单直接。

实现建议

对于需要在类库中修改请求信息再记录的场景，推荐采用以下模式：

1. 在中间件或控制器中捕获原始请求信息
2. 在业务逻辑层进行处理和修改
3. 使用ScopeContext将处理后的信息推入日志上下文
4. 配置NLog优先使用ScopeContext中的属性，不存在时回退到原始请求信息

示例代码：

// 业务逻辑处理
public void ProcessRequest(HttpContext context)
{
    var originalPath = context.Request.Path;
    var processedPath = ModifyPath(originalPath);  // 自定义处理逻辑
    
    using (NLog.ScopeContext.PushProperty("ProcessedRequestPath", processedPath))
    {
        _logger.Info("请求已处理");
    }
}

对应的NLog配置：

<attribute name="RequestPath" 
           layout="${scopeProperty:ProcessedRequestPath:whenEmpty=${aspnet-request-path}}" />

注意事项

1. 确保在NLog配置中启用了includeMdlc="true"以支持异步上下文传播
2. 对于复杂的对象，考虑实现自定义的布局渲染器
3. 在生产环境中启用NLog内部日志以排查配置问题
4. 避免在ScopeContext中存储大对象，以免影响性能

通过这种方式，可以安全、灵活地在分布式环境中记录经过处理的请求信息，同时保持代码的清晰和可维护性。