在 .NET Core 中使用 Diagnostics (Diagnostic Source) 记录跟

最新一直在忙着项目上的事情,很久没有写博客了,在这里对关注我的粉丝们说声抱歉,后面我可能更多的分享我们在微服务落地的过程中的一些经验。那么今天给大家讲一下在 .NET Core 2 中引入的全新 DiagnosticSource 事件机制,为什么说是全新呢? 在以前的 .NET Framework 有心的同学应该知道也有 Diagnostics,那么新的 .NET Core 中有什么变化呢? 让我们一起来看看吧。

Diagnostics

Diagnostics 一直是一个被大多数开发者忽视的东西,我猜测很多同学看到这里的时候可能还是第一次听说 Diagnostics 这个东西,为什么会被忽视呢? 我们等会说,我们先来看一下 Diagnostics 是用来做什么的。

Diagnostics 是什么呢?

让我们把时间往前拉回到 2013 年 8 月,微软在 NuGet 发布了一个新的关于 Diagnostics 的包叫做 Microsoft.Diagnostics.Tracing.TraceEvent,这个包用来为 Windows 事件追踪(ETW)提供一个强大的支持,使用这个包可以很容易的为我们在云环境和生产环境来提供端到端的监控日志事件记录,它轻量级,高效,并且可以和系统日志进行交互。

PS:通过这个包我们可以获取到 CLR 运行的一些细节信息,由于本篇主题,对此不介绍过多了。

看到这个包提供的功能,那么博主就自己总结一下,对 Diagnostics 下个定义 :在应用程序出现问题的时候,特别是出现可用性或者性能问题的时候,开发人员或者IT人员经常会对这些问题花费大量的时间来进行诊断,很多时候生产环境的问题都无法复现,这可能会对业务造成很大的影响,Diagnostics 就是提供一组功能使我们能够很方便的可以记录在应用程序运行期间发生的关键性操作以及他们的执行时间等,使管理员可以查找特别是生产环境中出现问题所在的根本原因。

有同学可能会说了,这不就是 APM(Application Performance Management) 么,嗯,从宏观的角度来说这属于APM的一部分,但 APM 不仅仅只有这些。

.NET Framework 之 EventSource

在上面我们了解到了 Microsoft.Diagnostics.Tracing.TraceEvent,那么相关搭配使用的还有两个 NuGet 包就是 Microsoft.Diagnostics.Tracing.EventSource 这个包,那我就简单讲一下,我不准备在这个部分讲述太多,毕竟已经被替换掉了,我们来看下 EventSource。

EventSource

在 .NET Framework 中 EventSource 通过 Windows ETW 提供的 ETW Channels 与其进行集成,下面给出一个示例代码:

[EventSource(Name = "Samples-EventSourceDemos-Minimal")] public sealed class MinimalEventSource : EventSource { // Define singleton instance public static MinimalEventSource Log = new MinimalEventSource(); // Define Event methods public void Load(long baseAddress, string imageName) { WriteEvent(1, baseAddress, imageName); } }

那么在 ETW 中我们就可以看到相关的事件信息了:

在 .NET Core 中使用 Diagnostics (Diagnostic Source) 记录跟

注意,在 .NET Framework 4.5 以及更高版本,EventSource 已经被集成到了 System 命名空间。

学习,也是一个总结的过程,对此,我们也许可以总结出来一个比较重要的信息就是:通过 Diagnostics 的命名空间变化,由 Microsoft 变为了 System, 我们可以看到 Diagnostics 对于我们的应用程序来说变得更加重要了。

由于 EventSource 只支持 Windows,所以在全新的 .NET Core 中,它已经被悄悄的取代了,下面我们来看一下全新的 DiagnosticSource。

.NET Core 之 全新 DiagnosticSource

在 .NET Core 中 .NET 团队设计了一个全新的 DiagnosticSource,新的 DiagnosticSource 非常的简单,它允许你在生产环境记录丰富的 payload 数据,然后你可以在另外一个消费者可以消费感兴趣的记录,是不是听着有点懵逼?没关系,等会我再详细说。

我们先来说说 DiagnosticSource 和上面的 EventSource 的区别,他们的架构设计有点类似,主要区别是 EventSource 它记录的数据是可序列化的数据,会被在进程外消费,所以要求记录的对象必须是可以被序列化的。而 DiagnosticSource 被设计为在进程内处理数据,所以通过它可以拿到更加丰富的一些数据信息,它支持非序列化的对象,比如 HttpContext , HttpResponseMessage 等。如果你想在 EventSource 中获取 DiagnosticSource 中的事件数据,你可以通过 DiagnosticSourceEventSource 这个对象来进行数据桥接。

下面我们来看一下在代码中如何使用 DiagnosticSource对象。

在这之前我们需要了解另外一个对象 DiagnosticListener,DiagnosticListener 从命名上来看它是一个监听诊断信息的对象,它确实是一个用来接收事件的类,在 .NET Core 中 DiagnosticSource 它其实是一个抽象类,定义了记录事件日志所需要的方法,那么我们在使用的时候就需要使用具体的对象,DiagnosticListener 就是 DiagnosticSource 的默认实现,明白了吧。

好了,现在我们来看一下如何使用吧。

生成 Diagnostic 日志记录

如何生成 Diagnostic 日志记录呢?首先,我们需要创建一个 DiagnosticListener 对象,比如:

private static DiagnosticSource httpLogger = new DiagnosticListener("System.Net.Http");

DiagnosticListener 参数中的名称即为需要监听的事件(组件)名称,这个名称在以后会被用来被它的消费者所订阅使用。

DiagnosticSource 其核心只包含了两个方法,分别是 :

bool IsEnabled(string name) void Write(string name, object value);

那么然后我们可以这样来调用:

if (httpLogger.IsEnabled("RequestStart")){ httpLogger.Write("RequestStart", new { Url="http://clr", Request=aRequest }); }

内容版权声明:除非注明,否则皆为本站原创文章。

转载注明出处:https://www.heiqu.com/zyfdzs.html