System.Diagnostics.Metrics .NET 6 全新指標API講解

更新時間：2021年11月24日 09:10:35 作者：SpringLeee

本文詳細講解了.NET 6全新指標System.Diagnostics.Metrics，文中通過示例代碼介紹的非常詳細。對大家的學習或者工作具有一定的參考學習價值，需要的朋友們下面隨著小編來一起學習學習吧

前言

工友們, .NET 6 Preview 7 已經(jīng)在8月10號發(fā)布了, 除了眾多的功能更新和性能改進之外, 在 preview 7 版本中, 也新增了全新的指標API, System.Diagnostics.Metrics, 為了讓應用能有更好的可觀測性, 在之前的發(fā)布的.NET 5中, 也把 Activity 增強為 ActivitySource, 主要原因還是 .NET 運行時團隊和 OpenTelemetry .NET SIG 進行了深度合作, 并且一起制定了 OpenTelemetry .NET 指標計劃。

Metric support plans

Metrics APIs Design

目前 System.Diagnostics.Metrics 這個api還只能在 .NET preview 7 中使用, 當然后邊也會像 System.Text.Json庫一樣發(fā)布到Nuget平臺, 讓其他版本的 .NET 項目接入使用。

指標介紹

下邊介紹了幾個主要的類

Meter 用來創(chuàng)建和跟蹤指標Instrument
MeterListener 用來監(jiān)聽指標Instrument的值的更新
Counter 計數(shù)器, 一般記錄累加的值, 比如程序中的錯誤數(shù), 請求數(shù) 都可以用計數(shù)器
Histogram 直方圖, 記錄可統(tǒng)計的值, 比如記錄下每一個接口的響應時間, 然后再根據(jù)時間進行匯總
ObservableCounter 可觀察計數(shù)器, 一般記錄累加的值, 比如 CPU 時間等
ObservableGauge 可觀測儀表盤, 你可以用來記錄應用的內(nèi)存, GC 的內(nèi)存等

Meter

Meter類用來創(chuàng)建各種指標Instrument, 包括計數(shù)器,直方圖,儀表盤指標等等, Meter 類包含了 Name 和 Version 屬性, 你可以設置meter的名稱和版本。

var meter = new Meter("meter","v1.0");

var requestCount = meter.CreateCounter<long>("RequestCount");

var responseTime = meter.CreateHistogram<long>("ResponseTime");

// ...

MeterListener

MeterListener 可以用來監(jiān)聽指標組件的值變化, 同樣相對應的也有 ActivityListener。

MeterListener listener = new MeterListener();  

listener.InstrumentPublished = (instrument, meterListener) =>
{
    Console.WriteLine($"EnableMeasurementEvents {instrument.Name} ");
    meterListener.EnableMeasurementEvents(instrument);
};

listener.SetMeasurementEventCallback<long>((instrument, measurement, tags, state) =>
{
    Console.WriteLine($"Instrument: {instrument.Name} has recorded the measurement {measurement}");
});

listener.MeasurementsCompleted = (instrument, state) =>
{
    listener.DisableMeasurementEvents(instrument);
};

listener.Start();

屬性

InstrumentPublished 當使用Meter類創(chuàng)建指標Instrument時, 這個回調(diào)可以接收到創(chuàng)建的指標信息。
MeasurementsCompleted 當停止指標的收集時,這個回調(diào)可以接收到相應的指標信息, 通常是執(zhí)行了 Meter 和 MeterListener 的Dispose() 方法

方法

EnableMeasurementEvents 開啟相應指標Instrument的監(jiān)聽
DisableMeasurementEvents 關閉相應指標Instrument的監(jiān)聽
SetMeasurementEventCallback 設置指標Instrument的測量值更新的回調(diào)
RecordObservableInstruments 記錄所有監(jiān)聽的可觀察指標(Observable instruments)的當前測量值。
Start 開啟監(jiān)聽指標Instrument。

Counter 計數(shù)器

Counter是計數(shù)器指標,可以用來記錄累加的值,使用非常簡單,下邊的示例中,模擬記錄了程序的請求次數(shù),首先調(diào)用 CreateCounter 函數(shù)創(chuàng)建一個計數(shù)器指標 requestCount, 然后調(diào)用Add 方法, 進行Counter的累加操作。

