C#第三方庫Nlog

Kagula

2012-03-31

內容簡介

    本文記錄C#的NLog庫（日誌庫）的常用方式。所有程式碼在WinXPSP3+VS2010SP1環境中測試通過。

    使用的第三方庫是Sentinel 0.9.2.0，NLog-v2.0.0.2000。

    如果是在Silverlight專案中使用NLog請參考資料[4]。

正文

第一次使用

在參考資料[2]中找到download下載Nlog安裝包，在系統中安裝。

新建C#的Win32Console專案，滑鼠右鍵單擊專案名稱，新增新專案[Visual C# Items]->[CSharp]->[Empty Nlog configuration file]

下面在Program.cs中填入預設程式碼

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;

using NLog;

namespace testNLog
{
    class Program
    {
        private static Logger logger = LogManager.GetCurrentClassLogger();

        public static void MyMethod1()
        {
            int k = 42;
            int l = 100;

            logger.Trace("Sample trace message, k={0}, l={1}", k, l);
            logger.Debug("Sample debug message, k={0}, l={1}", k, l);
            logger.Info("Sample informational message, k={0}, l={1}", k, l);
            logger.Warn("Sample warning message, k={0}, l={1}", k, l);
            logger.Error("Sample error message, k={0}, l={1}", k, l);
            logger.Fatal("Sample fatal error message, k={0}, l={1}", k, l);
            logger.Log(LogLevel.Info, "Sample fatal error message, k={0}, l={1}", k, l);
        }

        static void Main(string[] args)
        {
            logger.Info("---------------------------------------");
            logger.Trace("Sample trace message");
            logger.Debug("Sample debug message");
            logger.Info("Sample informational message");
            logger.Warn("Sample warning message");
            logger.Error("Sample error message");
            logger.Fatal("Sample fatal error message");

            // alternatively you can call the Log() method 
            // and pass log level as the parameter.
            logger.Log(LogLevel.Info, "Sample fatal error message");

            MyMethod1();
        }
    }
}
 

<?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">

  <!-- make sure to set 'Copy To Output Directory' option for this file -->
  <!-- go to http://nlog-project.org/wiki/Configuration_file for more information -->

  <targets>
    <target name="asyncFile" xsi:type="AsyncWrapper">
      <target name="logfile" xsi:type="File" fileName="file.txt" />
    </target>
    <target name="console" xsi:type="ColoredConsole" 
             layout="[${date:format=yyyy-MM-dd HH\:mm\:ss}][${level}] ${message} ${exception}"/>
  </targets>

  <rules>
    <logger name="*" minlevel="Info" writeTo="logfile" />
    <logger name="*" minlevel="Trace" writeTo="console" />
  </rules>
</nlog>
 

新增的NLog.config檔案必須放在專案對應的DEBUG目錄或RELEASE目錄中，即必須放在和可執行檔案相同的路徑中。

Logger標籤對，控制輸出範圍與水平

name屬性：

指定哪些程式碼段要輸出資訊，例如：“<logger name="SomeNamespace.Component.*" …”，只輸出SomeNamespace.Component域裡面列印的資訊。

minLevel屬性:

    指定輸出等級，Logging 水平分為以下等級“Trace<<Debug<<Info<<Warn<<Error<<Fatal ”，如果我們選擇Info值，則Trace和Debug等級的資訊不會被輸出。

writeTo屬性：

       指定使用那個“Target標籤對”來輸出資訊

Final屬性：

       這個屬性若設定為true，則被當前Logger標籤對輸出的訊息型別，不再被下一個Logger標籤對處理。例如:

   <rules>

       <logger name="SomeNamespace.Component.*"minlevel="Trace" writeTo="logfile" final="true"/>

       <logger name="*" minlevel="Info"writeTo="logfile2" />

</rules>

Target標籤對，輸出格式，輸出到哪裡

Name屬性：

target標籤對的名稱

Type屬性：

target的型別，比如target=”File”。還有“Database”，“Mail”，“Network”等型別。

Silverlight使用檔案輸出，需將專案設定為Out of browser模式

fileName屬性：

若target型別為File，則可以指定輸出檔名。

例：

fileName=”file.txt”，

fileName="${basedir}/App_Data/log.txt"，

fileName="${basedir}/log.txt"，

fileName ="${specialfolder:MyDocuments}/log.${shortdate}.txt"

fileName="${logger}.txt"

fileName="${shortdate}.txt"

fileName="${windows-identity:domain=false}.txt

fileName="${shortdate}/${windows-identity:domain=false}.txt"

如果是Silverlight專案可能不能指定輸出檔案到App_Data目錄下。

Layout屬性：

格式化輸出日誌資訊。例：

layout="${date:format=HH\:mm\:ss}|${level}|${stacktrace}|${message}"

layout="[${date:format=yyyy-MM-ddHH\:mm\:ss}][${level}] ${message} ${exception}"

layout="${longdate}${callsite} ${level} ${message}"

address屬性:

指定日誌資訊輸出到哪個網路伺服器，例：

<targetname="n1" xsi:type="Network"address="tcp://localhost:4001"/>

傳送除錯資訊到網路伺服器

參考資料[3]可以實現。但是需要注意以下問題：

[1]建議下載這個軟體的zip版本，解壓后里面有Sentinel.exe檔案，可以用下面的命令列啟動Sentinel，免得每次啟動，都要輸入一遍配置資訊。

“sentinel   nlog  udp   9999” 

[2]如果改成TCP（參考資料[3]用的是UDP）方式，則sentinel收不到日誌資訊，不知是什麼原因。

參考資料

[1]《Nlog Tutorial》

[2]《Nlog 官網》

[3]《Sentinel官網》

 [4]《使用NLog為Silverlight增加日誌記錄功能》