Nlog在.net中的简单使用

官网地址：GitHub-Nlog

1、.NET没有内置文本日志提供者。第三方有Log4Net、NLog、Serilog等。老牌的Log4Net另搞一套，不考虑。

2、NLog，NuGet安装：NLog.Extensions.Logging（using NLog.Extensions.Logging; ）。项目根目录下建nlog.config，注意文件名的大小写(考虑linux)。也可以是其他文件名，但是需要单独配置。约定大于配置。内容见备注。讲解一下配置文件。

3、增加logBuilder.AddNLog()

nlog.config文件

<?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"
      autoReload="true"
      internalLogLevel="Info"
      internalLogFile="c:\temp\internal-nlog-AspNetCore.txt">

  <!-- enable asp.net core layout renderers -->
  <extensions>
    <add assembly="NLog.Web.AspNetCore"/>
  </extensions>

  <!-- the targets to write to -->
  <targets>
    <!-- File Target for all log messages with basic details -->
    <target xsi:type="File" name="allfile" fileName="c:\temp\nlog-AspNetCore-all-${shortdate}.log"
            layout="${longdate}|${event-properties:item=EventId:whenEmpty=0}|${level:uppercase=true}|${logger}|${message} ${exception:format=tostring}" />

    <!-- File Target for own log messages with extra web details using some ASP.NET core renderers -->
    <target xsi:type="File" name="ownFile-web" fileName="c:\temp\nlog-AspNetCore-own-${shortdate}.log"
            layout="${longdate}|${event-properties:item=EventId:whenEmpty=0}|${level:uppercase=true}|${logger}|${message} ${exception:format=tostring}|url: ${aspnet-request-url}|action: ${aspnet-mvc-action}|${callsite}" />

    <!--Console Target for hosting lifetime messages to improve Docker / Visual Studio startup detection -->
    <target xsi:type="Console" name="lifetimeConsole" layout="${MicrosoftConsoleLayout}" />
  </targets>

  <!-- rules to map from logger name to target -->
  <rules>
    <!--All logs, including from Microsoft-->
    <logger name="*" minlevel="Trace" writeTo="allfile" />

    <!--Output hosting lifetime messages to console target for faster startup detection -->
    <logger name="Microsoft.Hosting.Lifetime" minlevel="Info" writeTo="lifetimeConsole, ownFile-web" final="true" />

    <!--Skip non-critical Microsoft logs and so log only own logs (BlackHole) -->
    <logger name="Microsoft.*" maxlevel="Info" final="true" />
    <logger name="System.Net.Http.*" maxlevel="Info" final="true" />
    
    <logger name="*" minlevel="Trace" writeTo="ownFile-web" />
  </rules>
</nlog>

在程序中的使用

// NLog: Setup NLog for Dependency injection
builder.Logging.ClearProviders();
builder.Host.UseNLog();

参数解读

1、archiveAboveSize为“单个日志文件超过多少字节就把日志存档”，单位为字节，这样可以避免单个文件太大，如果不设定maxArchiveFiles参数，则文件日志存档文件的数量会一直增加，而如果设定maxArchiveFiles参数后，则最多保存maxArchiveFiles指定数量个数的存档文件，旧的会被删掉；当然也可以不设置maxArchiveFiles参数，而设置maxArchiveDays参数，这样可以设定保存若干天的日志存档。

2、这些不同参数的起到什么作用？ “滚动日志”策略。

Rules

1、rules节点下可以添加多个logger，每个logger都有名字（name属性），name是通配符格式的。

2、logger节点的minlevel属性和maxlevel属性，表示这个logger接受日志的最低级别和最高级别。

3、日志输出时，会从上往下匹配rules节点下所有的logger，若发现当前日志的分类名符合这个logger的name的通配符，就会把日志输出给这个logger。如果匹配多个logger，就把这条日志输出给多个logger。但是如果一个logger设置了final="true"，那么如果匹配到这个logger，就不继续向下匹配其他logger了。

其他

1、NLog部分功能和.NET的Logging重复，比如分类、分级、各种Provider。

2、为了避免冲突，如果用NLog，建议不要再配置.NET 的分级等（具体用法见微软文档）。