Loading

.NET 使用 OpenTelemetry metrics 監(jiān)控應(yīng)用程序指標(biāo)

上一次我們講了 OpenTelemetry Logs 與 OpenTelemetry Traces。今天繼續(xù)來(lái)說(shuō)說(shuō) OpenTelemetry Metrics。
隨著現(xiàn)代應(yīng)用程序的復(fù)雜性不斷增加，對(duì)于性能監(jiān)控和故障排除的需求也日益迫切。在 .NET 生態(tài)系統(tǒng)中，OpenTelemetry Metrics 可用于實(shí)時(shí)監(jiān)控和分析應(yīng)用程序的性能指標(biāo)。比如監(jiān)控內(nèi)存，CPU 使用量，鏈接數(shù)等等。

OpenTelemetry Metrics 概述

OpenTelemetry Metrics 是 OpenTelemetry 的一部分，用于記錄和導(dǎo)出應(yīng)用程序的性能指標(biāo)。它提供了一組靈活的 API 和工具，用于創(chuàng)建、注冊(cè)和導(dǎo)出度量指標(biāo)，以便實(shí)時(shí)監(jiān)控和分析應(yīng)用程序的性能。OpenTelemetry Metrics 支持各種類型的度量指標(biāo)，包括計(jì)數(shù)器（Counter）、測(cè)量值（ObservableGauge）等，以滿足不同場(chǎng)景下的性能監(jiān)控需求。

監(jiān)控 ASP.NET Core 與 Runtime 的指標(biāo)

OpenTelemetry 已經(jīng)為我們直接提供了一些開(kāi)箱即用的包。我們使用這些包就可以非常便捷的對(duì) ASP.NET Core 或者 Runtime 的一些指標(biāo)進(jìn)行監(jiān)控。以下我們將演示通過(guò)簡(jiǎn)單的幾步如何把這些指標(biāo)通過(guò) OpenTelemetry 協(xié)議發(fā)送給 Prometheus。

使用 nuget 安裝包

首先安裝相關(guān)的包

		<PackageReference Include="OpenTelemetry.Exporter.OpenTelemetryProtocol" Version="1.8.1" />
		<PackageReference Include="OpenTelemetry.Extensions.Hosting" Version="1.8.1" />
		<PackageReference Include="OpenTelemetry.Instrumentation.AspNetCore" Version="1.8.1" />
		<PackageReference Include="OpenTelemetry.Instrumentation.Runtime" Version="1.8.1" />

配置服務(wù)

跟 logs，traces 一樣，我們需要在啟動(dòng)的時(shí)候添加必要的服務(wù)及配置。


builder.Services.AddControllers();

var otel = builder.Services.AddOpenTelemetry();

// Configure OpenTelemetry Resources with the application name
otel.ConfigureResource(resource => resource
    .AddService(builder.Environment.ApplicationName));


otel.WithMetrics(metrics =>
{
    metrics.AddAspNetCoreInstrumentation()
    .AddRuntimeInstrumentation()
    .AddOtlpExporter((otlpOptions, metricReaderOptions) =>
    {
        otlpOptions.Protocol = OtlpExportProtocol.HttpProtobuf;
        otlpOptions.Endpoint = new Uri("http://localhost:9090/api/v1/otlp/v1/metrics");
        metricReaderOptions.PeriodicExportingMetricReaderOptions.ExportIntervalMilliseconds = 1000;

    });
});

安裝 Prometheus

從官網(wǎng)下載 Prometheus 的安裝包或者 k8s 運(yùn)行。啟動(dòng)的時(shí)候記得開(kāi)啟參數(shù)：otlp-write-receiver

./prometheus --enable-feature=otlp-write-receiver

prometheus 默認(rèn)的 metrics 的 api 地址為：http://localhost:9090/api/v1/otlp/v1/metrics

在 Prometheus 中查看指標(biāo)

讓我們運(yùn)行上面的 .NET 程序，等待一會(huì)。然后打開(kāi) http://localhost:9090/graph 進(jìn)行查看。我們能看到 Prometheus 中多了很多跟 ASP.NET Core 以及 .NET runtime 相關(guān)的指標(biāo)。
alt text
有 kestrel 相關(guān)的，GC 相關(guān)的， Thread pool 相關(guān)的指標(biāo)等等很多很多。
下面我們隨便選一個(gè) kestrel 的活動(dòng)鏈接數(shù)看看：

