在.NET Core中如何使用Diagnostics記錄跟蹤信息

小編給大家分享一下在.NET Core中如何使用Diagnostics記錄跟蹤信息，希望大家閱讀完這篇文章之后都有所收獲，下面讓我們一起去探討吧！

Diagnostics

Diagnostics 一直是一個(gè)被大多數(shù)開(kāi)發(fā)者忽視的東西，我猜測(cè)很多同學(xué)看到這里的時(shí)候可能還是第一次聽(tīng)說(shuō) Diagnostics 這個(gè)東西，為什么會(huì)被忽視呢？ 我們等會(huì)說(shuō)，我們先來(lái)看一下 Diagnostics 是用來(lái)做什么的。

Diagnostics 是什么呢？

讓我們把時(shí)間往前拉回到 2013 年 8 月，微軟在 NuGet 發(fā)布了一個(gè)新的關(guān)于 Diagnostics 的包叫做 Microsoft.Diagnostics.Tracing.TraceEvent，這個(gè)包用來(lái)為 Windows 事件追蹤（ETW）提供一個(gè)強(qiáng)大的支持，使用這個(gè)包可以很容易的為我們?cè)谠骗h(huán)境和生產(chǎn)環(huán)境來(lái)提供端到端的監(jiān)控日志事件記錄，它輕量級(jí)，高效，并且可以和系統(tǒng)日志進(jìn)行交互。

PS：通過(guò)這個(gè)包我們可以獲取到 CLR 運(yùn)行的一些細(xì)節(jié)信息，由于本篇主題，對(duì)此不介紹過(guò)多了。

看到這個(gè)包提供的功能，那么博主就自己總結(jié)一下，對(duì) Diagnostics 下個(gè)定義 ：在應(yīng)用程序出現(xiàn)問(wèn)題的時(shí)候，特別是出現(xiàn)可用性或者性能問(wèn)題的時(shí)候，開(kāi)發(fā)人員或者IT人員經(jīng)常會(huì)對(duì)這些問(wèn)題花費(fèi)大量的時(shí)間來(lái)進(jìn)行診斷，很多時(shí)候生產(chǎn)環(huán)境的問(wèn)題都無(wú)法復(fù)現(xiàn)，這可能會(huì)對(duì)業(yè)務(wù)造成很大的影響，Diagnostics 就是提供一組功能使我們能夠很方便的可以記錄在應(yīng)用程序運(yùn)行期間發(fā)生的關(guān)鍵性操作以及他們的執(zhí)行時(shí)間等，使管理員可以查找特別是生產(chǎn)環(huán)境中出現(xiàn)問(wèn)題所在的根本原因。

有同學(xué)可能會(huì)說(shuō)了，這不就是 APM(Application Performance Management) 么，嗯，從宏觀的角度來(lái)說(shuō)這屬于APM的一部分，但 APM 不僅僅只有這些。

.NET Framework 之 EventSource

在上面我們了解到了 Microsoft.Diagnostics.Tracing.TraceEvent，那么相關(guān)搭配使用的還有兩個(gè) NuGet 包就是 Microsoft.Diagnostics.Tracing.EventSource 這個(gè)包，那我就簡(jiǎn)單講一下，我不準(zhǔn)備在這個(gè)部分講述太多，畢竟已經(jīng)被替換掉了，我們來(lái)看下 EventSource。

EventSource

在 .NET Framework 中 EventSource 通過(guò) Windows ETW 提供的 ETW Channels 與其進(jìn)行集成，下面給出一個(gè)示例代碼：

[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 中我們就可以看到相關(guān)的事件信息了：

注意，在 .NET Framework 4.5 以及更高版本，EventSource 已經(jīng)被集成到了 System 命名空間。

學(xué)習(xí)，也是一個(gè)總結(jié)的過(guò)程，對(duì)此，我們也許可以總結(jié)出來(lái)一個(gè)比較重要的信息就是：通過(guò) Diagnostics 的命名空間變化，由 Microsoft 變?yōu)榱?System， 我們可以看到 Diagnostics 對(duì)于我們的應(yīng)用程序來(lái)說(shuō)變得更加重要了。

