在 ASP.NET Core 日志模型 中對(duì)日志整體實(shí)現(xiàn)方式進(jìn)行了介紹，通過(guò)使用內(nèi)置日志記錄器來(lái)實(shí)現(xiàn)日志的輸出路徑。而在實(shí)際項(xiàng)目開(kāi)發(fā)中，使用第三方日志框架來(lái)記錄日志也是非常多的，首先一般基礎(chǔ)的內(nèi)置日志記錄器在第三方日志框架中都有實(shí)現(xiàn)，然后很多第三方日志框架在功能上更強(qiáng)大和豐富，能滿(mǎn)足我們更多的項(xiàng)目分析和診斷的需求。

本文主要介紹?Serilog^[1]?這個(gè)日志框架的使用，它是目前比較突出和受歡迎的一個(gè)日志框架。Serilog?在日志記錄上采用?json?的格式，方便日志的快速查詢(xún)與過(guò)濾。

默認(rèn)日志行為

在使用 Serilog 之前我們先看看 ASP.NET Core API 項(xiàng)目默認(rèn)的日志輸出行為。創(chuàng)建基于 ASP.NET Core 3.1 的 API 項(xiàng)目后啟動(dòng)，默認(rèn)訪問(wèn)會(huì) weatherforecast 接口，然后可以從控制臺(tái)和調(diào)試窗口看到如下輸出日志 (ASP.NET Core API 項(xiàng)目模板默認(rèn)集成了 Console 和 Debug 日志記錄器)：

日志輸出等級(jí)在配置文件中有默認(rèn)設(shè)置參數(shù)，appsettings.Development.json（開(kāi)發(fā)環(huán)境）和 appsettings.json（生產(chǎn)環(huán)境）的 Logging 節(jié)點(diǎn)。下面以 appsettings.Development.json 為例：

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

開(kāi)發(fā)環(huán)境下默認(rèn)輸出 Debug 及以上等級(jí)日志，System 和 Microsoft 開(kāi)頭的日志 Information 及以上等級(jí)會(huì)輸出，所以從上面的截圖看到大批 Info 日志。

Serilog 使用

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

安裝 Serilog.Settings.Configuration（讀取配置）、Serilog.Sinks.Console（日志輸出到控制臺(tái)） NuGet 包 ；

配置文件添加 Serilog 配置，WriteTo 指定輸出目標(biāo)位置，它是一個(gè)數(shù)組類(lèi)型，所以可以指定多個(gè)目標(biāo)位置，這里暫時(shí)只指定輸出到控制臺(tái)：

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

Program.cs 添加 UseSerilog，設(shè)置配置信息：

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

在 Startup.cs 的 Configure 請(qǐng)求管道中添加 UseSerilogRequestLogging：

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

日志輸出效果如下：

由于日志總是輸出一堆，并不能區(qū)分什么日志來(lái)自 Serilog ，其實(shí) Serilog 輸出的日志是非常簡(jiǎn)潔的，只有 HTTP GET ... ?這一條，其他都是 AspNetCore 本身輸出的。

日志輸出簡(jiǎn)化

為了使日志輸出更簡(jiǎn)潔，我們可以設(shè)置不輸出 AspNetCore Info 日志，只需在 Serilog 配置節(jié)點(diǎn)中設(shè)置 AspNetCore 日志輸出級(jí)別為 Warning：

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

日志屬性擴(kuò)展

這部分我們將增加使用 Serilog.Sinks.Seq 日志記錄器，不過(guò)在使用前需要先安裝 Seq^[2]，和 ElasticSearch 類(lèi)似，主要提供日志存儲(chǔ)和查詢(xún)，安裝非常簡(jiǎn)單，這里不再贅述，參考 Windows or Docker^[3]。

Seq 服務(wù)啟動(dòng)后修改配置文件，在 WriteTo 節(jié)點(diǎn)內(nèi)增加 Seq 的配置參數(shù)：

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

在 Seq 中查看日志如下，基于 ParentId、RequestId、TraceId 可實(shí)現(xiàn)鏈路跟蹤：

手動(dòng)記錄的日志如下：

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

前面在 Startup 的 Configure 方法中添加過(guò) UseSerilogRequestLogging ，該方法還支持更多的參數(shù)配置，通過(guò)指定 EnrichDiagnosticContext 委托方法的實(shí)現(xiàn)向 IDiagnosticContext 對(duì)象中添加擴(kuò)展屬性，這些擴(kuò)展屬性將會(huì)作用于請(qǐng)求日志體中。（Serilog.AspNetCore 已將接口 IDiagnosticContext 作為單例添加到了 DI 容器中，可以在任何類(lèi)中通過(guò)其 Set 方法添加擴(kuò)展屬性）

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 中查看日志如下，已包含添加的擴(kuò)展屬性：

參考資料

[1]

Serilog: https://github.com/serilog/serilog-aspnetcore

[2]

Seq: https://datalust.co/seq

[3]

Windows or Docker: https://docs.datalust.co/docs/getting-started

總結(jié)

以上是生活随笔為你收集整理的ASP.NET Core 日志框架：Serilog的全部?jī)?nèi)容，希望文章能夠幫你解決所遇到的問(wèn)題。

如果覺(jué)得生活随笔網(wǎng)站內(nèi)容還不錯(cuò)，歡迎將生活随笔推薦給好友。