.NET Core 日志框架：Serilog

在 ASP.NET Core 日志模型 中對日志整體實現方式進行了介紹，通過使用內置日志記錄器來實現日志的輸出路徑。而在實際項目開發中，使用第三方日志框架來記錄日志也是非常多的，首先一般基礎的內置日志記錄器在第三方日志框架中都有實現，然后很多第三方日志框架在功能上更強大和豐富，能滿足我們更多的項目分析和診斷的需求。

本文主要介紹 Serilog 這個日志框架的使用，它是目前比較突出和受歡迎的一個日志框架。Serilog 在日志記錄上采用 json 的格式，方便日志的快速查詢與過濾。

默認日志行為

在使用 Serilog 之前我們先看看 ASP.NET Core API 項目默認的日志輸出行為。創建基於 ASP.NET Core 3.1 的 API 項目后啟動，默認訪問會 weatherforecast 接口，然后可以從控制台和調試窗口看到如下輸出日志 (ASP.NET Core API 項目模板默認集成了 Console 和 Debug 日志記錄器)：

 

 

 

日志輸出等級在配置文件中有默認設置參數，appsettings.Development.json（開發環境）和 appsettings.json（生產環境）的 Logging 節點。下面以 appsettings.Development.json 為例：

{ "Logging": { "LogLevel": { "Default": "Debug", "System": "Information", "Microsoft": "Information" } } } 

開發環境下默認輸出 Debug 及以上等級日志，System 和 Microsoft 開頭的日志 Information 及以上等級會輸出，所以從上面的截圖看到大批 Info 日志。

Serilog 使用

和內置日志記錄器一樣，Serilog 也有自己的日志記錄器組件，NuGet 包命名上基本都是 Serilog.Sinks.xxx 的形式，如：Serilog.Sinks.Console、Serilog.Sinks.File、Serilog.Sinks.Seq、Serilog.Sinks.ElasticSearch 等，接下來先以 Serilog.Sinks.Console 為例。

1. 安裝 Serilog.Settings.Configuration（讀取配置）、Serilog.Sinks.Console（日志輸出到控制台） NuGet 包 ；

2. 配置文件添加 Serilog 配置，WriteTo 指定輸出目標位置，它是一個數組類型，所以可以指定多個目標位置，這里暫時只指定輸出到控制台：

   { "Serilog": { "MinimumLevel": { "Default": "Debug" }, "WriteTo": [ { "Name": "Console" } ] } } 

3. Program.cs 添加 UseSerilog，設置配置信息：

   public static IHostBuilder CreateHostBuilder(string[] args) => Host.CreateDefaultBuilder(args) .ConfigureWebHostDefaults(webBuilder => { webBuilder.UseSerilog((context, logger) => { logger.ReadFrom.Configuration(context.Configuration); }); webBuilder.UseStartup<Startup>(); }); 

4. 在 Startup.cs 的 Configure 請求管道中添加 UseSerilogRequestLogging：

   public void Configure(IApplicationBuilder app, IWebHostEnvironment env) { if (env.IsDevelopment()) { app.UseDeveloperExceptionPage(); } app.UseSerilogRequestLogging(); app.UseRouting(); app.UseAuthorization(); app.UseEndpoints(endpoints => { endpoints.MapControllers(); }); } 

5. 日志輸出效果如下：

    

   

    

   由於日志總是輸出一堆，並不能區分什么日志來自 Serilog ，其實 Serilog 輸出的日志是非常簡潔的，只有 HTTP GET ... 這一條，其他都是 AspNetCore 本身輸出的。

日志輸出簡化

為了使日志輸出更簡潔，我們可以設置不輸出 AspNetCore Info 日志，只需在 Serilog 配置節點中設置 AspNetCore 日志輸出級別為 Warning：

{ "Serilog": { "MinimumLevel": { "Default": "Debug", "Override": { "Microsoft.AspNetCore": "Warning" } }, "WriteTo": [ { "Name": "Console" } ] } } 

 

 

日志屬性擴展

這部分我們將增加使用 Serilog.Sinks.Seq 日志記錄器，不過在使用前需要先安裝 Seq，和 ElasticSearch 類似，主要提供日志存儲和查詢，安裝非常簡單，這里不再贅述，參考 Windows or Docker。

Seq 服務啟動后修改配置文件，在 WriteTo 節點內增加 Seq 的配置參數：

"WriteTo": [
  { "Name": "Console" },
  {
    "Name": "Seq",
    "Args": {
      "serverUrl": "http://localhost:5341/"
    }
  }
]

在 Seq 中查看日志如下，基於 ParentId、RequestId、TraceId 可實現鏈路跟蹤：

 

 

手動記錄的日志如下：

 

 

雖然通過之前的配置使一次請求中系統日志只保留了一條，但相比之下可能丟失了一些重要信息，如：endpoint、contentType 等，所以我們需要在日志體上增加一些擴展屬性，做到數量少但內容豐富。

前面在 Startup 的 Configure 方法中添加過 UseSerilogRequestLogging ，該方法還支持更多的參數配置，通過指定 EnrichDiagnosticContext 委托方法的實現向 IDiagnosticContext 對象中添加擴展屬性，這些擴展屬性將會作用於請求日志體中。（Serilog.AspNetCore 已將接口 IDiagnosticContext 作為單例添加到了 DI 容器中，可以在任何類中通過其 Set 方法添加擴展屬性）

public static class LogUtil { public static void EnrichDiagnosticContext(IDiagnosticContext diagnosticContext, HttpContext httpContext) { var request = httpContext.Request; diagnosticContext.Set("Host", request.Host); diagnosticContext.Set("ContentType", httpContext.Response.ContentType); var endpoint = httpContext.GetEndpoint(); if (endpoint is object) { diagnosticContext.Set("EndpointName", endpoint.DisplayName); } } } 

app.UseSerilogRequestLogging(opts => { opts.EnrichDiagnosticContext = LogUtil.EnrichDiagnosticContext; }); 

在 Seq 中查看日志如下，已包含添加的擴展屬性：

 

 

參考鏈接：

• Serilog
• Seq

作者：BeckJin
鏈接：https://www.jianshu.com/p/5336ad10fa37
來源：簡書
著作權歸作者所有。商業轉載請聯系作者獲得授權，非商業轉載請注明出處。