由于 EventSource 只支持 Windows，所以在全新的 .NET Core 中，它已經(jīng)被悄悄的取代了，下面我們來(lái)看一下全新的 DiagnosticSource。

.NET Core 之 全新 DiagnosticSource

在 .NET Core 中 .NET 團(tuán)隊(duì)設(shè)計(jì)了一個(gè)全新的 DiagnosticSource，新的 DiagnosticSource 非常的簡(jiǎn)單，它允許你在生產(chǎn)環(huán)境記錄豐富的 payload 數(shù)據(jù)，然后你可以在另外一個(gè)消費(fèi)者可以消費(fèi)感興趣的記錄，是不是聽(tīng)著有點(diǎn)懵逼？沒(méi)關(guān)系，等會(huì)我再詳細(xì)說(shuō)。

我們先來(lái)說(shuō)說(shuō) DiagnosticSource 和上面的 EventSource 的區(qū)別，他們的架構(gòu)設(shè)計(jì)有點(diǎn)類似，主要區(qū)別是 EventSource 它記錄的數(shù)據(jù)是可序列化的數(shù)據(jù)，會(huì)被在進(jìn)程外消費(fèi)，所以要求記錄的對(duì)象必須是可以被序列化的。而 DiagnosticSource 被設(shè)計(jì)為在進(jìn)程內(nèi)處理數(shù)據(jù)，所以通過(guò)它可以拿到更加豐富的一些數(shù)據(jù)信息，它支持非序列化的對(duì)象，比如 HttpContext , HttpResponseMessage 等。如果你想在 EventSource 中獲取 DiagnosticSource 中的事件數(shù)據(jù)，你可以通過(guò) DiagnosticSourceEventSource 這個(gè)對(duì)象來(lái)進(jìn)行數(shù)據(jù)橋接。

下面我們來(lái)看一下在代碼中如何使用 DiagnosticSource對(duì)象。

在這之前我們需要了解另外一個(gè)對(duì)象 DiagnosticListener，DiagnosticListener 從命名上來(lái)看它是一個(gè)監(jiān)聽(tīng)診斷信息的對(duì)象，它確實(shí)是一個(gè)用來(lái)接收事件的類，在 .NET Core 中 DiagnosticSource 它其實(shí)是一個(gè)抽象類，定義了記錄事件日志所需要的方法，那么我們?cè)谑褂玫臅r(shí)候就需要使用具體的對(duì)象，DiagnosticListener 就是 DiagnosticSource 的默認(rèn)實(shí)現(xiàn)，明白了吧。

好了，現(xiàn)在我們來(lái)看一下如何使用吧。

生成 Diagnostic 日志記錄

如何生成 Diagnostic 日志記錄呢？首先，我們需要?jiǎng)?chuàng)建一個(gè) DiagnosticListener 對(duì)象，比如：

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

DiagnosticListener 參數(shù)中的名稱即為需要監(jiān)聽(tīng)的事件（組件）名稱，這個(gè)名稱在以后會(huì)被用來(lái)被它的消費(fèi)者所訂閱使用。

DiagnosticSource 其核心只包含了兩個(gè)方法，分別是 ：

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

那么然后我們可以這樣來(lái)調(diào)用：

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

IsEnabled(string param1) 這個(gè)方法用來(lái)判斷是否有消費(fèi)者注冊(cè)了當(dāng)前的事件（組件）名稱監(jiān)聽(tīng)，通常有消費(fèi)者關(guān)心了相關(guān)數(shù)據(jù)，我們才會(huì)進(jìn)行事件記錄。
Write(string param1,object param2) 這個(gè)方法用來(lái)向 DiagnosticSource 中寫入日志記錄，param1 和上面一樣用來(lái)指定名稱的，也就是所向指定名稱中寫入數(shù)據(jù)，param2 即為寫入的 payloads 數(shù)據(jù)，你可以使用 匿名類型來(lái)向 param2 中寫入數(shù)據(jù)，這樣會(huì)方便很多。

