Asp.Net Core 輕鬆學-利用日誌監視進行服務遙測

来源:https://www.cnblogs.com/viter/archive/2018/12/17/10128637.html
-Advertisement-
Play Games

在 Net Core 2.2 中,官方文檔表示,對 EventListener 這個日誌監視類的內容進行了擴充,同時賦予了跟蹤 CoreCLR 事件的許可權;通過跟蹤 CoreCLR 事件,比如通過跟蹤 CoreCLR 事件,可以瞭解和收集到比如 GC,JIT,ThreadPool,intreop 這... ...


前言

    在 Net Core 2.2 中,官方文檔表示,對 EventListener 這個日誌監視類的內容進行了擴充,同時賦予了跟蹤 CoreCLR 事件的許可權;通過跟蹤 CoreCLR 事件,比如通過跟蹤 CoreCLR 事件,可以瞭解和收集到比如 GC,JIT,ThreadPool,intreop 這些運行時服務的行為;通過使用配置註入,我們將獲得一種動態跟蹤事件的能力。

1. EventListener 介紹

1.1 EventListener 中文直譯為:事件偵聽器

EventListener 位於程式集 System.Diagnostics.Tracing 中,該類提供了一組啟用/禁用的方法,按照慣例,先來看一下源代碼,瞭解一下其結構

    public abstract class EventListener : IDisposable
    {
        protected EventListener();

        public event EventHandler<EventSourceCreatedEventArgs> EventSourceCreated;
       
        public event EventHandler<EventWrittenEventArgs> EventWritten;

        protected static int EventSourceIndex(EventSource eventSource);
       
        public void DisableEvents(EventSource eventSource);
       
        public virtual void Dispose();
       
        public void EnableEvents(EventSource eventSource, EventLevel level);
       
        public void EnableEvents(EventSource eventSource, EventLevel level, EventKeywords matchAnyKeyword);
       
        protected internal virtual void OnEventWritten(EventWrittenEventArgs eventData);
    }

從類結構中可以看出,EventListener 中的方法並不多,而且從名字都可以推斷出其行為,
因為該類是一個抽象類,並不能直接使用,接下來我們創建一個 ReportListener 類繼承它

2. 創建自定義事件偵聽器
 public class ReportListener : EventListener
    {
        public ReportListener() { }

        public Dictionary<string, ListenerItem> Items { get; set; } = new Dictionary<string, ListenerItem>();
        public ReportListener(Dictionary<string, ListenerItem> items)
        {
            this.Items = items;
        }

        protected override void OnEventSourceCreated(EventSource eventSource)
        {
            if (Items.ContainsKey(eventSource.Name))
            {
                var item = Items[eventSource.Name];
                EnableEvents(eventSource, item.Level, item.Keywords);
            }
        }

        protected override void OnEventWritten(EventWrittenEventArgs eventData)
        {
            if (Items.ContainsKey(eventData.EventSource.Name))
            {
                Console.WriteLine($"ThreadID = {eventData.OSThreadId} ID = {eventData.EventId} Name = {eventData.EventSource.Name}.{eventData.EventName}");
                for (int i = 0; i < eventData.Payload.Count; i++)
                {
                    string payloadString = eventData.Payload[i]?.ToString() ?? string.Empty;
                    Console.WriteLine($"\tName = \"{eventData.PayloadNames[i]}\" Value = \"{payloadString}\"");
                }
                Console.WriteLine("\n");
            }
        }
    }

ReportListener 自定義事件偵聽器的代碼非常簡單,只是簡單的繼承了 EventListener 後,重寫了父類的兩個方法:創建事件和寫入事件
同時,還定義了一個公共屬性 Dictionary<string, ListenerItem> Items ,該屬性接受一個 ListenerItem 的跟蹤配置集,通過配置文件註入,動態覺得哪些事件可以被寫入到偵聽器中

3. 配置跟蹤項目

在配置文件 appsettings.json 中增加以下內容

{
  "listener": [
    {
      "name": "HomeEventSource",
      "level": 5,
      "keywords": -1
    }
  ]
}

配置說明
上面的配置文件表示,定義一個事件源對象(EventSource),名稱為 HomeEventSource,事件級別(EventLevel)為 5,關鍵字(EventKeywords)為 -1
關於事件級別和事件關鍵字的值,和系統定義的一致

