2. 程式人生 > 其它 >C# 使用NLog記錄日誌

C# 使用NLog記錄日誌

阿新 • • 發佈：2021-12-15

引用：https://www.cnblogs.com/felixnet/p/5498759.html

NLog是一個記錄日誌元件，和log4net一樣被廣泛使用，它可以將日誌儲存到文字檔案、CSV、控制檯、VS除錯視窗、資料庫等。最近剛用到這個元件，覺得不錯，水一篇。

下載

通過Nuget安裝NLog，你也可以同時安裝NLog.Config，它會在專案目錄下幫你建立一個配置檔案NLog.config，不過不需要，我們直接手動建立一個，你也可以將配置的資訊寫入到 App.config/Web.config，我比較喜歡獨立出來，不與其它配置摻和在一起。

配置

在專案根目錄下新建一個NLog.config，基本目錄結構：targets下面配置日誌輸出目標及相關引數，rules下面配置目標輸出規則。

1 2 3 4 5 6 7 8 9 10 11 <?xmlversion="1.0" ?> <nlog> <targets> <target></target> <target></target> </targets> <rules> <logger></logger> <logger></logger> </rules> </nlog>

記得在NLog.config的屬性中設定 Copy to Output Directory: Copy always

現在我們要將日誌輸出到文字檔案，資料庫，VS除錯視窗，完整配置檔案如下：

<?xml version="1.0" ?>

<!--<nlog xmlns="http://www.nlog-project.org/schemas/NLog.xsd"
      xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
      autoReload="true"
      internalLogLevel="Trace"
      internalLogFile="D:\work\log.txt">-->

<nlog xmlns="http://www.nlog-project.org/schemas/NLog.xsd"
      xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
      autoReload="true">
  
  <targets>
    
    <!-- Log in a separate thread, possibly queueing up to
        5000 messages. When the queue overflows, discard any
        extra messages-->

    <!-- write logs to file -->
    <target name="file" xsi:type="AsyncWrapper" queueLimit="5000" overflowAction="Discard">
      <target xsi:type="File" fileName="${basedir}/logs/${shortdate}.log" layout="${longdate} ${level:uppercase=true} ${event-context:item=Action} ${message} ${event-context:item=Amount} ${stacktrace}" />      
    </target>

    <!-- write log message to database -->
    <target name="db" xsi:type="AsyncWrapper" queueLimit="5000" overflowAction="Discard">
      <target type="Database" dbProvider="mssql" connectionString="Data Source=.\SQLEXPRESS;Initial Catalog=EFinance;Persist Security Info=True;User ID=sa;Password=123456;">

        <commandText>
          INSERT INTO Log(Timestamp,Level,Message,Action,Amount,StackTrace) VALUES(@time_stamp, @level, @message, @action, @amount, @stacktrace);
        </commandText>

        <!-- database connection parameters -->
        <parameter name="@time_stamp" layout="${date}" />
        <parameter name="@level" layout="${level:uppercase=true}" />
        <parameter name="@message" layout="${message}" />
        <parameter name="@action" layout="${event-context:item=Action}" />
        <parameter name="@amount" layout="${event-context:item=Amount}" />
        <parameter name="@stacktrace" layout="${stacktrace}" />
      </target>
    </target>

    <!--write log message to Visual Studio Output-->
    <target name="debugger" xsi:type="Debugger" layout="NLog: ${date:format=HH\:mm\:ss} | ${level:uppercase=true:padding=-5} | ${message}" />
  </targets>

  <rules>
    <!--TRACE,DEBUG,INFO,WARN,ERROR,FATAL-->
    <logger name="*" minlevel="Trace" writeTo="debugger" />
    <!--INFO,WARN,ERROR,FATAL-->
    <logger name="*" minlevel="Info" writeTo="db" />
    <!--DEBUG,INFO,WARN,ERROR,FATAL-->
    <logger name="*" minlevel="Debug" writeTo="file" />    
  </rules>