這樣，我們就已經(jīng)把 Diagnostic 事件日志寫入到 DiagnosticSource中了，是不是很簡(jiǎn)單？ 我們?cè)倏匆幌氯绾芜M(jìn)行消費(fèi)（監(jiān)聽(tīng)）這些事件信息。

監(jiān)聽(tīng) Diagnostic 日志記錄

在監(jiān)聽(tīng) Diagnostic 日志記錄之前你需要知道你要關(guān)心的事件數(shù)據(jù)名稱，那么如果僅僅是在代碼中把 DiagnosticListeners 都寫死到監(jiān)聽(tīng)的消費(fèi)者代碼中的話，這樣就太不靈活了，所以這里設(shè)計(jì)了一個(gè)機(jī)制用來(lái)發(fā)現(xiàn)中那些在運(yùn)行時(shí)被激活的DiagnosticListeners。

你可以使用 DiagnosticListener.AllListeners 來(lái)獲取一個(gè) IObservable<DiagnosticListener>對(duì)象，IObservable接口大家應(yīng)該都不陌生了吧（不太清楚的可以看這里），然后通過(guò)其Subscribe方法進(jìn)行OnNext“回調(diào)”關(guān)心的事件數(shù)據(jù)。

示例代碼：

static IDisposable networkSubscription = null;

// 使用 AllListeners 來(lái)獲取所有的DiagnosticListeners對(duì)象，傳入一個(gè)IObserver<DiagnosticListener> 回調(diào)
static IDisposable listenerSubscription = DiagnosticListener.AllListeners.Subscribe(delegate (DiagnosticListener listener)
{
    // 當(dāng) DiagnosticsListener 激活的時(shí)候，這里將獲得一個(gè)回調(diào)用
    if (listener.Name == "System.Net.Http")
    {
        // 訂閱者監(jiān)聽(tīng)消費(fèi)代碼
        lock(allListeners)
        {
            if (networkSubscription != null)
                networkSubscription.Dispose();
            
            //回調(diào)業(yè)務(wù)代碼
            Action<KeyValuePair<string, object>> callback = (KeyValuePair<string, object> evnt) =>
                Console.WriteLine("From Listener {0} Received Event {1} with payload {2}", networkListener.Name, evnt.Key, evnt.Value);
           
            //創(chuàng)建一個(gè)匿名Observer對(duì)象
            Observer<KeyValuePair<string, object>> observer = new AnonymousObserver<KeyValuePair<string, object>>(callback);
            
            //篩選你感興趣的事件
            Predicate<string> predicate = (string eventName) => eventName == "RequestStart";
            
            networkSubscription = listener.Subscribe(observer, predicate);
        }
    }
});

// 通常情況下，這里你需要保持 listenerSubscription 始終處于激活狀態(tài)，
// 如果你像取消回調(diào)，你可以調(diào)用 listenerSubscription.Dispose() 來(lái)取消訂閱者

通過(guò)這種方式，我們就可以在觸發(fā)回調(diào)的之后做一些我們想要的操作了。

是不是發(fā)現(xiàn)上面的那種寫法有點(diǎn)麻煩和丑陋，ASP.NET 團(tuán)隊(duì)考慮到了，所以為我們封裝了一個(gè)適配器的庫(kù)來(lái)方便我們進(jìn)行監(jiān)聽(tīng)的一些操作，你可以通過(guò)打 attribute 標(biāo)記的方式來(lái)進(jìn)行相關(guān)事件的訂閱，有興趣的同學(xué)可以看下這個(gè)（Microsoft.Extensions.DiagnosticAdapte） NuGet 包。

現(xiàn)在我們已經(jīng)可以拿到數(shù)據(jù)了，有同學(xué)可能會(huì)說(shuō)在生產(chǎn)環(huán)境數(shù)據(jù)這么多，這些數(shù)據(jù)我存到哪里，又怎么樣來(lái)處理呢，我不可能一條一條的來(lái)找性能在哪里吧，OK，我們接著往下看。

