Serilog .NET（開發者的工作原理）

結構化日誌

Serilog 的突出特點之一是支援結構化日誌。 Serilog 可讓您記錄結構化資料，而非簡單地以純文字記錄訊息。 此結構化資料可以是 JSON 物件、字典或任何其他可序列化的類型。 透過記錄結構化資料，您可以使用 Elasticsearch 或 Splunk 等工具輕鬆分析和查詢日誌事件。

彈性配置

Serilog 提供彈性的設定選項，讓您可以根據應用程式的需求自訂記錄行為。 您可以程式化或使用設定檔來設定 Serilog。 這種靈活性可讓您在執行時調整記錄行為，而不需要重新啟動應用程式。

下沉函式庫

Serilog 提供各種 sink 函式庫，可讓您將日誌事件傳送到不同的目的地。 一些受歡迎的 sink 函式庫包括：

• Serilog.Sinks.Console：將日誌事件傳送至控制台。
• Serilog.Sinks.File：將日誌事件寫入文字檔。
• Serilog.Sinks.Seq：將日誌事件傳送至結構化日誌伺服器 Seq。
• Serilog.Sinks.Elasticsearch： 將日誌事件傳送至 Elasticsearch。

這些 sink 函式庫可讓 Serilog 輕鬆與不同的日誌基礎架構和工具整合。

豐富記錄

日誌豐富化是一種功能，可讓您在日誌事件中加入額外的上下文資訊。 Serilog 提供多種豐富器，可自動在日誌事件中加入時間戳記、執行緒 ID 或日誌層級等資訊。 您也可以建立客製化的豐富內容，以加入應用程式特有的資訊。

記錄過濾

Serilog 允許您根據各種條件過濾日誌事件。 您可以根據日誌層級、屬性值或任何其他條件，設定篩選器以排除或包含日誌事件。 此過濾功能可讓您專注於與您的分析或故障排除最相關的日誌事件。

透過瞭解並利用這些功能，您可以利用 Serilog 的強大功能來增強您的日誌功能，並獲得關於應用程式行為的寶貴洞察力。

結構化日誌：核心功能

Serilog 的主要優勢在於將日誌訊息轉換為結構化資料。 與其他輸出純文字的日誌函式庫不同，Serilog 以結構化的 JSON 格式產生日誌，簡化了日誌資料的解析與查詢。 這項能力對於現代的應用程式至關重要，在這些應用程式中，日誌分析和監控是作業智慧不可或缺的部分。 當日誌訊息被擷取至 ELK（Elasticsearch、Logstash、Kibana）堆疊等系統進行進階分析時，結構化日誌尤其有利。

豐富的日誌事件詳細資訊

Serilog 利用上下文資訊來豐富日誌事件，提供應用程式內部所發生事情的全面檢視。 每個日誌事件除了簡單的日誌訊息外，還可能包含許多詳細資訊，包括時間戳記、日誌層級、異常詳細資訊和自訂屬性。 這使得 Serilog 在日誌的深度和清晰度方面優於其他日誌函式庫，為開發人員提供應用程式行為和效能的重要洞察力。

透過組態檔案

使用組態 JSON 檔案定義日誌層級、輸出目的地 (如日誌檔案或主控台) 以及日誌輸出格式。 組態檔方式提供了在不修改程式碼的情況下變更記錄行為的靈活性。 這是透過在 appsettings.json 檔案中指定設定來實現的，該檔案允許您將日誌輸出導向到各種接收器，例如主控台、檔案，甚至是基於雲端的日誌管理服務。

程式化的程式碼

或者，使用 LoggerConfiguration 類別直接在程式碼中設定 Serilog。 此方法常用於設定較複雜的日誌情境，例如動態日誌層級或自訂日誌 sink。 例如，您可以設定滾動日誌檔案，在特定時間間隔或達到一定大小時建立新的日誌檔案，確保有效的日誌檔案管理。

// Create a logger instance with a rolling log file that creates a new log file every day
var logger = new LoggerConfiguration()
    .WriteTo.File("logs/myapp.txt", rollingInterval: RollingInterval.Day) 
    .CreateLogger();

// Create a logger instance with a rolling log file that creates a new log file every day
var logger = new LoggerConfiguration()
    .WriteTo.File("logs/myapp.txt", rollingInterval: RollingInterval.Day) 
    .CreateLogger();

' Create a logger instance with a rolling log file that creates a new log file every day
Dim logger = (New LoggerConfiguration()).WriteTo.File("logs/myapp.txt", rollingInterval:= RollingInterval.Day).CreateLogger()

與 ASP.NET Core 整合

將 Serilog 與 ASP.NET Core 整合需要透過套件管理器控制台新增 Serilog 套件，並在 Program.cs 檔案中設定日誌記錄器。 .NET 6 中的 var builder 和 var app 語句可將 Serilog 無縫整合到應用程式的日誌記錄基礎架構中。 此程序會使用 Serilog 取代預設的日誌記錄器，確保所有日誌訊息都會透過 Serilog 管道處理。

var builder = WebApplication.CreateBuilder(args);

// Configure Serilog to use settings from appsettings.json and write logs to the console
builder.Host.UseSerilog((ctx, lc) => lc
    .WriteTo.Console()
    .ReadFrom.Configuration(ctx.Configuration));

var app = builder.Build();

var builder = WebApplication.CreateBuilder(args);

// Configure Serilog to use settings from appsettings.json and write logs to the console
builder.Host.UseSerilog((ctx, lc) => lc
    .WriteTo.Console()
    .ReadFrom.Configuration(ctx.Configuration));

var app = builder.Build();

Dim builder = WebApplication.CreateBuilder(args)

' Configure Serilog to use settings from appsettings.json and write logs to the console
builder.Host.UseSerilog(Function(ctx, lc) lc.WriteTo.Console().ReadFrom.Configuration(ctx.Configuration))

Dim app = builder.Build()

IronPDF

IronPDF 允許在 .NET 應用程式中建立、閱讀和編輯 PDF。 當結合 Serilog 來產生日誌資料的 PDF 報告時，這會特別有用，可讓您輕鬆地以標準格式散佈和檢視日誌資訊。

IronOCR

IronOCR 是一個光學字元識別 (OCR) 函式庫，可將 125 種語言的影像翻譯成文字。 此功能可應用於必須從影像或掃描文件中萃取文字資料的記錄情境，從而以更多的上下文資訊來豐富記錄資料。

IronXL

IronXL.Excel 提供與 Excel 搭配使用的功能，而不需要 Office Interop。這對於日誌用途特別有利，因為日誌資料可以匯出到 Excel 以進一步分析和報告，提供熟悉的資料操作和可視化介面。

IronBarcode

IronBarcode 有助於讀寫 QR 碼和 BarCode。 這個函式庫可以在日誌檔案中嵌入或抽取編碼資訊，強化日誌資訊的安全性與可追蹤性。