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

若要建立 NLog 設定檔（通常命名為 nlog.config），您可以按照下列步驟操作。 此設定檔將指定 NLog 在您的應用程式中的行為方式，包括日誌目標、佈局渲染器和規則。

在專案中，右鍵單擊專案或要建立設定檔的目標資料夾。

1. 選擇"新增" > "新建項目..."
2. 在"新增項目"對話方塊中，搜尋"XML 檔案"或"XML"並選擇它。

3. 將檔案命名為 nlog.config，然後按一下"新增"按鈕。

   

4. 在文字編輯器或 XML 編輯器中開啟新建立的 nlog.config 檔案。
5. 在 NLog.XML 檔案中新增以下配置。以下是將訊息記錄到控制台目標的 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 5 或更早版本)、program.cs 檔案(適用於.NET 6 或更高版本)或控制台應用程式的 Main 方法.NET：

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();
    }
}

上述程式的輸出結果如下所示：

在這個例子中，我們建立了一個 Logger 類別的實例，並使用它來記錄偵錯層級的訊息。 讓我們來探討一下 NLog 支援的追蹤等級。

日誌等級

NLog 支援多種日誌級別，每種級別都有其自身的意義：

1. 微量：最詳細的級別，通常用於診斷目的。
2. 調試：用於調試訊息，這些資訊在開發過程中可能有所幫助。
3. 資訊：有關應用程式運行的一般資訊。
4. 警告：表示有潛在問題，但不會中斷應用程式運行。
5. 錯誤：表示有需要調查的故障，但不一定會導致應用程式崩潰。
6. 致命：表示有嚴重故障，應立即處理。

透過將日誌訊息分類到這些級別，您可以輕鬆地根據其嚴重性對其進行篩選和優先排序。

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

<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();
    }
}

我們的程式已在控制台中記錄如下所示的訊息。

現在，我們已經示範如何在控制台中記錄訊息。 現在我們將配置一個 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");
    }
}