NLog C#（開發者的工作原理）

要建立 NLog 配置文件（通常命名為 nlog.config），您可以按照以下步驟進行。 該配置文件將指定 NLog 在您的應用程式中應如何運作，包括記錄目標、佈局渲染器和規則。

在您的專案中，右鍵單擊專案或您希望建立配置文件的資料夾。

1. 選擇"新增" > "新項目..."
2. 在"新增新項目"對話框中，搜索"XML 文件"或"XML"並選擇它。

3. 將文件命名為 nlog.config 並點擊"新增"按鈕。

   

4. 在文字編輯器或 XML 編輯器中打開新建立的 nlog.config 文件。
5. 在 NLog.XML 文件中新增以下配置。以下是以 Console 為目標的 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">

  <targets>

    <target name="console" xsi:type="Console" layout="${longdate}|${message}"/>
  </targets>

  <rules>

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

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

  <targets>

    <target name="console" xsi:type="Console" layout="${longdate}|${message}"/>
  </targets>

  <rules>

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

</nlog>

在您的 C# 程式碼中，確保從 nlog.config 文件載入 NLog 配置。您通常會在應用程式的啟動程式碼中執行這個操作，例如在 ASP.NET Core 的 Startup.cs（.NET 版本相同或老於 .NET 5）、program.cs 文件（.NET 6 或更新版）或主控台應用的 Main 方法中：

using NLog;

internal class Program
{
    // Create an instance of the Logger
    private static Logger logger = LogManager.GetCurrentClassLogger();

    static void Main(string[] args)
    {
        // Log a debug message
        logger.Debug("This is a Debug Message");

        // Pause the console for viewing output
        Console.Read();
    }
}

using NLog;

internal class Program
{
    // Create an instance of the Logger
    private static Logger logger = LogManager.GetCurrentClassLogger();

    static void Main(string[] args)
    {
        // Log a debug message
        logger.Debug("This is a Debug Message");

        // Pause the console for viewing output
        Console.Read();
    }
}

Imports NLog

Friend Class Program
	' Create an instance of the Logger
	Private Shared logger As Logger = LogManager.GetCurrentClassLogger()

	Shared Sub Main(ByVal args() As String)
		' Log a debug message
		logger.Debug("This is a Debug Message")

		' Pause the console for viewing output
		Console.Read()
	End Sub
End Class

上述程式的輸出如圖所示：

在這個範例中，我們建立了 Logger 類的實例，並使用它記錄在 Debug 等級下的消息。 讓我們來探索 NLog 支持的跟踪等級。

記錄等級

NLog 支持多個記錄等級，每個具有其自己的重要性：

1. 跟踪：最詳細的等級，通常用於診斷目的。
2. 除錯：用於除錯資訊，在開發期間可以提供幫助。
3. 資訊：關於應用程式運行的一般資訊。
4. 警告：表示潛在問題但不破壞應用程式。
5. 錯誤：表示一個失敗應被調查但不一定會崩潰應用程式。
6. 嚴重：表示需要立即解決的關鍵故障。

通過將記錄消息分類到這些等級中，您可以根據其嚴重性輕鬆過濾和優先處理它們。

如下面所示，將 minlevel="Trace" 設置在 nLog.Config 文件中的規則標籤。

<rules>

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

<rules>

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

讓我們寫程式碼來記錄所有跟踪等級的消息。

using NLog;

internal class Program
{
    // Create an instance of the Logger
    private static Logger logger = LogManager.GetCurrentClassLogger();

    static void Main(string[] args)
    {
        // Log messages of different tracking levels
        logger.Trace("This is a Trace Message");
        logger.Debug("This is a Debug Message");
        logger.Info("This is an Info Message");
        logger.Warn("This is a Warning Message");
        logger.Error("This is an Error Message");
        logger.Fatal("This is a Fatal Message");

        // Pause the console for viewing output
        Console.Read();
    }
}

using NLog;

internal class Program
{
    // Create an instance of the Logger
    private static Logger logger = LogManager.GetCurrentClassLogger();

    static void Main(string[] args)
    {
        // Log messages of different tracking levels
        logger.Trace("This is a Trace Message");
        logger.Debug("This is a Debug Message");
        logger.Info("This is an Info Message");
        logger.Warn("This is a Warning Message");
        logger.Error("This is an Error Message");
        logger.Fatal("This is a Fatal Message");

        // Pause the console for viewing output
        Console.Read();
    }
}