3.1 事件級別定義

namespace System.Diagnostics.Tracing
{
    public enum EventLevel
    {
        LogAlways = 0,
        Critical = 1,
        Error = 2,
        Warning = 3,
        Informational = 4,
        Verbose = 5
    }
}

3.2 事件關鍵字定義

namespace System.Diagnostics.Tracing
{
    [Flags]
    public enum EventKeywords : long
    {
        All = -1,
        None = 0,
        WdiContext = 562949953421312,
        MicrosoftTelemetry = 562949953421312,
        WdiDiagnostic = 1125899906842624,
        Sqm = 2251799813685248,
        AuditFailure = 4503599627370496,
        CorrelationHint = 4503599627370496,
        AuditSuccess = 9007199254740992,
        EventLogClassic = 36028797018963968
    }
}

3.3 配置文件完全按照系統值定義,為了更好的使用配置文件,我們定義了下麵的實體類

    public class ListenerItem
    {
        public string Name { get; set; }
        public EventLevel Level { get; set; } = EventLevel.Verbose;
        public EventKeywords Keywords { get; set; } = EventKeywords.All;
    }
4. 開始使用事件偵聽器

為了在應用程式中使用事件偵聽器,我們需要初始化事件偵聽器,你可以初始化多個事件偵聽器;但是,每個事件偵聽器僅需要初始化一次即可

4.1 初始化自定義事件偵聽器,在 Startup.cs 文件中加入以下代碼

        public void AddEventListener(IServiceCollection services)
        {
            var listeners = this.Configuration.GetSection("listener").Get<List<ListenerItem>>();
            Dictionary<string, ListenerItem> dict = new Dictionary<string, ListenerItem>();
            if (listeners != null)
            {
                foreach (var item in listeners)
                {
                    dict.Add(item.Name, item);
                }
            }
            var report = new ReportListener(dict);
            services.AddSingleton<ReportListener>(report);
        }

        public void ConfigureServices(IServiceCollection services)
        {
            AddEventListener(services);
            services.AddMvc().SetCompatibilityVersion(CompatibilityVersion.Version_2_2);
        }

初始化動作非常簡單,僅是從配置文件中讀取需要跟蹤的項,然後註冊到 ReportListener 內部即可,為了演示事件的註冊,我們需要創建一個事件源,就像配置文件中的名稱 HomeEventSource

4.2 創建自定義的事件源對象

    public class HomeEventSource : EventSource
    {
        public static HomeEventSource Instance = new HomeEventSource();

        [Event(1001)]
        public void RequestStart(string message) => WriteEvent(1001, message);

        [Event(1002)]
        public void RequestStop(string message) => WriteEvent(1002, message);
    }

自定義事件源 HomeEventSource 繼承自 EventSource,我們可無需為該自定義事件源進行顯式命名,因為預設將會使用 HomeEventSource 類名進行註冊事件
現在,我們嘗試著 HomeController 去生產一個事件,看看效果

5. 生產事件

5.1 轉到 HomeController,在 HomeController 的 Get 方法中使用 HomeEventSource 生產兩個事件

    [Route("api/[controller]")]
    [ApiController]
    public class HomeController : ControllerBase
    {
        [HttpGet]
        public ActionResult<IEnumerable<string>> Get()
        {
            HomeEventSource.Instance.RequestStart("處理業務開始");
            var arra = new string[] { "value1", "value2" };
            HomeEventSource.Instance.RequestStop("處理業務結束");
            return arra;
        }
    }

5.2 回顧一下自定義事件偵聽器 ReportListener 的重寫方法

        protected override void OnEventSourceCreated(EventSource eventSource)
        {
            if (Items.ContainsKey(eventSource.Name))
            {
                var item = Items[eventSource.Name];
                EnableEvents(eventSource, item.Level, item.Keywords);
            }
        }

        protected override void OnEventWritten(EventWrittenEventArgs eventData)
        {
            if (Items.ContainsKey(eventData.EventSource.Name))
            {
                Console.WriteLine($"ThreadID = {eventData.OSThreadId} ID = {eventData.EventId} Name = {eventData.EventSource.Name}.{eventData.EventName}");
                for (int i = 0; i < eventData.Payload.Count; i++)
                {
                    string payloadString = eventData.Payload[i]?.ToString() ?? string.Empty;
                    Console.WriteLine($"\tName = \"{eventData.PayloadNames[i]}\" Value = \"{payloadString}\"");
                }
                Console.WriteLine("\n");
            }
        }

