NLog日志工具介绍

日志记录工具

Nlog是一款基于.Net框架的记录日志的工具。与之相近的还有Log4net。关于两者之间的比较网上有很多，有兴趣的话可以参考 log4net vs. Nlog

NLog is a flexible and free logging platform for various .NET platforms, including .NET standard. NLog makes it easy to write to several targets. (database, file, console) and change the logging configuration on-the-fly.

使用

1，可以通过 NuGet 进行下载。
2，在控制台中使用命令

Install-Package Nlog.Config

安装 NLog.Config 包，会一并安装 NLog 和 NLog.Schema 两个包
3，简单使用

 private static Logger logger = LogManager.GetCurrentClassLogger();
    static void Main(string[] args)
    {
        logger.Trace("Trace Message");
        logger.Debug("Debug Message");
        logger.Info("Info Message");
        logger.Error("Error Message");
        logger.Fatal("Fatal Message");
    }

4，配置
执行3中的代码，没有任何效果，因为我们没有配置日志的输出路径，顾名思义就是日志要输出到哪里。
Nlog支持Files, Event Log, Database, Console, E-mail, Asp.Net core Logging为输出目标。
日志的输出通过配置来实现，一般是在配置文件中配置(NLog.config)，也支持硬编码。

• 配置信息嵌入在.NET应用程序标准的*.exe.config或者web.config文件里
• 保存在独立文件里，也叫单一格式。“NLog.config”、"*.exe.nlog"或者"NLog.dll.nlog"
  下面是单一格式的一个简单的示例，主要包括两个部分：输出目标target 和 路由规则rule

<?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"
      throwExceptions="false">

  <!--自定义变量-->
  <variable name="appName" value="YourAppName" />


  <!--输出目标-->
  <!--
  layout 用来控制日志输出格式
  type 指输出类型 Console Debugger File Mail Network Database
  filename 用来配置日志路径
  -->
  <targets async="true">
    <target name="default"
            xsi:type="File"
            layout="${longdate} - ${level:uppercase=true}: ${message}${onexception:${newline}EXCEPTION\: ${exception:format=ToString}}"
            fileName="Debug.log"
            keepFileOpen="false"
            archiveFileName="${specialfolder:ApplicationData}\${appName}\Debug_${shortdate}.{##}.log"
            archiveNumbering="Sequence"
            archiveEvery="Day"
            maxArchiveFiles="30"
            encoding="utf-8"
            />
    <target name="console"
            xsi:type="Console"
            layout="$(date:format=HH\:mm\:ss)|(level:padding=-5)|$(message)"/>
    <target name="network"
            xsi:type="Network"
            address="tcp://localhost:4001"></target>
    <target name="eventlog"
            xsi:type="EventLog"
            source="${appName}"
            layout="${message}${newline}${exception:format=ToString}"/>

  </targets>
  
  <!--路由规则-->
  <!--
  name-记录者的名字(允许使用通配符*)
  minleve-匹配日志范围的最低级别
  maxlevel-匹配日志范围的最高级别
  level-匹配的单一日志级别
  levels-匹配的一系列日志级别，用逗号分隔
  writeTo-规则匹配时日志应该被写入的一系列目标，由逗号分隔
  -->
  <rules>
    <logger name="fileLogger" writeTo="default" minlevel="Debug" />
    <logger name="*" writeTo="eventlog" minlevel="Error" />
  </rules>
</nlog>

输出目标target

每个target代表一个输出目标，它主要包含两个属性：name和type。name是输出模板的名称，在后面的路由规则中使用，type则是输出类型，常见的有

• Console 输出到控制台
• Debugger 输出到
• File 输出到文件
• Mail 输出为邮件发送
• Network 输出到网络地址
• Database 输出到数据库

当选择某一种类型的时候，还需要配置相应的参数。如输出类型是File时，我们要配置日志路径filename，这里是可以使用一些变量的（花括号里面的部分），比如：

    fileName="${basedir}/Logs/Error/${shortdate}/error.txt"

输出的日志格式为 /Log/2014-10-01/err.txt 每天生成一个文件夹，非常方便。

路由规则rule

路由规则主要用于将日志和输出目标匹配起来，它一般有如下几个属性

• name - 记录者的名字 (允许使用通配符*)
• minlevel - 匹配日志范围的最低级别
• maxlevel - 匹配日志范围的最高级别
• level - 匹配的单一日志级别
• levels - 匹配的一系列日志级别，由逗号分隔。
• writeTo - 规则匹配时日志应该被写入的一系列目标，由逗号分隔。

看上去有好几个属性，实际上用起来还是比较简单的，例如：

    <logger name="*" writeTo="console" />    					 将所有的日志输出到控制台中
    <logger name="*" minlevel="Debug" writeTo="debugger" />      将Debug级别以上的日志输出到Debugger中
    <logger name="*" minlevel="Error" writeTo="error_file" />    将Error级别以上的日志输出到文件中

另外，NLOG支持配置多个路由规则，可以非常方便我们的输出。

第三方查看工具

和log4net一样，NLog也是被一些第三方log查看工具所支持的，比如：Sentinel 和 Harvester 。有兴趣的朋友可以试一下。