.NET 使用 OpenTelemetry metrics 监控应用程序指标

freeflydom

2024年6月11日 9:37 本文热度 960

随着现代应用程序的复杂性不断增加，对于性能监控和故障排除的需求也日益迫切。在 .NET 生态系统中，OpenTelemetry Metrics 可用于实时监控和分析应用程序的性能指标。比如监控内存，CPU 使用量，链接数等等。

OpenTelemetry Metrics 概述#

OpenTelemetry Metrics 是 OpenTelemetry 的一部分，用于记录和导出应用程序的性能指标。它提供了一组灵活的 API 和工具，用于创建、注册和导出度量指标，以便实时监控和分析应用程序的性能。OpenTelemetry Metrics 支持各种类型的度量指标，包括计数器（Counter）、测量值（ObservableGauge）等，以满足不同场景下的性能监控需求。

监控 ASP.NET Core 与 Runtime 的指标#

OpenTelemetry 已经为我们直接提供了一些开箱即用的包。我们使用这些包就可以非常便捷的对 ASP.NET Core 或者 Runtime 的一些指标进行监控。以下我们将演示通过简单的几步如何把这些指标通过 OpenTelemetry 协议发送给 Prometheus。

使用 nuget 安装包#

首先安装相关的包

		<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" />

配置服务#

跟 logs，traces 一样，我们需要在启动的时候添加必要的服务及配置。



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#

从官网下载 Prometheus 的安装包或者 k8s 运行。启动的时候记得开启参数：otlp-write-receiver

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

prometheus 默认的 metrics 的 api 地址为：http://localhost:9090/api/v1/otlp/v1/metrics

在 Prometheus 中查看指标#

让我们运行上面的 .NET 程序，等待一会。然后打开 http://localhost:9090/graph 进行查看。我们能看到 Prometheus 中多了很多跟 ASP.NET Core 以及 .NET runtime 相关的指标。

有 kestrel 相关的，GC 相关的， Thread pool 相关的指标等等很多很多。
下面我们随便选一个 kestrel 的活动链接数看看：

可以直观的看到从0个连接到2个连接再到1个连接的过程。

自定义指标#

以上演示了如何监控 ASP.NET Core 以及 .NET runtime 相关的指标。过程呢相当简单。但是光有这些框架的指标可能还不够，有的时候我们希望监控业务数据的指标，比如订单数量，实时用户在线量，等等。那么这个时候我们需要自己去实现一个指标。
下面我们就以订单总数这个数据定义一个自定义的指标。当用户每次下单成功后订单数量就会 +1。

MyMeterService#

首先定义一个 MyMeterService 的类：

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

首先创建了一个名为 MyMeter 的度量器。然后创建了一个名为 MyOrderCounter 的长整型计数器（Counter），并将其绑定到 MyMeter 上，名称为 "MyOrderCounter"。

修改服务配置代码#

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;


    });
});

通过调用 AddMeter("MyMeter") 方法 OpenTelemetry 会监听前面定义的 MyMeter 度量器。

添加 Order 控制器#

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

            return "ok";
        }

    }