由於我們做配置文件中指定了必須是 HomeEventSource 事件源才啟用事件,所以上面的代碼表示,當一個 HomeEventSource 事件進入的時候,將事件的內容列印到控制台,實際應用中,你可以將這些信息推送到日誌訂閱伺服器,以方便跟蹤和彙總

5.3 運行程式,看看輸出結果如何

可以看到,事件生產成功,實際上,CoreCLR 內部生產了非常多的事件,下麵我們嘗試啟用以下 3 個事件源,預期將會收到大量的事件信息

5.4 嘗試更多事件源

       protected override void OnEventSourceCreated(EventSource eventSource)
        {
            if (eventSource.Name.Equals("Microsoft-Windows-DotNETRuntime"))
            {
                EnableEvents(eventSource, EventLevel.Verbose, EventKeywords.AuditFailure);
            }

            else if (eventSource.Name.Equals("System.Data.DataCommonEventSource"))
            {
                EnableEvents(eventSource, EventLevel.Verbose, EventKeywords.AuditFailure);
            }

            else if (eventSource.Name.Equals("Microsoft-AspNetCore-Server-Kestrel"))
            {
                EnableEvents(eventSource, EventLevel.Verbose, EventKeywords.AuditFailure);
            }
        }

5.5 再次運行程式,看下圖輸出結果

從圖中可以看出,這次我們跟蹤到了 Microsoft-AspNetCore-Server-Kestrel 事件源生產的開始和結束連接事件

結束語

  • 在 CoreCLR 的事件匯流排中,包含了千千萬萬的事件源生產的事件,以上的實驗只是冰山一角,如果你把創建事件源的 EventKeywords 指定為 All,你將會看到天量的日誌信息,但是,在這裡,友情提示大家,千萬不要這樣做,這種做法會對服務性能帶來極大損害
  • 在業務代碼中,寫入大量的調試日誌是不可取的,但是使用事件偵聽器,可以控制事件的創建和寫入,當需要對某個介面進行監控的時候,通過將需要調試的事件源加入配置文件中進行監控,這將非常有用

示例代碼下載

https://files.cnblogs.com/files/viter/Ron.ListenerDemo.zip


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

-Advertisement-
Play Games
更多相關文章
  • 用途 AC自動機適用於一類用多個子串在模板串中匹配的字元串問題。 也就是說先給出一個模板串,然後給出一些子串。要求有多少個子串在這個模板串中出現過。 ...
  • 3 項目結構 經過前面一系列學習,差不多對Java的開發過程有了一定的瞭解,為了能保持一個良好的項目結構,考慮到接下來要進行開發,還需要學習一下Java的項目結構 下麵以兩個項目結構為參照 圖1 圖2 第一個是我自己學習時的Demo,一邊學一邊建文件,應該有些錯誤的地方,第二張是從網上看到的一個結構 ...
  • 總概: { C:面向過程,以過程為中心,以演算法為驅動 } { C++:面向對象,以過對象中心,以消息為驅動 個人理解:一切皆對象的思想 } 一 前言總概 1、常量變數 初始化對象與賦值是兩個概念 直接初始化:int a(12);高效 複製初始化:int a = 12; 內置類型差別不大,類類型大 2 ...
  • ·類(Class) 筆記: Python是一種面向對象(Object Oriented)的編程語言,類(Class)是Python的核心概念。在Python中,不管是列表、字元串、函數和類都是對象。 在面向對象編程(OOP)中,任何一個對象都要包含兩個部分:屬性(是什麼)和方法(能做什麼) 舉個例子 ...
  • 不考慮繼承結構類的類成員的初始化順序以及存在繼承的類成員初始化順序 ...
  • 首先,先安裝好,然後,創建項目,弄好之後,在終端輸入 egret run -a 開啟服務 /*********************************華麗麗的分割線**************************************/ 首先,那個RES.loadGroup是載入資源組 ...
  • 給定一個二叉樹,判斷其是否是一個有效的二叉搜索樹。 一個二叉搜索樹具有如下特征: 節點的左子樹只包含小於當前節點的數。 節點的右子樹只包含大於當前節點的數。 所有左子樹和右子樹自身必須也是二叉搜索樹。 我們只要判斷每個子樹中的左孩子小於根節點,右孩子大於根節點 還有一個要註意的是,空樹也是二叉搜索樹 ...
  • spring cloud我想做成一個系列,所以spring cloud+eureka後面會慢慢說到的,有興趣的小伙伴可以關註後續! 這一節就簡單說說springboot的熱部署了(我一直想不通為什麼叫做熱部署,看到這名字就嚇退了我繼續學習的欲望!),但是實際上可以把這個看成是一個小技巧。 就是導入一 ...