為你的框架支持 Diagnostics

隨著微服務(wù)的流行，服務(wù)的鏈路追蹤以及應(yīng)用程序的性能問(wèn)題變得越來(lái)越重要，而 APM 也成為了整個(gè)微服務(wù)架構(gòu)中很重要的一個(gè)中間件，它可以協(xié)助我們快速查找生產(chǎn)環(huán)境中所遇到的問(wèn)題，以及在應(yīng)用程序發(fā)生異常的時(shí)候收集異常運(yùn)行時(shí)的上下文信息來(lái)快速排查問(wèn)題。

對(duì) Google 的 Dapper 或者 OpenTracing 協(xié)議有了解的同學(xué)應(yīng)該已經(jīng)想到了，我們可以利用上面的那些數(shù)據(jù)按照這些協(xié)議的約定進(jìn)行包裝，然后發(fā)送到支持這些協(xié)議的 APM 的服務(wù)端，剩下的工作是不是可以由這些服務(wù)端來(lái)幫助我們處理了，包括圖形化展示，性能查看，調(diào)用鏈查看等。

大多數(shù)的開(kāi)源APM項(xiàng)目都支持 Dapper 或者 OpenTracing 協(xié)議，如 Apache SkyWalking , ZipKin，pinpoint 等。 順便說(shuō)一句，我們 NCC開(kāi)源項(xiàng)目組 的 Lemon 同學(xué)正在給 SkyWalking 寫 C# 的 客戶端驅(qū)動(dòng)項(xiàng)目 ，這是一項(xiàng)非常具有挑戰(zhàn)性的工作，感興趣的同學(xué)可以 Star 一下。

相信閱讀本篇文章也有不少的架構(gòu)師，開(kāi)源項(xiàng)目作者，框架開(kāi)發(fā)者，甚至應(yīng)用程序開(kāi)發(fā)者，那么我建議可以從現(xiàn)在開(kāi)始對(duì)你的項(xiàng)目提供 Diagnostics 支持，目前 .NET Core 中 CoreFx , ASP.NET Core, EntityFramework Core 都已經(jīng)對(duì) Diagnostics 提供了支持。

CAP 在 2.2 版本中已經(jīng)對(duì) Diagnostics 提供了支持。

CAP 中的 Diagnostics

CAP: https://github.com/dotnetcore/CAP

CAP 是我的一個(gè)開(kāi)源項(xiàng)目，用來(lái)處理在微服務(wù)或者SOA架構(gòu)中分布式事務(wù)的一個(gè)解決方案，你可以在這篇文章中看到更多關(guān)于 CAP 的介紹，喜歡的同學(xué)可以給個(gè) Star ，也是我繼續(xù)做的更好的動(dòng)力，謝謝。

CAP 對(duì)外提供的事件監(jiān)聽(tīng)者名稱為： CapDiagnosticListener

CAP 中的 Diagnostics 提供對(duì)外提供的事件信息有：

• 消息持久化之前

• 消息持久化之后

• 消息持久化異常

• 消息向MQ發(fā)送之前

• 消息向MQ發(fā)送之后

• 消息向MQ發(fā)送異常

• 消息從MQ消費(fèi)保存之前

• 消息從MQ消費(fèi)保存之后

• 訂閱者方法執(zhí)行之前

• 訂閱者方法執(zhí)行之后

• 訂閱者方法執(zhí)行異常

相關(guān)涉及到的對(duì)象，你可以在 DotNetCore.CAP.Diagnostics 命名空間下看到。

基于這些對(duì)外的事件數(shù)據(jù)，我們可以來(lái)對(duì)接APM，下面這個(gè)是我對(duì)接的 ZipKin 的一個(gè)圖：

看完了這篇文章，相信你對(duì)“在.NET Core中如何使用Diagnostics記錄跟蹤信息”有了一定的了解，如果想了解更多相關(guān)知識(shí)，歡迎關(guān)注億速云行業(yè)資訊頻道，感謝各位的閱讀！