.NET 如何使用 OpenTelemetry metrics 监控应用程序指标_Asp.net

上一次我们讲了 opentelemetry logs 与 opentelemetry traces。今天继续来说说 opentelemetry metrics。
随着现代应用程序的复杂性不断增加，对于性能监控和故障排除的需求也日益迫切。在 .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 的活动链接数看看：

alt text

可以直观的看到从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";
        }
    }

添加一个 order 的控制器，每次调用 add 方法的时候就会给 myordercounter 加 1 。