经验首页 前端设计 程序设计 Java相关 移动开发 数据库/运维 软件/图像 大数据/云计算 其他经验
当前位置:技术经验 » 程序设计 » ASP.net » 查看文章
使用System.Diagnostic.DiagnosticListener 实现对应用程序的监听
来源:cnblogs  作者:aimigi  时间:2021/3/1 15:29:40  对本文有异议

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="ttttt" } });

            }

            // 为发布者注册订阅者(观察者)
            DiagnosticListener.AllListeners.Subscribe(new MyObserver<DiagnosticListener>(listener=> { 
                if(listener.Name== "PubSubject")
                {
                    listener.Subscribe(new MyObserver<KeyValuePair<string, object>>(listenerData =>
                    {
                        Console.WriteLine($"Listening Name:{listenerData.Key}");
                        dynamic data = 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 OnError(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 OnError(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 OnError(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 = 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 OnError(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的观察者都可以在这里注册。

原文链接:http://www.cnblogs.com/aimigi/p/14416852.html

 友情链接:直通硅谷  直通硅谷 怎么样 mac软件下载