Asp.Net MVC日志记录不完整，怎样完善日志记录的配置与实现？

在开发某电商项目的过程中，我们曾遭遇这样的事故：凌晨两点支付接口突然崩溃，但当查证日志时，系统只留下"错误发生"四个字。这种日志就像失忆的病人，只告诉你病了，却无法说明病因。本文将手把手带你修复ASP.NET MVC项目的"记忆缺陷"。

一、问题诊断

1.1 默认配置的局限

Visual Studio自带的Debug.Write虽然方便，但存在三大致命伤：

• 无法持久化存储
• 缺乏分级管理
• 不支持上下文信息

// 典型的初级开发者写法（技术栈：ASP.NET MVC 5）
public ActionResult ProcessOrder(Order order)
{
    try {
        // 业务逻辑
    } 
    catch (Exception ex) {
        System.Diagnostics.Debug.Write("支付错误"); // 无错误详情
    }
}

1.2 架构层面的疏忽

未采用依赖注入导致日志对象管理混乱：

// 错误示范：紧耦合的日志调用
public class PaymentController : Controller
{
    private static Logger logger = LogManager.GetCurrentClassLogger();
    
    public ActionResult ProcessPayment()
    {
        logger.Info("开始支付"); // 直接耦合具体实现
    }
}

二、构建完整记忆体系（NLog实战）

2.1 技术选型对比

2.2 三步构建基础日志框架

（技术栈：ASP.NET MVC 5 + NLog 4.7）

步骤1：安装NuGet包

Install-Package NLog
Install-Package NLog.Web.AspNetCore

步骤2：配置文件架构

<!-- nlog.config -->
<targets>
    <!-- 文件存储：记录完整流水账 -->
    <target name="allfile" xsi:type="File"
            fileName="${basedir}/logs/${shortdate}.log"
            layout="${longdate} | ${level:uppercase=true} | ${logger} | ${message} ${exception:format=tostring}"/>
    
    <!-- 错误专用：专注重大事件 -->
    <target name="errorfile" xsi:type="File"
            fileName="${basedir}/logs/error-${shortdate}.log"
            layout="${longdate} | ${level} | ${logger} | ${message} ${exception:format=tostring}"/>
</targets>

<rules>
    <logger name="*" minlevel="Trace" writeTo="allfile" />
    <logger name="*" minlevel="Error" writeTo="errorfile" />
</rules>

步骤3：注入全局记录器

// Global.asax.cs
protected void Application_Start()
{
    // 加载NLog配置
    NLogBuilder.ConfigureNLog("nlog.config");
    
    // 注册全局异常捕获
    GlobalFilters.Filters.Add(new HandleErrorAttribute());
}

// 控制器使用示例
public class PaymentController : Controller
{
    private readonly ILogger _logger;

    public PaymentController()
    {
        _logger = LogManager.GetCurrentClassLogger();
    }

    [HttpPost]
    public ActionResult ProcessPayment(PaymentModel model)
    {
        try 
        {
            _logger.Info($"开始处理支付单号：{model.OrderNo}"); // 含业务关键信息
            // 业务逻辑
            _logger.Debug($"支付参数验证通过：{JsonConvert.SerializeObject(model)}");
        }
        catch (PaymentException pex)
        {
            _logger.Error(pex, $"支付网关异常 | 订单号：{model.OrderNo}"); // 带上下文信息
        }
    }
}

三、高级记忆法则（场景化配置）

3.1 支付链路追踪

// 在全局过滤器增加TraceID标记
public class LoggingFilter : ActionFilterAttribute
{
    public override void OnActionExecuting(ActionExecutingContext filterContext)
    {
        var traceId = Guid.NewGuid().ToString("N");
        MappedDiagnosticsContext.Set("TraceID", traceId); // 设置唯一追踪码
        
        LogManager.GetCurrentClassLogger().Info($"请求开始 | TraceID:{traceId}");
    }
}

对应的NLog配置增强：

<target name="jsonFile" xsi:type="File"
        fileName="${basedir}/logs/json-${shortdate}.log">
    <layout xsi:type="JsonLayout">
        <attribute name="timestamp" layout="${longdate}" />
        <attribute name="level" layout="${level:uppercase=true}"/>
        <attribute name="traceId" layout="${mdlc:item=TraceID}"/>
        <attribute name="message" layout="${message}"/>
    </layout>
</target>

3.2 敏感信息自动过滤

// 密码字段脱敏处理
public class PaymentModel
{
    [LogMasked(ShowFirst = 3, PreserveLength = true)] 
    public string CardNumber { get; set; }
}

// 自定义日志过滤器
public class LogMaskAttribute : ActionFilterAttribute
{
    public override void OnActionExecuted(ActionExecutedContext filterContext)
    {
        var parameters = filterContext.ActionParameters;
        foreach (var param in parameters.Values)
        {
            // 通过反射处理带有[LogMasked]特性的属性
            MaskSensitiveData(param);
        }
    }
}

四、技术决策指南

4.1 应用场景矩阵

4.2 注意事项

1. 磁盘空间预警：配置日志滚动策略

<target name="rollingFile" xsi:type="File"
        fileName="${basedir}/logs/archive/${shortdate}.log"
        maxArchiveFiles="30"
        archiveAboveSize="10485760"/> <!-- 10MB切割 -->

2. 性能影响：异步日志记录

<targets async="true">
    <target name="asyncFile" xsi:type="AsyncWrapper">
        <target xsi:type="File" fileName="${basedir}/logs/async.log"/>
    </target>
</targets>

3. 安全审计：操作日志三重校验

• 访问来源IP记录
• 用户身份标识关联
• 操作参数哈希存储

五、总结与展望

完善的日志系统就像项目的"行车记录仪"，不仅要记录常规行驶路线（Info级别日志），更要能还原事故现场（Error级别细节）。通过NLog实现的层级化、结构化日志方案，使得日均百万级的电商系统日志查询响应时间从分钟级缩短到秒级。需要特别注意的是，随着微服务架构的普及，建议后续升级到分布式日志系统（如ELK栈），实现跨服务链路追踪。