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

結構化日誌

Serilog 的一個顯著功能是其對結構化日誌的支持。 Serilog 不僅僅是將消息記錄為純文字，它允許您記錄結構化資料。 這些結構化資料可以是 JSON 物件、字典或任何可以序列化的型別。 通過記錄結構化資料，您可以輕鬆使用例如 Elasticsearch 或 Splunk 等工具分析和查詢日誌事件。

靈活的配置

Serilog 提供靈活的配置選項，允許您根據應用程式的需求自定義日誌記錄行為。 您可以通過程式方式或使用配置檔案配置 Serilog。 這種靈活性允許您在運行時調整日誌記錄行為，而無需重新啟動應用程式。

接收器程式庫

Serilog 提供各種接收器程式庫，允許您將日誌事件發送到不同的目的地。 一些受歡迎的接收器程式庫包括：

• Serilog.Sinks.Console：將日誌事件發送到控制台。
• Serilog.Sinks.File：將日誌事件寫入文字檔案。
• Serilog.Sinks.Seq：將日誌事件發送到 Seq（一個結構化日誌伺服器）。
• Serilog.Sinks.Elasticsearch：將日誌事件發送到 Elasticsearch。

這些接收器程式庫使得將 Serilog 與不同的日誌記錄基礎設施和工具整合變得容易。

日誌豐富化

日誌豐富化是一個允許您向日誌事件新增額外上下文資訊的功能。 Serilog 提供各種豐富化器，可自動將時間戳、執行緒 ID 或日誌級別等資訊新增到您的日誌事件中。 您還可以建立自定義豐富化器以新增應用程式特定的資訊。

日誌過濾

Serilog 允許您根據不同的條件篩選日誌事件。 您可以配置過濾器根據日誌級別、屬性值或任何其他條件來排除或包含日誌事件。 這種過濾功能使您能夠專注於最相關的日誌事件以進行分析或故障排除。

通過理解和利用這些功能，您可以運用 Serilog 的威力來增強您的日誌記錄能力，並深入了解應用程式的行為。

結構化日誌：核心功能

Serilog 的主要優勢在於將日誌消息轉換為結構化資料。 與輸出純文字的其他日誌記錄程式庫不同，Serilog 以結構化 JSON 格式生成日誌，簡化了日誌資料的解析和查詢。 此功能對於現代應用程式尤為重要，因為日誌分析和監控是運營智能的核心。 當日誌消息輸入到例如 ELK（Elasticsearch, Logstash, Kibana）堆棧等系統進行高級分析時，結構化日誌特別有益。

豐富的日誌事件詳細資訊

Serilog 豐富了日誌事件，增添了上下文資訊，提供了應用程式內部情況的完整視圖。 每個日誌事件可以包含除簡單日誌消息之外的許多細節，包括時間戳、日誌級別、異常詳細資訊和自定義屬性。 這使得 Serilog 在日誌的深度和清晰度方面優於其他日誌記錄程式庫，為開發者提供應用程式行為和性能的關鍵見解。

通過配置檔案

使用配置 JSON 檔案定義日誌級別、輸出目的地（如日誌檔案或控制台）以及日誌輸出格式。 配置檔案的方法提供了在不修改程式碼的情況下更改日誌行為的靈活性。 這是通過在 appsettings.json 檔案中指定設置來完成的，允許您將日誌輸出直至多個接收器，例如控制台、檔案，甚至是基於雲的日誌管理服務。

在程式碼中程式化方式

或者，可以使用 LoggerConfiguration 類直接在程式碼中配置 Serilog。 此方法常用於設置更複雜的日誌記錄方案，例如動態日誌級別或自定義日誌接收器。 例如，您可以配置一個滾動日誌檔案，在特定間隔或達到一定大小時建立新的日誌檔案，以確保高效的日誌檔案管理。

// 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 提供在不需要 Office Interop 的情況下操作 Excel 的功能。這對於日誌記錄來說特別有用，因為日誌資料可以導出到 Excel 中進一步分析和報告，為資料操作和視覺化提供了熟悉的介面。

IronBarcode

IronBarcode 方便讀取和寫入 QR 碼和條碼。 這個程式庫可以在日誌文件中嵌入或提取編碼資訊，增強日誌資訊的安全性和可追溯性。