一周排行
    -Advertisement-
    Play Games
  • 移動開發(一):使用.NET MAUI開發第一個安卓APP 對於工作多年的C#程式員來說,近來想嘗試開發一款安卓APP,考慮了很久最終選擇使用.NET MAUI這個微軟官方的框架來嘗試體驗開發安卓APP,畢竟是使用Visual Studio開發工具,使用起來也比較的順手,結合微軟官方的教程進行了安卓 ...
  • 前言 QuestPDF 是一個開源 .NET 庫,用於生成 PDF 文檔。使用了C# Fluent API方式可簡化開發、減少錯誤並提高工作效率。利用它可以輕鬆生成 PDF 報告、發票、導出文件等。 項目介紹 QuestPDF 是一個革命性的開源 .NET 庫,它徹底改變了我們生成 PDF 文檔的方 ...
  • 項目地址 項目後端地址: https://github.com/ZyPLJ/ZYTteeHole 項目前端頁面地址: ZyPLJ/TreeHoleVue (github.com) https://github.com/ZyPLJ/TreeHoleVue 目前項目測試訪問地址: http://tree ...
  • 話不多說,直接開乾 一.下載 1.官方鏈接下載: https://www.microsoft.com/zh-cn/sql-server/sql-server-downloads 2.在下載目錄中找到下麵這個小的安裝包 SQL2022-SSEI-Dev.exe,運行開始下載SQL server; 二. ...
  • 前言 隨著物聯網(IoT)技術的迅猛發展,MQTT(消息隊列遙測傳輸)協議憑藉其輕量級和高效性,已成為眾多物聯網應用的首選通信標準。 MQTTnet 作為一個高性能的 .NET 開源庫,為 .NET 平臺上的 MQTT 客戶端與伺服器開發提供了強大的支持。 本文將全面介紹 MQTTnet 的核心功能 ...
  • Serilog支持多種接收器用於日誌存儲,增強器用於添加屬性,LogContext管理動態屬性,支持多種輸出格式包括純文本、JSON及ExpressionTemplate。還提供了自定義格式化選項,適用於不同需求。 ...
  • 目錄簡介獲取 HTML 文檔解析 HTML 文檔測試參考文章 簡介 動態內容網站使用 JavaScript 腳本動態檢索和渲染數據,爬取信息時需要模擬瀏覽器行為,否則獲取到的源碼基本是空的。 本文使用的爬取步驟如下: 使用 Selenium 獲取渲染後的 HTML 文檔 使用 HtmlAgility ...
  • 1.前言 什麼是熱更新 游戲或者軟體更新時,無需重新下載客戶端進行安裝,而是在應用程式啟動的情況下,在內部進行資源或者代碼更新 Unity目前常用熱更新解決方案 HybridCLR,Xlua,ILRuntime等 Unity目前常用資源管理解決方案 AssetBundles,Addressable, ...
  • 本文章主要是在C# ASP.NET Core Web API框架實現向手機發送驗證碼簡訊功能。這裡我選擇是一個互億無線簡訊驗證碼平臺,其實像阿裡雲,騰訊雲上面也可以。 首先我們先去 互億無線 https://www.ihuyi.com/api/sms.html 去註冊一個賬號 註冊完成賬號後,它會送 ...
  • 通過以下方式可以高效,並保證數據同步的可靠性 1.API設計 使用RESTful設計,確保API端點明確,並使用適當的HTTP方法(如POST用於創建,PUT用於更新)。 設計清晰的請求和響應模型,以確保客戶端能夠理解預期格式。 2.數據驗證 在伺服器端進行嚴格的數據驗證,確保接收到的數據符合預期格 ...