配置指标

使用 IConfiguration 筛选与依赖项注入 (DI) 集成的自定义指标侦听器的检测。 这些筛选器控制侦听器可以订阅哪些检测,而不是它如何聚合或导出度量值。

指标监听器

指标侦听器从由Meter创建的工具(如计数器和直方图)接收度量值。 该 MeterListener 类提供低级别 API 来发现仪器并直接订阅其测量值。 指标集合教程演示如何使用此 API。

该 IMetricsListener 接口允许自定义侦听器与 DI 和基于配置的筛选器集成。 指标基础结构会在内部为每个已注册的MeterListener实现创建一个IMetricsListener。 它在调用 InstrumentPublished 向实现提供检测之前应用配置的规则。 如果侦听器接受检测,基础结构会将度量值传递到实现提供的回调。

若要注册自定义侦听器,请使用 AddListener。 本文中的配置适用于这些已注册的侦听器,不适用于你的代码或收集器直接配置的 MeterListener 实例。

加载配置

使用默认生成器设置的通用主机应用程序会自动调用AddMetrics,并从IConfiguration加载Metrics节。 在非托管 DI 应用程序中,显式调用 AddMetrics 和 AddConfiguration(IMetricsBuilder, IConfiguration) 以绑定同一节:

services.AddMetrics(metrics =>
    metrics.AddConfiguration(configuration.GetSection("Metrics")));

若要使用这些扩展方法,请导入 Microsoft.Extensions.DependencyInjection 和 Microsoft.Extensions.Diagnostics.Metrics 命名空间。

Important

Metrics 配置仅筛选已注册 IMetricsListener 实现的检测。 它不注册侦听器或激活其订阅、创建指标、聚合度量、导出数据或自动配置 OpenTelemetry、Prometheus dotnet-counters或任何其他收集器。

选择仪表和检测

使用以下部分选择规则适用的仪表:

部分 适用对象
EnabledMetrics 全局和本地仪表。
EnabledGlobalMetrics 没有范围的仪表,例如直接使用 Meter 创建的仪表。
EnabledLocalMetrics 限定到服务容器 IMeterFactory 的仪表。

EnabledLocalMetrics正下方的Metrics、EnabledMetrics或EnabledGlobalMetrics部分适用于每个已注册的侦听器。 要针对一个侦听器,请将节嵌套在侦听器的 Name 值下,例如 Metrics:MyListener:EnabledMetrics。 侦听器和检测名称需要完全匹配,不区分大小写。

在这些节中的任何一个中,布尔仪表条目启用或禁用仪表名称匹配的每个检测。 要设置检测级别的规则,请使用以检测名称为键的对象。 特殊 Default 条目提供回退。 仪表级别的布尔 Default 条目适用于其他不匹配的仪表。 在仪表对象中,Default 适用于其他不匹配的检测。 如果没有规则匹配,侦听器不会接收检测。

以下 appsettings.json 示例启用名称以 Contoso.Web 开头的仪表的检测,名称为 request-duration 的检测除外:

{
  "Metrics": {
    "EnabledMetrics": {
      "Contoso.Web": {
        "Default": true,
        "request-duration": false
      }
    }
  }
}

匹配规则并解决冲突

指标名称使用不区分大小写的前缀匹配。 仪表名称最多可以包含一个 * 通配符,以匹配前缀和后缀。 更具体的规则按以下顺序优先:侦听器特定规则、更长的仪表名称模式、检测特定规则和范围特定规则。 如果同样特定的规则冲突,则最后一个配置的规则将获胜。

另请参阅