</nlog>
  • 如在根節點（nlog）配置 internalLogLevel, internalLogFile，可以檢視NLog輸出日誌時的內部資訊，比如你配置檔案有錯誤，很有幫助，不過專案釋出後還是關閉比較好，以免影響效率；
  • 在target外面罩了一個 <target>並且xsi:type為 AsyncWrapper，即表示這條 target 將非同步輸出，這裡我將檔案和資料庫日誌非同步輸出；
  • db target內指定了資料庫連線字串 connectionString，SQL語句，SQL引數，還可以指定資料庫/表建立和刪除的指令碼（推薦看NLog原始碼示例，這裡不介紹），同時我們自定義了2個引數 action和amount；
  • target引數裡有些是NLog內建引數，比如message,level,date,longdate,exception,stacktrace等，NLog在輸出時會自動賦值；
  • layout設定了每條日誌的格式；
  • 在rules節點，我們分別指定了三個target輸出日誌的級別，NLog用於輸出日誌的級別包括：Trace,Debug,Info,Warn,Error,Fatal，可以設定 minlevel設定最小級別，也可以用 levels定義你所有需要的級別（多個用逗號分隔）。

封裝

簡單兩句就可以使用NLog了：

NLog.Logger logger = Nlog.LogManager.GetCurrentClassLogger();
logger.Fatal("發生致命錯誤");
logger.Warn("警告資訊");

但是這樣只能記錄了NLog的內建欄位，我們定義的 Amount, Action都不能寫入，接下來我們來封裝一個Logger：

public class Logger
    {
        NLog.Logger _logger;

        private Logger(NLog.Logger logger)
        {
            _logger = logger;
        }

        public Logger(string name) : this(LogManager.GetLogger(name))
        {

        }

        public static Logger Default { get; private set; }
        static Logger()
        {
            Default = new Logger(NLog.LogManager.GetCurrentClassLogger());
        }

        #region Debug
        public void Debug(string msg, params object[] args)
        {
            _logger.Debug(msg, args);
        }        

        public void Debug(string msg, Exception err)
        {
            _logger.Debug(err, msg);
        }        
        #endregion

        #region Info
        public void Info(string msg, params object[] args)
        {
            _logger.Info(msg, args);
        }

        public void Info(string msg, Exception err)
        {
            _logger.Info(err, msg);
        }
        #endregion

        #region Warn
        public void Warn(string msg, params object[] args)
        {
            _logger.Warn(msg, args);
        }

        public void Warn(string msg, Exception err)
        {
            _logger.Warn(err, msg);
        }
        #endregion

        #region Trace
        public void Trace(string msg, params object[] args)
        {
            _logger.Trace(msg, args);
        }

        public void Trace(string msg, Exception err)
        {
            _logger.Trace(err, msg);
        }
        #endregion

        #region Error
        public void Error(string msg, params object[] args)
        {
            _logger.Error(msg, args);
        }

        public void Error(string msg, Exception err)
        {
            _logger.Error(err, msg);
        }
        #endregion

        #region Fatal
        public void Fatal(string msg, params object[] args)
        {
            _logger.Fatal(msg, args);
        }

        public void Fatal(string msg, Exception err)
        {
            _logger.Fatal(err, msg);
        }
        #endregion

        #region Custom

        public void Process(Models.Log log)
        {
            var level = LogLevel.Info;
            if (log.Level == Models.EFLogLevel.Trace)
                level = LogLevel.Trace;
            else if (log.Level == Models.EFLogLevel.Debug)
                level = LogLevel.Debug;
            else if (log.Level == Models.EFLogLevel.Info)
                level = LogLevel.Info;
            else if (log.Level == Models.EFLogLevel.Warn)
                level = LogLevel.Warn;
            else if (log.Level == Models.EFLogLevel.Error)
                level = LogLevel.Error;
            else if (log.Level == Models.EFLogLevel.Fatal)
                level = LogLevel.Fatal;

            var ei = new MyLogEventInfo(level, _logger.Name, log.Message);
            ei.TimeStamp = log.Timestamp;
            ei.Properties["Action"] = log.Action;
            ei.Properties["Amount"] = log.Amount;

            _logger.Log(level, ei);
        }

        #endregion

        /// <summary>
        /// Flush any pending log messages (in case of asynchronous targets).
        /// </summary>
        /// <param name="timeoutMilliseconds">Maximum time to allow for the flush. Any messages after that time will be discarded.</param>
        public void Flush(int? timeoutMilliseconds = null)
        {
            if (timeoutMilliseconds != null)
                NLog.LogManager.Flush(timeoutMilliseconds.Value);

            NLog.LogManager.Flush();
        }
    }

    public class MyLogEventInfo : LogEventInfo
    {
        public MyLogEventInfo() { }
        public MyLogEventInfo(LogLevel level, string loggerName, string message) : base(level, loggerName, message)
        { }

        public override string ToString()
        {
            //Message format
            //Log Event: Logger='XXX' Level=Info Message='XXX' SequenceID=5
            return FormattedMessage;
        }
    }
