Nlog笔记

NLog可以在NuGet中下载.

配置NLog输出的Targets

NLog 可以使用一个 NLog.config 的 XML 配置文件去配置你的应用程序（文件的属性需修改为：始终复制），下面是一个简单 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">
 
    <targets>
    <!--输出目标:name名称f,xsi:type输出类型文件, fileName输出到程序根目录logs文件夹中-->
        <target name="logfile" xsi:type="File" fileName="file.txt" />
        <target name="logconsole" xsi:type="Console" />
    </targets>
 
    <rules>
      <!--日志路由规则：最低级别Debug，输出到target目标fileName-->
        <logger name="*" minlevel="Info" writeTo="logconsole" />
        <logger name="*" minlevel="Debug" writeTo="logfile" />
    </rules>
</nlog>

 若想要把日志文件按时间存放文件夹，可这么写：

fileName="${basedir}/Logs/${date:format=yyyy}/${date:format=MM}/${date:format=dd}/${event-properties:filename}.log"

 其中target的格式：

<targets>
    <target name="f"
            xsi:type="File"
            fileName="${basedir}/logs/${shortdate}.log"
            layout="${longdate} ${uppercase:${level}} ${message}" 
            maxArchiveFiles="5"
            archiveAboveSize="10240"
            archiveEvery="Day"/>
</targets>

Nlog允许用户配置单个文件大小, 放置在内容过长效率过慢,配置了大小之后, Nlog会自动创建一个新的文件副本,插入新的日志输出。

maxArchiveFiles：允许生成的副本文件最大数量

archiveAboveSize：允许单个文件得最大容量

archiveEvery：按天生成

name：输出目标的名称，用于rules中路由规则writeTo指定

fileName：包含完整的生成文件的路径和文件名

xsi:type：输出类型如下：

layout：用来规定输出内容格式，语法“${属性}”，可以把上下文信息插入到日志中。

        上文target代码中layout解析：

layout="${longdate} ${uppercase:${level}} ${message}" 

${longdate}：日期和时间，采用可排序的长格式`yyyy-MM-dd HH：mm：ss.ffff`。

${uppercase:${level}}：uppercase将另一个布局输出的结果转换为大写；level日志级别（例如ERROR，DEBUG）或级别序数（数字）。

${message}:（格式化的）日志消息。

<rules>
    <logger name="*" minlevel="Debug" writeTo="file" />
</rules>

minlevel="Debug":所有级别等于或者高于Debug的日志信息都写入到“file”这个目标里。同理，maxlevel则为小于；同时有minlevel和maxlevel的则为在这范围内。

写入日志信息

var logger = NLog.LogManager.GetCurrentClassLogger();
logger.Info("我打出了Nlog日志");

结果：

日志最佳实践

1. 每个类中，Logger 应该被设置成一个静态变量
   每创建一个 Logger 都会有一定的性能损耗，因为它必须获取锁和分配对象
   因此建议像这样创建logger:

   namespace MyNamespace
   {
     public class MyClass
     {
       private static NLog.Logger logger = NLog.LogManager.GetCurrentClassLogger();
     }
   }

2. Logger 应该处理字符串格式化
   避免预先执行字符串分配或字符串连接，而是让日志记录器执行格式化。这将允许NLog推迟格式化并减少开销。因此，建议您这样执行日志:
   

   logger.Info("Hello {0}", "Earth");

   也可使用单例结构：

    public class LogHelper
       {
           private static Logger logger;
    
           private LogHelper()
           {
               logger = LogManager.GetCurrentClassLogger();
           }
    
           public void WriteLog()
           {
               logger.Info("Write Logs");
           }
    
           #region 单例
    
           private static LogHelper instance;
    
           public static LogHelper Instance()
           {
               if (instance == null)
               {
                   lock (typeof(LogHelper))
                   {
                       if (instance == null)
                       {
                           instance = new LogHelper();
                       }
                   }
               }
    
               return instance;
           }
    
           #endregion
       }

3. Logger 应该记录异常
   避免将异常作为格式化参数，而是将其显式地作为第一个参数提供。这将帮助NLog目标提供更好的日志记录。 
   

   try
   {
   }
   catch (Exception ex)
   {
       logger.Error(ex, "Something bad happened");
   }

4.  从 NLog.config XML配置文件中验证配置
   默认情况下，NLog 允许记录所有异常，因此，日志记录的问题不会导致应用程序中断。但是为更多的应用程序记录日志是至关重要的，所以如果 NLog 配置文件的实例错误，那将是致命的。增加 throwConfigExceptions="true" 会使 NLog 在配置文件错误的情况下抛出异常: 
   

   <?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"
         throwConfigExceptions="true">
   </nlog>

5.  Remember to Flush
   当应用停止运行时，NLog 默认会自动尝试刷新. Microsoft Windows 给.Net应用程序在被终止前执行关机(通常是2秒)的时间。如果一个 NLog配置了需要网络传输的 NLog Tagets （Http、Mail、Tcp）运行在Linux/Windows，那么执行一个手动的 Flush/Shutdown 是一个明智之举。
   

   NLog.LogManager.Shutdown(); // 刷新并关闭内部线程和计时器。

   运行在Mono/Linux 的 .NET 应用在进入应用程序关闭阶段前，必需去停止线程和计时器. 如果未执行完成会导致未处理的异常和分割错误，以及其他不可预知的行为。

  AsyncWrapper 提供一个便捷的快捷设置方式，在配置文件中添加 async="true" 即可：

<?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 async="true">
        <target name="logfile" xsi:type="File" fileName="file.txt" />
    </targets>
 
    <rules>
        <logger name="*" minlevel="Info" writeTo="logfile" />
    </rules>
</nlog>

本栏目推荐文章
• 2024/1/13 算法笔记
• Python学习笔记
• HDP 笔记
• 学习进度笔记2
• 微软企业库Unity学习笔记(一)
• 微软企业库Unity学习笔记(二)
• kepware关于U-CON的使用笔记 (串口_非主动问答式)
• Anaconda使用笔记
• SHARPNESS-AWARE MINIMIZATION FOR EFFICIENTLY IMPROVING GENERALIZATION论文阅读笔记
• 【做题笔记】数论做题笔记

笔记 Nlog笔记nlog nlog 日志nlog 组件nlog kafka日志nlog extensions logging nlog 框架prism日志nlog core nlog net api richtextbox日志nlog wpf exceptionless身份 用户nlog