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

来源:https://www.cnblogs.com/yilezhu/archive/2020/01/21/12227271.html

這是該系列的第二篇文章: "在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. 第1部分-使用Serilog RequestLogging來簡化ASP.NET Core的日誌輸出
  2. 第2部分-用Serilog記錄所選終結點的附加屬性(本文)
  3. 第3部分-使用Serilog.AspNetCore記錄MVC屬性[敬請期待]
  4. 第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/ HandlerNameActionId並且ActionName似乎不那麼重要,因為您應該能夠推斷出給定的請求路徑,但是顯式記錄它們將幫助您更加方便的捕獲錯誤,並使過濾針對特定操作的所有請求變得更加容易。

概括地說,您可以將這些屬性分為兩類:

  • 請求/響應特性:如HostSchemeContentTypeQueryStringEndpointName
  • MVC / RazorPages相關的屬性:如HandlerNameActionIdActionResult

在這篇文章中,我將展示如何添加這些類別中的第一種,即與請求/響應相關的屬性,在下一篇文章中,我將展示如何添加基於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()方法中通過調用UseSerilogRequestLoggingEnrichDiagnosticContext屬性,來註冊上面的幫助類:

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特定的屬性值添加到請求日誌中。敬請期待吧!


您的分享是我們最大的動力!

更多相關文章
  • 需要源碼、JDK1.6 、編碼風格參考阿裡java規約 7/12開始 有點意識到自己喜歡理論大而泛的模糊知識的學習,而不喜歡實踐和細節的打磨,是因為粗心浮躁導致的麽? cron表達式使用 設計能力、領域建模能力 其他: 海明威的硬幣:老人與海 工具準備: java編程思想電子版 別人整理的思維導圖 ...
  • 在IntelliJ Idea中HTML格式化時,預設head和body標簽以及body下的標簽都不會縮進,這就導致你每次寫好html時候格式化的時候所有標簽都是同一層級沒有縮進,一般我們寫html都會層級關係標簽嵌套,通過縮進看代碼結構就很清晰明朗 ...
  • 1.什麼是二維碼? ​ (百度百科):二維碼又稱二維條碼,常見的二維碼為QR Code,QR全稱Quick Response,是一個近幾年來移動設備上超流行的一種編碼方式,它比傳統的Bar Code條形碼能存更多的信息,也能表示更多的數據類型。 2.利用ZXING生成二維碼 ​ ·對應POM <de ...
  • 近期項目用到了緩存,我選用的是主流的google.guava作本地緩存,redis作分散式 緩存,先說說我對本地緩存和分散式緩存的理解吧,可能不太成熟的地方,大家指出,一起 學習.本地緩存的特點是速度快,不會受到網路阻塞的干擾,但由於是放在本地記憶體中,所 以容量較小,不能項目間共用比IO效率高比re ...
  • a.php <?phpheader("Content-type: text/html; charset=utf-8");date_default_timezone_set("Asia/Shanghai"); $start = microtime(true); function fsockopen_g ...
  • ©Copyright 蕃薯耀 2020-01-21 https://www.cnblogs.com/fanshuyao/ 一、第一步,引用依賴類,在Pom.xml加入依賴 <dependencies> <dependency> <groupId>org.springframework</groupI ...
  • 前言 只有光頭才能變強。 文本已收錄至我的GitHub精選文章,歡迎Star : "https://github.com/ZhongFuCheng3y/3y" 不知道大家的公司用Elasticsearch多不多,反正我公司的是有在用的。平時聽同事們聊天肯定避免不了不認識的技術棧,例如說:把數據放在引 ...
  • 微信公眾號: "Dotnet9" ,網站: "Dotnet9" ,問題或建議: "請網站留言" , 如果對您有所幫助: "歡迎贊賞" 。 .NET CORE(C ) WPF 重新設計Instagram 閱讀導航 1. 本文背景 2. 代碼實現 3. 本文參考 4. 源碼 1. 本文背景 老外的一個界 ...
一周排行
  • 一、引言 按照專用隊列解釋: MachineName\Private$\QueueName,只針對於本機的程式才可以調用的隊列,有些情況下為了安全起見定義為私有隊列。所以剛開始的時候認為,要想訪問遠程消息隊列,只能使用公共隊列。但是後來發現,公共隊列依賴Domain Controller(域控),在 ...
  • 本文只對api介面,header請求參數進行簡單驗證,起到拋磚引玉使用,需要深入驗證,請自行擴展 項目目錄結構如圖 中間件類 using ApiMiddleware.Common.DataEnityModel; using ApiMiddleware.Common.DbContext; using ...
  • 前言:由於公司占時沒有運維,出於微服務的需要,Apollo只能先裝在windows 阿裡雲上跑起來,由於環境及網路等問題,在安裝過程中遇到很多坑,算是一個個坑填完後,最終實現。 一. java jdk環境 java jdk 1.8下載地址: https://www.oracle.com/java/t ...
  • 前言 nuget 是 .net 的常用包管理器,目前已經內置到 Visual Studio 2012 以後的版本。大多數 .net 包都托管在 nuget.org,包括 .net core 框架基礎包,得益於 .net core 的模塊化設計,很多非核心包都可以進行一定程度的獨立升級。 製作並上傳 ...
  • 簡單的介紹一下集合,通俗來講就是用來保管多個數據的方案。比如說我們是一個公司的倉庫管理,公司有一堆貨物需要管理,有同類的,有不同類的,總而言之就是很多、很亂。我們對照集合的概念對倉庫進行管理的話,那麼 數組就是將一堆貨整整齊齊的碼在倉庫的某個地方,普通列表也是如此;Set就是在倉庫里有這麼一個貨架, ...
  • 中間件分類 ASP.NET Core 中間件的配置方法可以分為以上三種,對應的Helper方法分別是:Run(), Use(), Map()。 Run(),使用Run調用中間件的時候,會直接返回一個響應,所以後續的中間件將不會被執行了。 Use(),它會對請求做一些工作或處理,例如添加一些請求的上下 ...
  • 字元串的常用操作 很好理解 字元串可以用 ' + ' 連接,或者乘一個常數重覆輸出字元串 字元串的索引操作 通過一對中括弧可以找到字元串中的某個字元 可以通過正負數雙向操作噢 用一個中括弧來實現 為什麼沒有-0??去清醒腦子想想 -0 和 0 有差嗎? 還有一個切片操作 就像切菜那樣簡單,同樣是中括 ...
  • title: Java基礎語法(3) 運算符 blog: "CSDN" data: "Java學習路線及視頻" 1.算術運算符 算術運算符的註意問題 如果對負數取模,可以把模數負號忽略不記,如:5% 2=1。 但被模數是負數則不可忽略。此外,取模運算的結果不一定總是整數。 對於除號“/”,它的整數除 ...
  • 下麵是互相轉換的代碼: 有想要瞭解更多關於python知識的請在下方評論或私信小編 ...
  • 引言 構建分散式系統並不容易。然而,人們日常所使用的應用大多基於分散式系統,在短時間內依賴於分散式系統的現狀並不會改變。ApacheZooKeeper旨在減輕構建健壯的分散式系統的任務。ZooKeeper基於 分散式計算的核心概念而設計,主要目的是給開發人員提供一套容易理解和開發的介面,從而簡化分佈 ...
x