public class Log : IEntityBase<long>
    {
        public long Id { get; set; }
        /// <summary>
        /// 日誌級別 Trace|Debug|Info|Warn|Error|Fatal
        /// </summary>
        public string Level { get; set; }        
        public string Message { get; set; }
        public string Action { get; set; }
        public string Amount { get; set; }
        public string StackTrace { get; set; }
        public DateTime Timestamp { get; set; }

        private Log() { }
        public Log(string level, string message, string action = null, string amount = null)
        {
            this.Level = level;
            this.Message = message;
            this.Action = action;            
            this.Amount = amount;
        }
    }
  • Models.Log是我們專案裡的日誌物件，它對應一個數據表Log，NLog將日誌資料寫入到這個表；
  • Process(Models.Log)是我們處理自定義物件的日誌方法，用LogEventInfo來寫入；
  • 重寫 LogEventInfo.ToString() 是因為 LogEventInfo的Message格式是“Log Event: Logger='XXX' Level=Info Message='XXX' SequenceID=5”，不便於查閱，我們只需要我們設定的Message。

使用：

下面是測試方法，我們一共輸出9條日誌，這9條日誌將輸出到哪個目標，由配置檔案中的Rules/logger決定

Logger.Default.Trace("Hello World! Trace");
Logger.Default.Info("Hello World! Info");
Logger.Default.Warn("Hello World! Warn");
Logger.Default.Debug("Hello World! Debug");
Logger.Default.Error("Hello World! Error");
Logger.Default.Fatal("Hello World! Fatal");

Logger.Default.Process(new Models.Log(Models.EFLogLevel.Info, "Hello World! Info", "TEST", "100.00"));
Logger.Default.Process(new Models.Log(Models.EFLogLevel.Debug, "Hello World! Debug", "TEST", "100.00"));
Logger.Default.Process(new Models.Log(Models.EFLogLevel.Error, "Hello World! Error", "TEST", "100.00"));
Logger.Default.Flush();

因為我們在Target中設定了非同步，所以如果我們想當場看到輸出結果，就需要使用Flush()方法，實際輸出日誌時就不需要了。

結果：

檢視日誌記錄：

相關推薦

C# 使用NLog記錄日誌

引用：https://www.cnblogs.com/felixnet/p/5498759.html NLog是一個記錄日誌元件，和log4net一樣被廣泛使用，它可以將日誌儲存到文字檔案、CSV、控制檯、VS除錯視窗、資料庫等。最近剛用到這個元件，覺得不錯，水一

ASP.NET Core：ASP.NET Core中使用NLog記錄日誌

一、前言 在所有的應用程式中，日誌功能是不可或缺的模組，我們可以根據日誌資訊進行除錯、檢視產生的錯誤資訊，在ASP.NET Core中我們可以使用log4net或者NLog日誌元件來實現記錄日誌的功能，這裡講解如何在ASP.NET

NLog記錄日誌到Oracle資料庫

之前我們使用NLog記錄日誌到記事本的功能愉快的使用著，可是突然有一天領導要求統計一下報錯的日誌數量，茫茫記事本怎麼破，於是寫了個程式來讀取記事本統計，這種原始的方式著實讓人蛋疼，好在NLog提供了記錄到資料

.NET Core使用Nlog記錄日誌

