NLog.config是什么 如何用它来配置.NET的日志记录

NLog.config是NLog日志框架的XML格式配置文件，用于统一管理.NET应用程序的日志记录规则，包括日志输出位置、记录级别、输出格式等核心配置项，无需修改代码就能调整日志行为。

NLog.config的基础结构

一个标准的NLog.config文件根节点是<nlog>，内部主要包含<targets>和<rules>两个核心子节点，分别负责定义日志输出目标和配置日志记录规则。

<?xml version="1.0" encoding="utf-8" ?>
<nlog xmlns="http://www.nlog-project.org/schemas/NLog.xsd"
      xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">

  <!-- 定义日志输出目标 -->
  <targets>
  </targets>

  <!-- 定义日志记录规则 -->
  <rules>
  </rules>

</nlog>

配置日志输出目标（targets）

<targets>节点下可以添加多个<target>子节点，每个<target>对应一种日志输出方式，常见的输出目标包括控制台、文件、数据库等。

输出到控制台

使用Console类型的target，可以将日志直接打印到程序运行的控制台窗口，适合开发阶段快速查看日志。

<targets>
  <target name="console" xsi:type="Console" layout="${date:format=yyyy-MM-dd HH:mm:ss} ${level} ${message}" />
</targets>

输出到文件

使用File类型的target，可以将日志保存到本地文件，支持按日期、大小自动分割文件，适合生产环境持久化日志。

<targets>
  <target name="file" xsi:type="File" 
          fileName="${basedir}/logs/log_${date:format=yyyyMMdd}.txt"
          layout="${date:format=yyyy-MM-dd HH:mm:ss} [${level}] ${logger} ${message} ${exception}"
          maxArchiveFiles="30"
          archiveAboveSize="10485760" />
</targets>

上面配置中，fileName定义了日志文件的存储路径和命名规则，maxArchiveFiles表示最多保留30个归档文件，archiveAboveSize表示单个文件超过10MB就自动归档。

配置日志记录规则（rules）

<rules>节点下可以添加多个<logger>子节点，用于指定不同命名空间、不同级别的日志匹配到对应的输出目标。

logger节点的name属性用于匹配日志来源，minlevel和maxlevel定义日志级别范围，writeTo指定要使用的target名称。

<rules>
  <!-- 所有日志都输出到控制台 -->
  <logger name="*" minlevel="Trace" writeTo="console" />
  <!-- 大于等于Info级别的日志输出到文件 -->
  <logger name="*" minlevel="Info" writeTo="file" />
  <!-- 过滤掉Microsoft开头的框架日志 -->
  <logger name="Microsoft.*" final="true" />
</rules>

其中final="true"表示匹配到该规则后不再执行后续规则，避免框架日志被重复记录。

在.NET项目中使用NLog.config

首先需要在项目中安装NLog包，以.NET 6项目为例，通过NuGet安装NLog和NLog.Extensions.Logging包。

然后将编写好的NLog.config文件添加到项目根目录，设置文件属性为“始终复制”到输出目录，确保程序运行时能读取到配置文件。

接着在程序入口配置NLog，以下是Program.cs的配置示例：

using NLog;
using NLog.Extensions.Logging;

var builder = WebApplication.CreateBuilder(args);

// 添加NLog日志服务
builder.Services.AddLogging(logging =>
{
    logging.ClearProviders();
    logging.AddNLog();
});

var app = builder.Build();

// 后续业务代码

app.Run();

在业务代码中就可以直接注入ILogger接口记录日志：

using Microsoft.AspNetCore.Mvc;

[ApiController]
[Route("api/test")]
public class TestController : ControllerBase
{
    private readonly ILogger<TestController> _logger;

    public TestController(ILogger<TestController> logger)
    {
        _logger = logger;
    }

    [HttpGet]
    public string Get()
    {
        _logger.LogTrace("这是一条Trace级别日志");
        _logger.LogDebug("这是一条Debug级别日志");
        _logger.LogInformation("这是一条Info级别日志");
        _logger.LogWarning("这是一条Warning级别日志");
        _logger.LogError("这是一条Error级别日志");
        return "日志已记录";
    }
}

常见问题说明

• NLog.config文件如果放在项目根目录但无法读取，需要检查文件的“复制到输出目录”属性是否设置为“始终复制”。
• 如果配置的日志没有输出，可以开启NLog的内部日志排查问题，在<nlog>节点添加internalLogLevel="Info" internalLogFile="internal.log"属性即可。
• 日志级别从低到高依次为Trace、Debug、Info、Warn、Error、Fatal，配置minlevel为Info时，会记录Info及以上级别的日志。

NLog.configNLog.NET日志配置修改时间：2026-07-07 16:57:32