NLog学习

Posted 2020-07-28 ck168

一、什么是NLog？

NLog（(http://www.nlog-project.org）是一个基于.NET平台编写的类库，我们可以使用NLog在应用程序中添加极为完善的跟踪调试代码。

NLog允许我们自定义从跟踪消息的来源（source）到记录跟踪信息的目标（target）的规则（rules）。记录跟踪信息的目标（target）可以为如下几种形式：

文件

• 文本控制台
• Email
• 数据库
• 网络中的其它计算机（通过TCP或UDP）
• 基于MSMQ的消息队列
• Windows系统日志
• 其他形式，请参考http://www.nlog-project.org/targets.html

除此之外，每一条跟踪消息都可以自动带有上下文信息（contextual information），并将其发送给记录跟踪信息的目标。这些上下文信息可以包含如下内容：

1. 当前的日期和时间（多种格式）
2. 记录等级
3. 来源名称
4. 输出跟踪消息的方法的堆栈信息
5. 环境变量的值
6. 异常的详细信息
7. 计算机、进程和线程名称
8. 其他，请参考：http://www.nlog-project.org/layoutrenderers.html 

每条跟踪信息都包含一个记录等级（log level）信息，用来描述该条信息的重要性。NLog支持如下几种记录等级：

1. Trace - 最常见的记录信息，一般用于普通输出    
2. Debug - 同样是记录信息，不过出现的频率要比Trace少一些，一般用来调试程序    
3. Info - 信息类型的消息    
4. Warn - 警告信息，一般用于比较重要的场合    
5. Error - 错误信息    
6. Fatal - 致命异常信息。一般来讲，发生致命异常之后程序将无法继续执行。

 

二、NLog配置文件元素详解

配置文件元素

在配置文件的<nlog />根元素中，我们可以指定如下的子元素。其中前两个是必须设定的，其余三个为可选设定。

1. <targets /> - 定义日志的输出目标    
2. <rules /> - 定义对日志信息进行路由的规则    
3. <extensions /> - 定义从其他dll文件中加载的NLog扩展模块    
4. <include /> - 引入外部的配置文件    
5. <variable /> - 定义配置文件中用到的变量

 

输出目标（Target）

<targets />配置节用来定义日志信息的输出位置。每一个输出位置都用一个<target />元素表示。<target />元素有两个必须设置的属性：

1. name - 输出目标的名称    
2. type - 输出目标的类型，例如“File”、“DataBase”、“Mail”等。若我们为配置文件指定了命名空间，则该属性名为xsi:type。

除了上述两个必须设置的属性之外，<target />元素还支持一些其他的属性，同样可以影响记录诊断信息的方式。我们可以为每一个输出目标设定不同的属性参数，这些属性均在NLog的主页上有详细描述，且Visual Studio也都为其提供了智能感知功能支持。

例如：“File”输出目标接受一个名为fileName的参数，用来指定输出文件的名称；而“Console”输出目标则接受一个名为error的参数，表示是否用标准错误输出（stderr）代替标准输出（stdout）。

NLog提供了很多与定义的输出目标，这些均在NLog的主页上有详细介绍。若你觉得不够用，并希望能够编写自定义的输出目标，那么也同样非常简单——15-20行代码就够了，请参考Nlog的文档（documentation）。

 

路由规则（Rule）

路由规则将定义在配置文件的<rules />节中。这部分内容就是一个简单的路由表，用来定义不同的日志源（Logger的名称）以及记录等级的日志信息将被发送至哪个输出目标中。路由规则将从列表中的第一项开始执行，如果符合当前的路由规则，则该条日志信息将被发送至指定的输出目标中，若路由表中任意一项都不满足，则该条日志信息将不会被处理。

路由表中的每一个条目都由一个<logger />元素定义，<logger />元素支持如下几个属性：

1. name - 日志源（Logger的名称），可以使用*通配符    
2. minlevel -  匹配该规则需要的最低记录等级    
3. maxlevel - 匹配该规则需要的最高记录等级    
4. level - 匹配该规则需要的单一的记录等级    
5. levels - 匹配该规则需要的记录等级列表，记录等级之间用逗号隔开    
6. writeTo - 匹配该规则的日志信息将被发送至的输出目标列表，输出目标之间用逗号隔开    
7. final - 让该规则成为日志信息的最后一个匹配条目。满足该条规则的日志信息被处理之后，将不会再继续尝试匹配下面定义的路由规则。