Imports NLog

Friend Class Program
	' Create an instance of the Logger
	Private Shared logger As Logger = LogManager.GetCurrentClassLogger()

	Shared Sub Main(ByVal args() As String)
		' Log messages of different tracking levels
		logger.Trace("This is a Trace Message")
		logger.Debug("This is a Debug Message")
		logger.Info("This is an Info Message")
		logger.Warn("This is a Warning Message")
		logger.Error("This is an Error Message")
		logger.Fatal("This is a Fatal Message")

		' Pause the console for viewing output
		Console.Read()
	End Sub
End Class

我們的程式已在主控台中記錄消息，如下所示。

nlog 記錄消息

現在，我們已經演示了在主控台中記錄消息的範例。 現在，我們將配置一個 NLog 目標以將消息記錄到文件中。

文件中記錄消息

我們需要在配置文件中設置一個文件目標而不是主控台目標以進行文件記錄。

<targets>

  <target xsi:type="File" name="fileTarget" fileName="D:\Logs\mylog.txt" layout="${longdate} ${level:uppercase=true} ${message}" />
</targets>

<rules>

  <logger name="*" minlevel="Trace" writeTo="fileTarget" />
</rules>

<targets>

  <target xsi:type="File" name="fileTarget" fileName="D:\Logs\mylog.txt" layout="${longdate} ${level:uppercase=true} ${message}" />
</targets>

<rules>

  <logger name="*" minlevel="Trace" writeTo="fileTarget" />
</rules>

現在，運行程式以將消息記錄到文件中。

記錄目標

NLog 支持多個記錄輸出目標，允許您選擇您的記錄消息應儲存的位置。 一些常見的目標包括：

1. 文件：將訊息記錄到一個或多個文件。
2. 主控台：將訊息記錄到主控台。
3. 資料庫：將訊息記錄到資料庫（SQL Server、MySQL、Oracle、PostgreSQL等）中。
4. 電子郵件：將記錄消息作為電子郵件發送。
5. 事件記錄：將訊息記錄到 Windows 事件記錄中。
6. 自定義目標：您可以建立自定義日誌目標以符合您的特定需求。

您可以配置 NLog 同時使用一個或多個目標。

使用日誌生成 PDF

Install-Package IronPdf

using NLog;
using IronPdf;

internal class Program
{
    // Create an instance of the Logger
    private static Logger logger = LogManager.GetCurrentClassLogger();

    static void Main(string[] args)
    {
        logger.Info("Initializing Chrome PDF Renderer");
        ChromePdfRenderer renderer = new ChromePdfRenderer();

        logger.Info("Creating PDF From HTML String");
        var pdf = renderer.RenderHtmlAsPdf("<h1>This is my Sample PDF<h1>");

        logger.Info("Saving PDF File");
        pdf.SaveAs(@"D:\myPDF.pdf");
    }
}

using NLog;
using IronPdf;

internal class Program
{
    // Create an instance of the Logger
    private static Logger logger = LogManager.GetCurrentClassLogger();

    static void Main(string[] args)
    {
        logger.Info("Initializing Chrome PDF Renderer");
        ChromePdfRenderer renderer = new ChromePdfRenderer();

        logger.Info("Creating PDF From HTML String");
        var pdf = renderer.RenderHtmlAsPdf("<h1>This is my Sample PDF<h1>");

        logger.Info("Saving PDF File");
        pdf.SaveAs(@"D:\myPDF.pdf");
    }
}

Imports NLog
Imports IronPdf

Friend Class Program
	' Create an instance of the Logger
	Private Shared logger As Logger = LogManager.GetCurrentClassLogger()

	Shared Sub Main(ByVal args() As String)
		logger.Info("Initializing Chrome PDF Renderer")
		Dim renderer As New ChromePdfRenderer()

		logger.Info("Creating PDF From HTML String")
		Dim pdf = renderer.RenderHtmlAsPdf("<h1>This is my Sample PDF<h1>")

		logger.Info("Saving PDF File")
		pdf.SaveAs("D:\myPDF.pdf")
	End Sub
End Class