使用System.Diagnostic.DiagnosticListener 實作對應用程式的監聽-有解無憂

1. System.Diagnostics概述

System.Diagnostics 是一個偏底層的命名空間，有一系列API,由Runtime 層提供，應用層可以通過它與系統集成、事件日志、以及性能計數器進行互動，
在.NetCore 原始碼包中，提供了如下幾個dll.

大致描述如下：

由于本文只討論診斷日志，所以僅重點討論System.Diagnostics.DiagnosticSource

2. DiagnosticSource 概述

DiagnosticSource 是一個抽象類，表示診斷日志來源，使用時需要用DiagnosticListener實體化，
DiagnosticSource 和EventSource在設計上很相似，主要區別在于EventSource記錄的是可序列化的資料，會被外部行程消費，而DiagnosticSource 被設計為行程內處理資料，所以通過它拿到的資料會比較豐富，支持非序列化物件，如HttpContext、HttpResponseMessage等，

2.1 DiagnosticListener 與觀察者

先看一下DiagnosticSource和DiagnosticListener 類定義（.NetCore3.1）：

  // DiagnosticSource 診斷源類定義
 public abstract class DiagnosticSource
 {       
        protected DiagnosticSource();
        public abstract bool IsEnabled(string name);
        public virtual void OnActivityExport(Activity activity, object payload);
        public virtual void OnActivityImport(Activity activity, object payload);
        public Activity StartActivity(Activity activity, object args);
        public void StopActivity(Activity activity, object args);
        public abstract void Write(string name, object value);
  }

// DiagnosticListener 類定義

public class DiagnosticListener : DiagnosticSource, IDisposable, IObservable<KeyValuePair<string, object>>
{
        public DiagnosticListener(string name);
        public static IObservable<DiagnosticListener> AllListeners { get; }
        public string Name { get; }
        public virtual void Dispose();
        public bool IsEnabled();
        public override bool IsEnabled(string name);
        public override bool IsEnabled(string name, object arg1, object arg2 = null);
        public override void OnActivityExport(Activity activity, object payload);
        public override void OnActivityImport(Activity activity, object payload);
        public virtual IDisposable Subscribe(IObserver<KeyValuePair<string, object>> observer);
        public virtual IDisposable Subscribe(IObserver<KeyValuePair<string, object>> observer, Func<string, object, object, bool> isEnabled);
        public virtual IDisposable Subscribe(IObserver<KeyValuePair<string, object>> observer, Predicate<string> isEnabled);
        public virtual IDisposable Subscribe(IObserver<KeyValuePair<string, object>> observer, Func<string, object, object, bool> isEnabled, Action<Activity, object> onActivityImport = null, Action<Activity, object> onActivityExport = null);
        public override void Write(string name, object value);
}

以上定義可以發現DiagnosticListener 是DiagnosticSource的具體實作，并且它是一個可觀察主題，
有關IObserver-IObservable 可以從這篇博客了解： C#實作觀察者模式
自己創建可觀察主題時一般按如下操作：
1）創建發布者，2）創建觀察者并將其注冊到發布者上，

DiagnosticSource httpLogger = new DiagnosticListener("PubSubject");
            // 檢查監聽的組件是否有RequestStart 這個事件
            if (httpLogger.IsEnabled("PubSubject.Name"))
            {
                /*
                 * Write 方法接受兩個引數
                 * param1 表示事件名
                 * param2 是要寫入的資料，這個資料會被可觀察物件在發生這個事件時拋出拋出
                 */
                httpLogger.Write("PubSubject.Name", new { Url = "http://test.com", Request = new { Name = "ddd",Value="https://www.cnblogs.com/aimigi/p/ttttt" } });

            }

            // 為發布者注冊訂閱者（觀察者）
            DiagnosticListener.AllListeners.Subscribe(new MyObserver<DiagnosticListener>(listener=> { 
                if(listener.Name== "PubSubject")
                {
                    listener.Subscribe(new MyObserver<KeyValuePair<string, object>>(listenerData =https://www.cnblogs.com/aimigi/p/>
                    {
                        Console.WriteLine($"Listening Name:{listenerData.Key}");
                        dynamic data = https://www.cnblogs.com/aimigi/p/listenerData.Value;
                        Console.WriteLine($"Listening Data Name:{data.Name} Value:{data.Value}");
                    }));
                }
            
            }));

