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

這是該系列的第二篇文章： "在ASP.NET Core 3.0中使用Serilog.AspNetCore" 。 1. "第1部分使用Serilog RequestLogging來簡化ASP.NET Core的日誌輸出" 2. "第2部分用Serilog記錄所選終結點的附加屬性" （本文） 3. ...

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

第1部分-使用Serilog RequestLogging來簡化ASP.NET Core的日誌輸出
第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請求日誌記錄的許多基礎結構日誌的圖像

通過安裝了Serilog.AspNetCore的 NuGet包後並引入RequestLoggingMiddleware之後，可以將其精簡為一條日誌消息：

Serilog的請求日誌記錄生成的摘要日誌的圖像

本文中使用的所有日誌圖片均來自一款優秀的為結構化日誌提供可視化界面的工具-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結構化日誌中的所有其他屬性：

來自Seq的日誌消息顯示了其他屬性

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

總結

預設情況下，用Serilog的請求日誌記錄中間件替換ASP.NET Core基礎結構日誌記錄時，與開發環境的預設日誌記錄配置相比，您會丟失一些信息。在本文中，我展示瞭如何通過自定義Serilog RequestLoggingOptions來添加這些附加屬性。

這樣的做法非常簡單-您可以訪問HttpContext，因此你可以檢索它包含的任何可用的值，並將它們設置為IDiagnosticContext所提供的屬性。這些屬性將作為附加屬性添加到Serilog生成的結構化日誌中。在下一篇文章中，我將展示如何將MVC特定的屬性值添加到請求日誌中。敬請期待吧！