&

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

freeflydom

2024年6月11日 9:37 本文熱度 1376

隨著現(xiàn)代應(yīng)用程序的復(fù)雜性不斷增加，對于性能監(jiān)控和故障排除的需求也日益迫切。在 .NET 生態(tài)系統(tǒng)中，OpenTelemetry Metrics 可用于實時監(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)建、注冊和導(dǎo)出度量指標(biāo)，以便實時監(jiān)控和分析應(yīng)用程序的性能。OpenTelemetry Metrics 支持各種類型的度量指標(biāo)，包括計數(shù)器（Counter）、測量值（ObservableGauge）等，以滿足不同場景下的性能監(jiān)控需求。

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

OpenTelemetry 已經(jīng)為我們直接提供了一些開箱即用的包。我們使用這些包就可以非常便捷的對 ASP.NET Core 或者 Runtime 的一些指標(biāo)進行監(jiān)控。以下我們將演示通過簡單的幾步如何把這些指標(biāo)通過 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 一樣，我們需要在啟動的時候添加必要的服務(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 運行。啟動的時候記得開啟參數(shù)：otlp-write-receiver

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

prometheus 默認的 metrics 的 api 地址為：http://localhost:9090/api/v1/otlp/v1/metrics

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

讓我們運行上面的 .NET 程序，等待一會。然后打開 http://localhost:9090/graph 進行查看。我們能看到 Prometheus 中多了很多跟 ASP.NET Core 以及 .NET runtime 相關(guān)的指標(biāo)。

有 kestrel 相關(guān)的，GC 相關(guān)的， Thread pool 相關(guān)的指標(biāo)等等很多很多。
下面我們隨便選一個 kestrel 的活動鏈接數(shù)看看：

可以直觀的看到從0個連接到2個連接再到1個連接的過程。

自定義指標(biāo)#

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

MyMeterService#

首先定義一個 MyMeterService 的類：

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

首先創(chuàng)建了一個名為 MyMeter 的度量器。然后創(chuàng)建了一個名為 MyOrderCounter 的長整型計數(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;


    });
});

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

添加 Order 控制器#

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

            return "ok";
        }

    }