Serilog進階玩法之用Serilog記錄所選終結點附加屬性

這是在ASP.NET Core 3.X中使用Serilog.AspNetCore系列文章的第二篇文章：。

第1部分-使用Serilog RequestLogging減少日志詳細程度
第2部分-使用Serilog記錄所選的終結點屬性（本文）
第3部分-使用Serilog.AspNetCore記錄MVC屬性
第4部分-從Serilog請求日志記錄中排除健康檢查端點

作者：依樂祝

譯文位址：https://www.cnblogs.com/yilezhu/p/12227271.html

原文位址：https://andrewlock.net/using-serilog-aspnetcore-in-asp-net-core-3-logging-the-selected-endpoint-name-with-serilog/

在我的上一篇文章中，我描述了如何配置Serilog的RequestLogging中間件為每個請求建立“摘要”日志，以替換預設情況下從ASP.NET Core擷取的10個或更多日志。

在本文中，我将展示如何向Serilog的摘要請求日志中添加其他中繼資料，例如請求的主機名，響應的内容類型或從ASP.NET Core 3.0中使用的終結點路由中間件所選擇的端點名稱。

ASP.NET Core基礎結構日志很詳細，但是預設情況下具有太多詳細資訊

正如我在上一篇文章(https://andrewlock.net/using-serilog-aspnetcore-in-asp-net-core-3-reducing-log-verbosity/)中所展示的那樣，在開發環境中，ASP.NET Core基礎架構将為每一個RazorPage處理程式生成10條日志消息：

通過安裝了Serilog.AspNetCore的 NuGet包後并引入

RequestLoggingMiddleware

之後，可以将其精簡為一條日志消息：

本文中使用的所有日志圖檔均來自一款優秀的為結構化日志提供可視化界面的工具-Seq

顯然，原始的日志集更加冗長，并且其中大部分不是特别有用的資訊。但是，如果您将原始的10條日志作為一個整體來看，則與Serilog摘要日志相比，它們确實會在結構日志模闆中記錄一些其他屬性。

由ASP.NET Core基礎結構記錄的而Serilog 未記錄的擴充内容包括（下面這些還是英文的看着順眼）：

Host ( localhost:5001 )
Scheme ( https
Protocol ( HTTP/2
QueryString ( test=true
EndpointName ( /Index
HandlerName ( OnGet / SerilogRequestLogging.Pages.IndexModel.OnGet
ActionId ( 1fbc88fa-42db-424f-b32b-c2d0994463f1
ActionName ( /Index
RouteData ( {page = "/Index"}
ValidationState ( True False
ActionResult ( PageResult
ContentType ( text/html; charset=utf-8

我認為如果要把上述屬性中的其中一些包含在摘要日志消息中，将非常有用。例如，如果您的應用程式綁定到多個主機名，那麼

Host

絕對是重要的日志。

QueryString

可能是另一個有用的字段。

EndpointName

HandlerName

，

ActionId

并且

ActionName

似乎不那麼重要，因為您應該能夠推斷出給定的請求路徑，但是顯式記錄它們将幫助您更加友善的捕獲錯誤，并使過濾針對特定操作的所有請求變得更加容易。

概括地說，您可以将這些屬性分為兩類：

請求/響應特性：如 Host Scheme ContentType QueryString EndpointName
MVC / RazorPages相關的屬性：如 HandlerName ActionId ActionResult 等

在這篇文章中，我将展示如何添加這些類别中的第一種，即與請求/響應相關的屬性，在下一篇文章中，我将展示如何添加基于MVC / RazorPages的屬性。

向Serilog請求日志添加擴充資料

在上一篇文章中，我展示了如何将Serilog請求日志記錄添加到您的應用程式中，是以在此不再贅述。現在，我假設您已經進行了設定，并且您擁有一個包含以下内容的

Startup.Configure

方法：

public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
{
    // ... Error handling/HTTPS middleware
    app.UseStaticFiles();

    app.UseSerilogRequestLogging(); // <-- Add this line

    app.UseRouting();
    app.UseAuthorization();
    app.UseEndpoints(endpoints =>
    {
        endpoints.MapRazorPages();
    });
}

該

UseSerilogRequestLogging()

擴充方法将Serilog

RequestLoggingMiddleware

添加到請求管道中。您還可以通過調用重載來配置

RequestLoggingOptions

的執行個體。此類具有幾個屬性，可以讓您自定義請求記錄器如何生成日志語句：

public class RequestLoggingOptions
{
    public string MessageTemplate { get; set; }
    public Func<HttpContext, double, Exception, LogEventLevel> GetLevel { get; set; }
    public Action<IDiagnosticContext, HttpContext> EnrichDiagnosticContext { get; set; }
}

MessageTemplate

屬性控制将日志呈現為的字元串格式，

GetLevel

允許您控制給定日志索要記錄的級别，如

Debug

Info

Warning

等。這裡我們所關心的是

EnrichDiagnosticContext

屬性。

設定了該屬性的

Action<>

之後，在生成日志消息時它将被Serilog中間件調用并執行。它在日志寫入之前運作，這意味着它在中間件管道執行之後運作。例如，在下圖中（取自我的書《 ASP.NET Core in Action》），當響應“回傳”到中間件管道時，在第5步寫入日志：

在管道處理之後寫入日志這一事實意味着兩件事：

我們可以通路Response的屬性，例如狀态碼，經過的時間或内容類型
我們可以通路在管道後面設定的中間件的功能，例如，由 EndpointRoutingMiddleware （通過 UseRouting() 添加的）設定的功能： IEndpointFeature

在下一部分中，我将提供一個幫助程式功能，該功能會将所有“缺少”屬性添加到Serilog請求日志消息中。

在IDiagnosticContext中設定擴充值

Serilog.AspNetCore會将接口

IDiagnosticContext

作為單例添加到DI容器中，是以您可以從任何類中通路它。然後，您可以調用

Set()

方法，将其他屬性附加到請求日志消息中。

例如，如文檔所示，您可以從操作方法中添加任意值：

public class HomeController : Controller
{
    readonly IDiagnosticContext _diagnosticContext;
    public HomeController(IDiagnosticContext diagnosticContext)
    {
        _diagnosticContext = diagnosticContext;
    }

    public IActionResult Index()
    {
        // The request completion event will carry this property
        _diagnosticContext.Set("CatalogLoadTime", 1423);
        return View();
    }
}

然後，結果摘要日志将包含屬性

CatalogLoadTime

。

RequestLoggingOptions

通過設定所提供

IDiagnosticContext

執行個體的值，我們基本上使用完全相同的方法來定制中間件所使用的方法。下面的靜态幫助器類從目前

HttpContext

上下文檢索值，并在值可用時對其進行設定。

下面的靜态helper類從目前HttpContext檢索值，并在值可用時設定它們。

public static class LogHelper 
{
    public static void EnrichFromRequest(IDiagnosticContext diagnosticContext, HttpContext httpContext)
    {
        var request = httpContext.Request;

        // Set all the common properties available for every request
        diagnosticContext.Set("Host", request.Host);
        diagnosticContext.Set("Protocol", request.Protocol);
        diagnosticContext.Set("Scheme", request.Scheme);

        // Only set it if available. You're not sending sensitive data in a querystring right?!
        if(request.QueryString.HasValue)
        {
            diagnosticContext.Set("QueryString", request.QueryString.Value);
        }

        // Set the content-type of the Response at this point
        diagnosticContext.Set("ContentType", httpContext.Response.ContentType);

        // Retrieve the IEndpointFeature selected for the request
        var endpoint = httpContext.GetEndpoint();
        if (endpoint is object) // endpoint != null
        {
            diagnosticContext.Set("EndpointName", endpoint.DisplayName);
        }
    }
}

上面的幫助器函數從“Request”，“Response”以及其他中間件（端點名稱）設定的功能中檢索值。您可以擴充它，以根據需要在請求中添加其他值。

您可以在你的

Startup.Configure()

方法中通過調用

UseSerilogRequestLogging

的

EnrichDiagnosticContext

屬性，來注冊上面的幫助類：

public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
{
    // ... Other middleware

    app.UseSerilogRequestLogging(opts
        => opts.EnrichDiagnosticContext = LogHelper.EnrichFromRequest);

    // ... Other middleware
}

現在，當您送出請求時，您将看到添加到Serilog結構化日志中的所有其他屬性：

隻要您具有通過目前HttpContext可供中間件管道使用的值，就可以使用此方法。但是MVC的相關屬性是個例外，它們是MVC中間件“内部”的特性，例如action 名稱或RazorPage處理程式名稱。在下一篇文章中，我将展示如何将它們添加到Serilog請求日志中。

總結

預設情況下，用Serilog的請求日志記錄中間件替換ASP.NET Core基礎結構日志記錄時，與開發環境的預設日志記錄配置相比，您會丢失一些資訊。在本文中，我展示了如何通過自定義Serilog

RequestLoggingOptions

來添加這些附加屬性。

這樣的做法非常簡單-您可以通路

HttpContext

，是以你可以檢索它包含的任何可用的值，并将它們設定為

IDiagnosticContext

所提供的屬性。這些屬性将作為附加屬性添加到Serilog生成的結構化日志中。在下一篇文章中，我将展示如何将MVC特定的屬性值添加到請求日志中。敬請期待吧！

作者：依樂祝（祝雷）

出處：https://www.cnblogs.com/yilezhu

聯系：[email protected] .NET Core實戰項目交流群：637326624 微信：jkingzhu

本文版權歸作者和部落格園共有，歡迎轉載，但未經作者同意必須保留此段聲明，且在文章頁面明顯位置給出原文連接配接，否則保留追究法律責任的權利。如有問題或建議，請多多賜教，非常感謝。

Serilog進階玩法之用Serilog記錄所選終結點附加屬性

ASP.NET Core基礎結構日志很詳細，但是預設情況下具有太多詳細資訊

向Serilog請求日志添加擴充資料

在IDiagnosticContext中設定擴充值

總結

繼續閱讀

mysql和c#在類型轉換的問題An unhandled exception occurred while processing the request.

Method MethodName is not supported on this proxy

asp.net core Swagger JWT

Castle動态代理攔截器可跟蹤模型更改和觸發規則介紹總結

IdentityServer4（四）

asp.net core源代碼下載下傳與運作

ASP.NET CORE API 部署到IIS 上HTTP錯誤 500.19-Internal Server Error 錯誤代碼：0x8007000d

Cake Frosting：更具可維護性的C＃DevOps什麼是Frosting？入門适應Frosting别名目錄/檔案插件和工具概括

ASP.NET Core MVC 源碼學習：Routing 路由

.Net Core平台下實作SignalR用戶端和服務端

ASP.NET Core 中建立 gRPC 用戶端和伺服器

ASP.NET Core SignalR.NET 用戶端

AutoWrapper：通過有意義的響應來美化您的ASP.NET Core API介紹預設的ASP.NET Core API響應AutoWrapper.Core的救援TL，DR 給我看代碼定義自己的自定義消息定義自己的Api異常選項支援日志支援Swagger總結參考文獻

使用Entity Framework和Web API的ASP.NET Core Blazor CRUD介紹背景使用代碼

ASP.NET Core MVC(一)

建立ASP.NET CORE MVC項目