Meter meter = new Meter("meter","v1.0");

var requestCount = meter.CreateCounter<long>("RequestCount");

for (int i = 0; i < 10; i++)
{
    requestCount.Add(1);
}

然后使用上面的 MeterListener 來監(jiān)聽計數(shù)器指標, 程序的輸出如下:

在第一行, MeterListener 檢測到了上面創(chuàng)建的 RequestCount 計數(shù)器, 并且開啟了指標的監(jiān)聽, 當我們調(diào)用 requestCount.Add(1) 后, MeterListener 捕獲到了指標測量值的更新, 然后在控制臺輸出了相應的值, 需要注意的是, MeasurementEventCallback 回調(diào)方法只會捕獲指標每次更新的測量值, 而不是匯總后的總數(shù),所以這里的輸出都是1。

Histogram 直方圖

Histogram 是直方圖指標,記錄可統(tǒng)計的值, 比如記錄下每一個接口的響應時間, 然后再根據(jù)時間進行匯總, 和 Counter 差不多, 不過指標的維度不一樣, 而且 Histogram 使用Record()方法記錄每次的值,而不是Add()方法。

Meter meter = new Meter("meter","v1.0");

var responseTime = meter.CreateHistogram<long>("ResponseTime");

for (int i = 0; i < 10; i++)
{
    var cost = new Random().Next(100,1000);

    responseTime.Record(cost);
}

用隨機數(shù)表示了接口的響應耗時, 輸出如下:

ObservableCounter 可觀察計數(shù)器

ObservableCounter 是可觀察的計數(shù)器, 和 Counter 不一樣的是, 創(chuàng)建 ObservableCounter 需要傳入一個Func委托, 來返回一個測量值, 當然也不需要手動調(diào)用 Add(), Record() 方法, 只需要定時調(diào)用 MeterListener的RecordObservableInstruments 方法, 獲取當前的指標測量值。

    class Program
    {
        static async Task Main(string[] args)
        {

            MeterListener listener = new MeterListener();

            Start(listener);

            AutoRecord(listener);
            

            Meter meter = new Meter("meter","v1.0");

            _ = meter.CreateObservableCounter<long>("CPU_Counter",() => new Random().Next(100,1000));

            Console.ReadKey();
        }

        static void Start(MeterListener listener)
        {
            listener.InstrumentPublished = (instrument, meterListener) =>
            {
                Console.WriteLine($"EnableMeasurementEvents {instrument.Name} ");
                meterListener.EnableMeasurementEvents(instrument);
            };

            listener.SetMeasurementEventCallback<long>((instrument, measurement, tags, state) =>
            {
                Console.WriteLine($"Instrument: {instrument.Name} has recorded the measurement {measurement}");
            });

            listener.MeasurementsCompleted = (instrument, state) =>
            {
                listener.DisableMeasurementEvents(instrument);
            };

            listener.Start();

        }

        static void AutoRecord(MeterListener listener)
        {
            var cts = new CancellationTokenSource();

            _ = Task.Run(async () => {

                while (!cts.IsCancellationRequested)
                {
                    await Task.Delay(3000);

                    listener.RecordObservableInstruments();

                }

            });

        }

    }

ObservableGauge 儀表盤指標

這個比較好理解, 你可以用來記錄應用的內(nèi)存,GC 的內(nèi)存等, 同樣是可觀察指標, 也需要傳入一個返回測量值的func委托。

MeterListener listener = new MeterListener();

Start(listener);

AutoRecord(listener);

Meter meter = new Meter("meter","v1.0");

_ = meter.CreateObservableGauge<long>("GC_Memory_Gauge",() => GC.GetTotalMemory(false));

Console.ReadKey();

程序的輸出如下:

總結

本文主要介紹了.NET 6 指標API System.Diagnostics.Metrics,通過這些API, 可以很方便的收集應用的指標數(shù)據(jù), 但是本文好像沒有提到數(shù)據(jù)的聚合匯總? 不要擔心, 運行時團隊針對相應的指標API已經(jīng)開發(fā)了一系列高性能的聚合API, 預計在.NET 6 preview 8 中發(fā)布更新!

以上就是本文的全部內(nèi)容，希望對大家的學習有所幫助，也希望大家多多支持腳本之家。