大多數情況下我們使用DiagnosticListener時，不需要發布事件，而僅僅作為觀察者跟蹤事件進行處理，畢竟常用基礎類別庫中已經埋下了足夠多的事件診斷點，

3. SqlClient庫中的埋點事件(System.Data.SqlClient v4.8.2)

SqlClient 是Ado.Net 中操作資料庫的基礎物件，使用DiagnosticListener 可以對這個物件的操作進行一些Hack操作，

// 定義一個觀察者
    public class MyObserver<T> :IObserver<T>
    {
        private Action<T> _next;
        public MyObserver(Action<T> next)
        {
            _next = next;
        }

        public void OnCompleted()
        {
        }

        public void one rror(Exception error)
        {
        }

        public void OnNext(T value)
        {
            _next(value);
        }
    }

// 一個引數是KeyValuePair<string, object> 的觀察者
 public class ExampleDiagnosticObserver : IObserver<DiagnosticListener>, IObserver<KeyValuePair<string, object>>
    {
        private readonly List<IDisposable> disposables = new List<IDisposable>();
        public void OnCompleted()
        {
        }

        public void one rror(Exception error)
        {
        }

        public void OnNext(KeyValuePair<string, object> value)
        {
            Write(value.Key, value.Value);
        }

        public void OnNext(DiagnosticListener value)
        {

            var subscription = value.Subscribe(this);
            disposables.Add(subscription);

        }
        private void Write(string name, object value)
        {
            Console.WriteLine(name);
            Console.WriteLine(value);
            Console.WriteLine();
        }
    }



    /// <summary>
    /// 使用Microsoft.Extensions.DiagnosticAdapter 
    /// </summary>
    public class SqlClientObserver : IObserver<DiagnosticListener>
    {
        private readonly List<IDisposable> _subscriptions = new List<IDisposable>();
        private readonly AsyncLocal<Stopwatch> _stopwatch = new AsyncLocal<Stopwatch>();

        public void OnCompleted()
        {
            
        }

        public void one rror(Exception error)
        {            
        }

        public void OnNext(DiagnosticListener value)
        {
           if(value.Name== "SqlClientDiagnosticListener")
            {
               var subscription= value.SubscribeWithAdapter(this);
                _subscriptions.Add(subscription);
            }
        }

        [DiagnosticName("System.Data.SqlClient.WriteCommandBefore")]
        public void OnCommandBefore()
        {
            _stopwatch.Value = https://www.cnblogs.com/aimigi/p/Stopwatch.StartNew();
        }

        [DiagnosticName("System.Data.SqlClient.WriteCommandAfter")]
        public void OnCommandAfter(DbCommand command)
        {
            var stopwatch = _stopwatch.Value;
            stopwatch.Stop();
            Console.WriteLine($"CommandText: {command.CommandText}");
            Console.WriteLine($"Elapsed: {stopwatch.Elapsed}");
            Console.WriteLine();
        }

    }

上面的代碼定義了3個觀察者，第二個中將一個主題下的事件和資料寫入了觀察者，第三個觀察者實作中，為了簡化寫法，使用了Microsoft.Extensions.DiagnosticAdapter 擴展，
DiagnosticName 特性定義的是偵聽的事件,DiagnosticSource Write 寫入時第一個引數就是事件名，第二個引數就是寫入的資料，
定義一個簡單的查詢操作

 public static int Get()
        {
            using var connection = new SqlConnection(connectionString);
            return connection.QuerySingle<int>("SELECT 33;");
        }