可以直觀的看到從0個(gè)連接到2個(gè)連接再到1個(gè)連接的過(guò)程。

自定義指標(biāo)

以上演示了如何監(jiān)控 ASP.NET Core 以及 .NET runtime 相關(guān)的指標(biāo)。過(guò)程呢相當(dāng)簡(jiǎn)單。但是光有這些框架的指標(biāo)可能還不夠，有的時(shí)候我們希望監(jiān)控業(yè)務(wù)數(shù)據(jù)的指標(biāo)，比如訂單數(shù)量，實(shí)時(shí)用戶在線量，等等。那么這個(gè)時(shí)候我們需要自己去實(shí)現(xiàn)一個(gè)指標(biāo)。
下面我們就以訂單總數(shù)這個(gè)數(shù)據(jù)定義一個(gè)自定義的指標(biāo)。當(dāng)用戶每次下單成功后訂單數(shù)量就會(huì) +1。

MyMeterService

首先定義一個(gè) MyMeterService 的類：

    public class MyMeterService
    {
        public static Meter MyMeter = new("MyMeter", "1.0");
        public static Counter<long> MyOrderCounter = MyMeter.CreateCounter<long>("MyOrderCounter");
    }

首先創(chuàng)建了一個(gè)名為 MyMeter 的度量器。然后創(chuàng)建了一個(gè)名為 MyOrderCounter 的長(zhǎng)整型計(jì)數(shù)器（Counter），并將其綁定到 MyMeter 上，名稱為 "MyOrderCounter"。

修改服務(wù)配置代碼

otel.WithMetrics(metrics =>
{
    metrics.AddAspNetCoreInstrumentation()
    .AddRuntimeInstrumentation()
    .AddMeter("MyMeter")
    .AddOtlpExporter((otlpOptions, metricReaderOptions) =>
    {
        otlpOptions.Protocol = OtlpExportProtocol.HttpProtobuf;
        otlpOptions.Endpoint = new Uri("http://localhost:9090/api/v1/otlp/v1/metrics");
        metricReaderOptions.PeriodicExportingMetricReaderOptions.ExportIntervalMilliseconds = 1000;

    });
});

通過(guò)調(diào)用 AddMeter("MyMeter") 方法 OpenTelemetry 會(huì)監(jiān)聽(tīng)前面定義的 MyMeter 度量器。

添加 Order 控制器

    [ApiController]
    [Route("[controller]")]
    public class OrderController : ControllerBase
    {
        [HttpPost]
        public string Add()
        {
            MyMeterService.MyOrderCounter.Add(1);

            return "ok";
        }

    }

添加一個(gè) Order 的控制器，每次調(diào)用 Add 方法的時(shí)候就會(huì)給 MyOrderCounter 加 1 。

在 Prometheus 中查看自定義指標(biāo)

跟上面一樣我運(yùn)行我們的程序后等待一會(huì)，再次刷新 http://localhost:9090/graph。里面就會(huì)多出來(lái) MyOrderCounter 指標(biāo)。
alt text

使用 POSTMAN 調(diào)用幾次 Order 接口后，點(diǎn)擊 Execute 查詢一下：

alt text

可以看到 MyOrderCounter 指標(biāo)的折線圖。

總結(jié)

以上我們通過(guò)代碼演示了如何通過(guò) OpenTelemetry 把 Metrics 的數(shù)據(jù)發(fā)送到 Prometheus 里進(jìn)行查詢與展示。然后又演示了自定義相關(guān)指標(biāo)來(lái)滿足業(yè)務(wù)數(shù)據(jù)指標(biāo)的監(jiān)控。從概念到代碼還是非常非常簡(jiǎn)單清晰的。希望對(duì)各位正在打算建立監(jiān)控體系的同學(xué)有所幫助。

關(guān)注我的公眾號(hào)一起玩轉(zhuǎn)技術(shù)

posted @ 2024-06-10 21:39 Agile.Zhou 閱讀(946) 評(píng)論(4) 收藏舉報(bào)

刷新頁(yè)面返回頂部