NLog是適用於各種.NET平臺（包括.NET標準）的靈活，免費的日誌記錄平臺。NLog使寫入多個目標變得容易 。（資料庫，檔案，控制檯）並即時更改日誌記錄配置。

.net core 3.1 使用nlog記錄日誌 NLog.Web.AspNetCore

.net core 3.1 使用nlog記錄日誌 NLog.Web.AspNetCore 背景 .net core 中已經集成了log的方法, 但是隻能控制檯輸出不能寫入檔案等等. 常見第三方的的日誌工具包括log4net, nlog等等, 本文介紹nlog

.Net Core 使用NLog記錄日誌到檔案和資料庫的操作方法

NLog 記錄日誌是微軟官方推薦使用。 接下來，通過配置日誌記錄到檔案和Sql Server。

.net core 3.1 使用nlog進行日誌記錄

1、新增NuGet NLog.Web.AspNetCore 2、Program.cs 注入, UseNLog() 1public static IHostBuilder CreateHostBuilder(string[] args) =>

C#使用log4net記錄日誌

一、Nuget安裝log4net --> Install-Package log4net 二、在AssemblyInfo.cs檔案中新增log4net.dll的引數。

C#在伺服器中記錄日誌的方法【簡單】

今天我們來寫一個記錄日誌的方法 日誌是我們在開發環境中必不可少的記錄Bug點的東西。那麼用C#中的原生File應該怎麼去寫呢？

.Net Core(.NET6)中接入Log4net和NLog進行日誌記錄

一、接入Log4net 1.按日期和大小混合分割日誌 nuget包安裝 log4net Microsoft.Extensions.Logging.Log4Net.AspNetCore

python3中的logging記錄日誌實現過程及封裝成類的操作

作用： 主要記錄資訊，便於定位檢視問題。 python logging模組官網： https://docs.python.org/zh-cn/3.7/library/logging.html#formatter-objects

Django在Model儲存前記錄日誌例項

Django中如何在Model儲存前做一定的固定操作，比如寫一句日誌？ 關鍵詞: 訊號 利用Django的Model的Signal Dispatcher,通過django.db.models.signals.pre_save() 方法，在事件發生前，

C#NLog幫助類同時輸出內容到檔案和文字框

1.引用NLog.dll檔案 2.在主窗體加入以下程式碼進行格式化 1//初始化程式碼 2private void Initlogger()

Springboot介面專案如何使用AOP記錄日誌

一、 背景 一直想給專案構建一個統一的日誌收集系統，先邁出第一步，構建一個日誌收集類，用AOP實現無侵入日誌收集

筆試考試系統--專案搭建及用Log4Net記錄日誌

專案架構搭建一、專案整體採用分層結構，不搞傳統的三層架構，直接用Ul+Service (只是根據專案的不同的變體而已，思想上沒什麼不-樣)，建ExamOnLine.Common、ExamOnLine.IService、ExamOnLine. Service、ExamOnLine.

Nodejs怎樣在服務端寫定時指令碼,自動備份MongoDB資料庫,並記錄日誌

注意：mongod服務需提前開啟 定時任務 安裝模組 npm install node-schedule -S 使用方法

.NET CORE webApi 使用log4net記錄日誌

一、為什麼使用log4net 日誌的重要性就闡述了，為什麼使用log4net，這裡說一下，因為使用人群廣泛，效能又相差無幾，那當然是用的人越多越好了，流量才是王道。

Shell 指令碼自動監控重啟 httpd 服務並記錄日誌

環境 CentOS7 思路 設定一個死迴圈，執行指令碼時開始啟動 httpd 服務，同時開始記錄當前時間，然後輸出到日誌中，再 sleep 14 秒，之後馬上開始停止 httpd 服務，同時開始記錄當前時間，然後輸出到日誌中。重複這個

Identityserver4在.netCore3上的錯誤記錄日誌

一、報下面的錯誤 {StatusCode: 401, ReasonPhrase: \'Unauthorized\', Version: 1.1, Content: System.Net.Http.StreamContent, Headers:

c++ 學習記錄 建構函式 成員變數的初始化

參考連結：http://c.biancheng.net/view/2223.html 在建構函式中對成員變數初始化的方法有倆種