NLog 是一套 Open Source 的 Log 工具，支援多種 .Net 平台，使用上簡單又具備調整的彈性。

可以跟著 NLog 官網教學安裝。安裝好 NLog 後，可以藉由調整 nlog.config 來調整 Log 的格式。以下介紹 nlog.config 檔案的常用設定值 (也可直接查詢 Configuration file · NLog/NLog Wiki)。

Target 功能

指定訊息要輸出的目標，常用的 target 如下：

Rule 功能

Rule 功能可以限制不同等級的訊息輸出到特定的目標 (Target) ，如檔案或網路位址。

部分會用到的 Rule 元素如下：

Layout 功能

Layout 功能是依照特定標籤和格式顯示 Log，標籤可稱為 Layout Renderer，包含多種實用的除錯內容。

部分會使用到的 Layout 標籤如下：

詳細列表可以參考：Layout Renderers - Config - NLog

Log 等級

NLog 的 Log 等級可以分成以下幾種，順序越大表示嚴重性越高：

加入 Trace ID

若想加入每個 API 請求的 Trace ID，以增加除錯的觀察性，可以安裝 NLog.DiagnosticSource  套件：GitHub - NLog/NLog.DiagnosticSource 。這個套件是 Microsoft Activity Trace (.NET 分散式追蹤) 的 NLog Layout Renderer。

可以透過 NuGet 管理員安裝套件，並在 nlog.config 內加入：

<extensions>
    <add assembly="NLog.DiagnosticSource"/>
</extensions>

即安裝完成。接著在 nlog.config 的 Layout 內增加 activity:property=TraceId 屬性，例如：

<target xsi:type="File" name="web" fileName="${shortdate}.log"
  layout="${time}-[${level}]-[${activity:property=TraceId:truncate=6}]-${replace-newlines:${message}} ${exception:format=tostring}" />

File Target

如果要將 Log 寫在檔案內，可以設定 File Target 達到這個目標。

請參考以下的 File Target：

<target name="file" 
xsi:type="File" 
keepFileOpen="true"
layout="${time}-[${level}]-[${activity:property=TraceId:truncate=6}]-${replace-newlines:${message}} ${exception:format=tostring}"
fileName="Path/${machinename}-${shortdate}.txt"
encoding="UTF-8"/> 

常用的參數說明如下：

如果要定期刪除 Log，避免佔用過多磁碟空間的話，要啟用歸檔的相關設定。歸檔功能可以幫你依照條件刪除過久的 Log，但建議被歸檔的 Log 路徑不啟用動態的 Layout 標籤，避免歸檔失敗。

範例如下：

<target name="file" xsi:type="File" keepFileOpen="true"
	layout="${time}-[${level}]-[${activity:property=TraceId:truncate=6}]-${replace-newlines:${message}} ${exception:format=tostring}"
	fileName="Path/CurrentLog.txt"
	archiveFileName="Path/ArchiveLog.{#}.txt"
	archiveEvery="Hour"
	maxArchiveFiles="24"
	encoding="UTF-8" />

常用的參數說明如下：

archiveEvery 可以填入以下的單位：

請參考：

• File target · NLog/NLog Wiki · GitHub
• c# - NLog - delete logs older than X days - Stack Overflow
• NET C# 使用NLog 紀錄封存處理切割、最多天數、壓縮 · vulcanlee/Blogs2023 · GitHub
• NLog配置文件详解-CSDN博客

Memory Target

Memory Target 適用於應用程式內取得寫入的訊息紀錄，因為存取 File Target 時，可能會遇到 NLog 正在占用的情形，可參考：NLog get log message in c# - Stack Overflow。

綜合參考資料

基礎介紹與安裝：.NET Core - 使用 NLog 紀錄日誌資訊 - Tim Chen’s Blog