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

若要建立 NLog 配置檔案 (通常命名為 nlog.config)，您可以遵循下列步驟。 此設定檔將指定 NLog 在您的應用程式中應該如何運作，包括日誌目標、版面呈現器和規則。

在專案中，用滑鼠右鍵按一下要建立組態檔案的專案或所需資料夾。

1.選擇"新增">"新增項目..."。 2.在"新增項目"對話方塊中，搜尋"XML 檔案"或"XML"並選取。 3.將檔案命名為 nlog.config，然後按一下"新增"按鈕。

4.在文字編輯器或 XML 編輯器中開啟新建立的 nlog.config 檔案。 5.在 NLog.XML 檔案中加入下列設定。以下是 NLog 配置的基本範例，可將訊息記錄至 Console 目標。 您可以自訂此組態檔案以符合您的需求：

設定檔

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

  <!-- Define targets -->
  <targets>
    <!-- Log to a console -->
    <target name="console" xsi:type="Console" layout="${longdate}|${message}"/>
  </targets>

  <!-- Define rules -->
  <rules>
    <!-- All messages with a minimum log level of Debug or higher are written to the Console -->
    <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">

  <!-- Define targets -->
  <targets>
    <!-- Log to a console -->
    <target name="console" xsi:type="Console" layout="${longdate}|${message}"/>
  </targets>

  <!-- Define rules -->
  <rules>
    <!-- All messages with a minimum log level of Debug or higher are written to the Console -->
    <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 Level 記錄訊息。 讓我們探索 NLog 支援的追蹤層級。

記錄層級

NLog 支援多種記錄層級，每種層級都有其重要性：

1.追蹤：最詳細的層級，通常用於診斷目的。 2.除錯：用於在開發過程中提供有幫助的除錯資訊。 3.資訊：有關應用程式運作的一般資訊。 4.警告：表示不會擾亂應用程式的潛在問題。 5.錯誤：表示應該調查的故障，但不一定會讓應用程式當機。 6.致命：表示應立即處理的嚴重故障。

透過將日誌訊息分類為這些等級，您可以輕鬆地根據其嚴重性過濾和排序。

如下所示，在 nLog.Config 檔案的規則標籤中設定 minlevel="Trace" 。

<rules>
  <!-- All messages with a minimum log level of Trace or higher are written to the Console -->
  <logger name="*" minlevel="Trace" writeTo="console" />
</rules>

<rules>
  <!-- All messages with a minimum log level of Trace or higher are written to the Console -->
  <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

我們的程式在 Console 中記錄的訊息如下所示。

!a href="/static-assets/pdf/blog/nlog-csharp-guide/nlog-csharp-guide-3.webp">nlog 日誌訊息。

現在，我們示範了在 Console 中記錄訊息的範例。 現在我們將設定一個 NLog 目標，將訊息記錄在檔案中。

檔案中的記錄訊息

我們需要在檔案記錄的設定檔中設定檔案目標，而非 Console 目標。

<targets>
  <!-- Log to a file at specified location -->
  <target xsi:type="File" name="fileTarget" fileName="D:\Logs\mylog.txt" layout="${longdate} ${level:uppercase=true} ${message}" />
</targets>

<rules>
  <!-- All messages with a minimum log level of Trace or higher are written to the file -->
  <logger name="*" minlevel="Trace" writeTo="fileTarget" />
</rules>

<targets>
  <!-- Log to a file at specified location -->
  <target xsi:type="File" name="fileTarget" fileName="D:\Logs\mylog.txt" layout="${longdate} ${level:uppercase=true} ${message}" />
</targets>

<rules>
  <!-- All messages with a minimum log level of Trace or higher are written to the file -->
  <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