Asp.Net Core輕松學之利用日志監(jiān)視進行服務(wù)遙測詳解
前言
在 Net Core 2.2 中,官方文檔表示,對 EventListener 這個日志監(jiān)視類的內(nèi)容進行了擴充,同時賦予了跟蹤 CoreCLR 事件的權(quán)限;通過跟蹤 CoreCLR 事件,比如通過跟蹤 CoreCLR 事件,可以了解和收集到比如 GC,JIT,ThreadPool,intreop 這些運行時服務(wù)的行為;通過使用配置注入,我們將獲得一種動態(tài)跟蹤事件的能力。
1. EventListener 介紹
1.1 EventListener 中文直譯為:事件偵聽器
EventListener 位于程序集 System.Diagnostics.Tracing
中,該類提供了一組啟用/禁用的方法,按照慣例,先來看一下源代碼,了解一下其結(jié)構(gòu)
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); }
從類結(jié)構(gòu)中可以看出,EventListener 中的方法并不多,而且從名字都可以推斷出其行為,
因為該類是一個抽象類,并不能直接使用,接下來我們創(chuàng)建一個 ReportListener 類繼承它
2. 創(chuàng)建自定義事件偵聽器
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 后,重寫了父類的兩個方法:創(chuàng)建事件和寫入事件
同時,還定義了一個公共屬性 Dictionary<string, ListenerItem> Items
,該屬性接受一個 ListenerItem 的跟蹤配置集,通過配置文件注入,動態(tài)覺得哪些事件可以被寫入到偵聽器中
3. 配置跟蹤項目
在配置文件 appsettings.json 中增加以下內(nèi)容
{ "listener": [ { "name": "HomeEventSource", "level": 5, "keywords": -1 } ] }
配置說明
上面的配置文件表示,定義一個事件源對象(EventSource),名稱為 HomeEventSource,事件級別(EventLevel)為 5,關(guān)鍵字(EventKeywords)為 -1
關(guān)于事件級別和事件關(guān)鍵字的值,和系統(tǒng)定義的一致
3.1 事件級別定義
namespace System.Diagnostics.Tracing { public enum EventLevel { LogAlways = 0, Critical = 1, Error = 2, Warning = 3, Informational = 4, Verbose = 5 } }
3.2 事件關(guān)鍵字定義
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 配置文件完全按照系統(tǒng)值定義,為了更好的使用配置文件,我們定義了下面的實體類
public class ListenerItem { public string Name { get; set; } public EventLevel Level { get; set; } = EventLevel.Verbose; public EventKeywords Keywords { get; set; } = EventKeywords.All; }
4. 開始使用事件偵聽器
為了在應(yīng)用程序中使用事件偵聽器,我們需要初始化事件偵聽器,你可以初始化多個事件偵聽器;但是,每個事件偵聽器僅需要初始化一次即可
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 內(nèi)部即可,為了演示事件的注冊,我們需要創(chuàng)建一個事件源,就像配置文件中的名稱 HomeEventSource
4.2 創(chuàng)建自定義的事件源對象
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 類名進行注冊事件
現(xiàn)在,我們嘗試著 HomeController 去生產(chǎn)一個事件,看看效果
5. 生產(chǎn)事件
5.1 轉(zhuǎn)到 HomeController,在 HomeController 的 Get 方法中使用 HomeEventSource 生產(chǎn)兩個事件
[Route("api/[controller]")] [ApiController] public class HomeController : ControllerBase { [HttpGet] public ActionResult<IEnumerable<string>> Get() { HomeEventSource.Instance.RequestStart("處理業(yè)務(wù)開始"); var arra = new string[] { "value1", "value2" }; HomeEventSource.Instance.RequestStop("處理業(yè)務(wù)結(jié)束"); 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 事件進入的時候,將事件的內(nèi)容打印到控制臺,實際應(yīng)用中,你可以將這些信息推送到日志訂閱服務(wù)器,以方便跟蹤和匯總
5.3 運行程序,看看輸出結(jié)果如何
可以看到,事件生產(chǎn)成功,實際上,CoreCLR 內(nèi)部生產(chǎn)了非常多的事件,下面我們嘗試啟用以下 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 再次運行程序,看下圖輸出結(jié)果
從圖中可以看出,這次我們跟蹤到了 Microsoft-AspNetCore-Server-Kestrel 事件源生產(chǎn)的開始和結(jié)束連接事件
結(jié)束語
- 在 CoreCLR 的事件總線中,包含了千千萬萬的事件源生產(chǎn)的事件,以上的實驗只是冰山一角,如果你把創(chuàng)建事件源的 EventKeywords 指定為 All,你將會看到天量的日志信息,但是,在這里,友情提示大家,千萬不要這樣做,這種做法會對服務(wù)性能帶來極大損害
- 在業(yè)務(wù)代碼中,寫入大量的調(diào)試日志是不可取的,但是使用事件偵聽器,可以控制事件的創(chuàng)建和寫入,當需要對某個接口進行監(jiān)控的時候,通過將需要調(diào)試的事件源加入配置文件中進行監(jiān)控,這將非常有用
示例代碼下載:http://xiazai.jb51.net/201812/yuanma/Ron.ListenerDemo_jb51.rar
總結(jié)
以上就是這篇文章的全部內(nèi)容了,希望本文的內(nèi)容對大家的學習或者工作具有一定的參考學習價值,如果有疑問大家可以留言交流,謝謝大家對腳本之家的支持。
- ASP.NET?Core記錄日志
- ASP.Net?Core中的日志與分布式鏈路追蹤
- ASP.NET Core使用NLog記錄日志
- ASP.NET Core使用Log4net實現(xiàn)日志記錄功能
- ASP.NET Core使用NLog輸出日志記錄
- ASP.NET Core擴展庫之Http日志的使用詳解
- ASP.NET Core擴展庫之日志功能的使用詳解
- Asp.Net Core用NLog記錄日志操作方法
- ASP.NET Core開發(fā)教程之Logging利用NLog寫日志文件
- ASP.NET Core 2.0 WebApi全局配置及日志實例
- 詳解ASP.NET Core應(yīng)用中如何記錄和查看日志
- ASP.NET?Core使用自定義日志中間件
相關(guān)文章
詳解ASP.NET 生成二維碼實例(采用ThoughtWorks.QRCode和QrCode.Net兩種方式)
本篇文章主要介紹了ASP.NET 生成二維碼實例,使用了兩種方法,包括ThoughtWorks.QRCode和QrCode.Net,具有一定的參考價值,有興趣的可以了解一下。2016-12-12淺談ASP.NET Core 中jwt授權(quán)認證的流程原理
這篇文章主要介紹了淺談ASP.NET Core 中jwt授權(quán)認證的流程原理,文中通過示例代碼介紹的非常詳細,對大家的學習或者工作具有一定的參考學習價值,需要的朋友們下面隨著小編來一起學習學習吧2020-03-03.NET下實現(xiàn)數(shù)字和字符相混合的驗證碼實例
這篇文章介紹了.NET下實現(xiàn)數(shù)字和字符相混合的驗證碼實例,有需要的朋友可以參考一下2013-11-11.NET實現(xiàn)ChatGPT的Stream傳輸?shù)倪^程
這篇文章主要介紹了.NET如何實現(xiàn)ChatGPT的Stream傳輸,本文通過實例代碼給大家介紹的非常詳細,對大家的學習或工作具有一定的參考借鑒價值,需要的朋友可以參考下2023-07-07asp.net調(diào)用飛信免費發(fā)短信(測試有效)
這篇文章主要介紹了asp.net如何調(diào)用飛信免費發(fā)短信,記得要開通飛信把對方加為好友才能發(fā),需要的朋友可以參考下2014-05-05.NET從優(yōu)酷專輯中采集所有視頻及信息(VB.NET代碼)
因為想做一個視頻點播類的網(wǎng)站,所以開始研究視頻采集。2010-02-02asp.net core 3.0中使用swagger的方法與問題
這篇文章主要給大家介紹了關(guān)于asp.net core 3.0中使用swagger的方法與遇到的一些問題,文中通過示例代碼介紹的非常詳細,對大家的學習或者使用asp.net core 3.0具有一定的參考學習價值,需要的朋友們下面來一起學習學習吧2019-10-10