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

結構化日誌

Serilog 的一大特色是其支持結構化日誌。 Serilog 不僅僅將消息作為純文本記錄，還允許您記錄結構化數據。 這些結構化數據可以是 JSON 對象、字典或任何可以序列化的類型。 通過記錄結構化數據，您可以輕鬆使用像 Elasticsearch 或 Splunk 這樣的工具分析和查詢日誌事件。

靈活的配置

Serilog 提供靈活的配置選項，讓您根據應用需求自定義日誌行為。 您可以使用編程方式或配置文件來配置 Serilog。 這種靈活性允許您在運行時調整日誌行為，而不需要重啟應用。

Sink 日誌庫

Serilog 提供了各種 Sink 日誌庫，允許您將日誌事件發送到不同的目的地。 一些流行的 Sink 日誌庫包括：

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

這些 Sink 日誌庫使 Serilog 與不同的日誌基礎設施和工具的整合變得輕鬆。

日誌豐富功能

日誌豐富功能允許您為日誌事件添加額外的上下文信息。 Serilog 提供各種豐富器，能自動將時間戳、線程 ID 或日誌級別等信息添加到日誌事件中。 您還可以創建自定義豐富器，以添加特定於應用的資訊。

日誌過濾

Serilog 允許您根據各種標準過濾日誌事件。 您可以配置過濾器，以根據日誌級別、屬性值或其他條件排除或包含日誌事件。 這種過濾功能使您能夠專注於與分析或故障排除最相關的日誌事件。

通過瞭解和利用這些特性，您可以使用 Serilog 增強您的日誌功能，從而深入了解應用的行為。

結構化日誌: A Core Feature

Serilog 的主要優勢在於將日誌消息轉化為結構化數據。 不同於其他輸出純文本的日誌庫，Serilog 以結構化 JSON 格式生成日誌，簡化對日誌數據的解析和查詢。 此功能對於現代應用至關重要，因為日誌分析和監控成為運營智能中的一個整體。 當日誌消息輸入像 ELK（Elasticsearch、Logstash、Kibana）這樣的系統進行高級分析時，結構化日誌特別有用。

豐富的日誌事件細節

Serilog 使用上下文信息豐富日誌事件，提供了應用內部發生情況的全面視圖。 每個日誌事件可以包含許多超出簡單日誌消息的細節，包括時間戳、日誌級別、異常細節和自定義屬性。 這使得 Serilog 在日誌深度和清晰度方面優於其他日誌庫，為開發人員提供關鍵的應用行為和性能洞察。

通過配置文件

使用配置 JSON 文件定義日誌級別、輸出目的地（如日誌文件或控制台）和日誌輸出格式。 配置文件方法提供了更改日誌行為的靈活性，而不需修改代碼。 這是通過在 appsettings.json 文件中指定設置來完成的，允許您將日誌輸出定向到不同的 Sink，如控制台、文件，甚至是基於雲的日誌管理服務。

在代碼中以編程方式

或者，使用 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 是能將圖像轉換為 125 種語言文本的光學字符識別（OCR）庫。 在必須從圖像或掃描文件中提取文本數據的日誌記錄場景中，此功能可用，從而用更多上下文信息豐富日誌數據。

IronXL

IronXL 提供在不需要 Office Interop 的情況下處理 Excel 的功能。這對於日誌記錄特別有利，可將日誌數據導出到 Excel 以進一步分析和報告，提供熟悉的界面進行數據操作和可視化。

IronBarcode

IronBarcode 促進了 QR 碼和條形碼的讀寫。 此庫可以在日誌文件中嵌入或提取編碼信息，增強記錄信息的安全性和可追溯性。