在 .NET Core 3 中使用 NLog 管理日志配置

Question

我在 .NET Core 3.1 辅助服务应用程序中使用 NLog。按照 NLog 的教程，我插入了一个 nlog.config 文件来管理配置。

现在我很困惑，因为我有三点配置日志记录：

1. 在我需要在依赖注入上下文中创建记录器的代码中

   // Other code...
   
   services.AddScoped<IApplyJcdsCommandsJob, ApplyJcdsCommandsJob>(provider =>
   {
       var loggerFactory = LoggerFactory.Create(builder =>
       {
           builder
               .ClearProviders()
               .AddFilter("Microsoft", Microsoft.Extensions.Logging.LogLevel.Trace)
               .AddFilter("System", Microsoft.Extensions.Logging.LogLevel.Trace)
               .AddFilter("ApplyJcdsCommandsJob", Microsoft.Extensions.Logging.LogLevel.Trace)
               //.AddConsole()
               //.AddEventLog();
               .AddNLog(configuration);
       });
   
       Microsoft.Extensions.Logging.ILogger logger = loggerFactory.CreateLogger<CommandsJob>();
   
       return new CommandsJob(logger);
   })
   
   // Other code...
   

2. 在 appSettings.json 中

   {
     "Logging": {
       "IncludeScopes": false,
       "LogLevel": {
         "Default": "Trace",
         "System": "Trace",
         "Microsoft": "Trace"
       }
     }
   }
   

3. 在 NLog.config 中

   nuget 包安装生成的默认配置文件：

   <!-- a section of the config -->
   <targets>
       <target xsi:type="File" name="f" fileName="${basedir}/logs/${shortdate}.log"
           layout="${longdate} ${uppercase:${level}} ${message}" />
   </targets>
   
   <rules>
       <logger name="*" minlevel="Trace" writeTo="f" />
   </rules>
   <!-- ... -->
   

我看到的是，如果我删除 Nlog.config 文件，将不会创建日志文件。其他更改接缝无效。

这些配置是如何关联的？打开/关闭日志记录和设置级别的最佳方法是什么？

Answer 1

决定使用 NLog 的人通常还希望禁用所有 MEL 过滤，以避免与两个过滤系统混淆。所以NLog wiki-tutorial是针对这些用户的。

我猜首先是 MEL 用户的人可能只会使用new HostBuilder().CreateDefaultBuilder().Build()（将在启用所有枪支的情况下设置所有内容）。

但是如果继续使用简单的例子，那么你需要删除：

loggingBuilder.SetMinimumLevel(Microsoft.Extensions.Logging.LogLevel.Trace);

并添加：

loggingBuilder.AddConfiguration(config.GetSection("Logging"));

所以它看起来像这样：

serviceCollection.AddLogging(loggingBuilder =>
{
   loggingBuilder.ClearProviders();
   loggingBuilder.AddConfiguration(config.GetSection("Logging"));
   loggingBuilder.AddNLog(config);
})

ILoggingBuilder.AddConfiguration可以在 Nuget 找到：Microsoft.Extensions.Logging.Configuration

Answer 2

AddNLog像任何其他 Microsoft Extension Logger (MEL) LoggingProvider 一样注册 NLog（类似于AddConsole）。

这意味着 NLog 只能获取已被 MEL-ILogger“批准”的日志输出。因此，MEL 中配置的任何过滤都会阻止日志事件到达 NLog。NLog v5 已更改，现在默认忽略 MEL 过滤器。

NLog 仍然能够根据 Logger-names 和 LogLevel-severity 重定向到所需的 NLog-targets。

您可以决定是否要使用 MEL 过滤或 NLog 过滤，或两者的组合。但如果您只想使用“纯”NLog，那么只需创建一个NLog.Extensions.Logging.NLogLoggerFactory. 它是一个忽略 MEL 过滤配置的专用 ILoggerFactory。

顺便提一句。为每个 CommandsJob 实例创建一个独立的 LoggerFactory 有点奇怪。会认为您会在依赖项注入框架中注册该类型，并让它注入构造函数参数。另请参阅此示例：

https://github.com/NLog/NLog.Extensions.Logging/blob/master/examples/NetCore2/ConsoleExample/Program.cs

LoggerFactory 是在其中创建的，AddLogging(...)并Runner在 ServiceCollection 中注册以进行依赖注入。创建实例时，Runner依赖注入将自动提供ILogger作为构造函数参数。