客戶端呼叫測驗：

 static void Main(string[] args)
        {
            var observer = new MyObserver<DiagnosticListener>(x =>
            {

                Console.WriteLine(x.Name);

            });
            // 可以看看底層組件發布了哪些listener
            DiagnosticListener.AllListeners.Subscribe(observer);
            // 查看listener 中發布了哪些事件
            //DiagnosticListener.AllListeners.Subscribe(new ExampleDiagnosticObserver());

            // 注冊sqlclient觀察者
            //DiagnosticListener.AllListeners.Subscribe(new SqlClientObserver());

            Console.WriteLine(Get());
            Console.ReadKey();
        }

使用第一個觀察者：

使用第二個觀察者，可以發現有6個埋點事件：

使用第三個觀察者記錄的日志如下：

4. 使用Microsoft.Extensions.DiagnosticAdapter 實作對HttpClient的監聽

要對HttpClient實作監聽，我們需要先搞清埋點事件，使用上面的兩個觀察者查看

 public static int GetHttpResponse()
        {
            using var httpClient = new HttpClient();
            var response = httpClient.GetAsync("https://www.baidu.com").Result;
            return response.Content.ReadAsStringAsync().Result.Length;

        }


static void Main(string[] args)
        {
            var observer = new MyObserver<DiagnosticListener>(x =>
            {

                Console.WriteLine(x.Name);

            });
            // 可以看看底層組件發布了哪些listener
            DiagnosticListener.AllListeners.Subscribe(observer);
            // 查看listener 中發布了哪些事件
            //DiagnosticListener.AllListeners.Subscribe(new ExampleDiagnosticObserver());

            // 注冊httpclient 觀察者
            //DiagnosticListener.AllListeners.Subscribe(new HttpClientObserver());

            Console.WriteLine(GetHttpResponse());

            Console.ReadKey();
        }

可以發現發布者主題是：HttpHandlerDiagnosticListener

主題事件：

使用Microsoft.Extensions.DiagnosticAdapter 撰寫的觀察者：

 public class HttpClientObserver : IObserver<DiagnosticListener>
    {
        private readonly List<IDisposable> _subscriptions = new List<IDisposable>();
        private readonly AsyncLocal<Stopwatch> _stopwatch = new AsyncLocal<Stopwatch>();

        public void OnCompleted()
        {
        }

        public void one rror(Exception error)
        {
        }

        public void OnNext(DiagnosticListener value)
        {
            if (value.Name == "HttpHandlerDiagnosticListener")
            {
                var subscription = value.SubscribeWithAdapter(this);
                _subscriptions.Add(subscription);
            }
        }

        [DiagnosticName("System.Net.Http.Request")]
        public void HttpRequest(HttpRequestMessage request)
        {
            Console.WriteLine($"request url: {request.RequestUri.AbsoluteUri}");
            Console.WriteLine($"request method: {request.Method}");
        }


        [DiagnosticName("System.Net.Http.Response")]
        public void HttpResponse(HttpResponseMessage response)
        {
            Console.WriteLine($"response status code: {response.StatusCode}");
            Console.WriteLine($"response version: {response.Version}");
        }

        [DiagnosticName("System.Net.Http.Exception")]
        public void HttpException(HttpRequestMessage request, Exception exception)
        {
            Console.WriteLine(exception.Message);
        }
    }

記錄的日志如下：

5. 總結

DiagnosticListener 是DiagnosticSource的具體實作，.NetCore 已經為基礎類別庫做好了事件埋點，
DiagnosticListener.AllListeners 是一個外觀包裝類，所有Listener的觀察者都可以在這里注冊，

轉載請註明出處，本文鏈接：https://www.uj5u.com/net/265000.html

標籤：.NET Core

上一篇：C# 處理PPT水印（三）—— 在PPT中添加多行（平鋪）文本水印效果

下一篇：Redis快速入門及應用