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

  <!-- 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 類的實例並使用它來記錄調試級別的消息。 讓我們探索 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

我們的程序已在控制台中記錄了消息，如下所示。

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

將消息記錄到文件

我們需要在配置文件中設置文件目標而不是控制台目標來進行文件記錄。

<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