发出自定义指标

适用于:所有 API 管理层级

emit-metric 策略将指定格式的自定义指标发送到 Application Insights。

注意

按照策略声明中提供的顺序设置策略的元素和子元素。 详细了解如何设置或编辑 API 管理策略

策略语句

<emit-metric name="name of custom metric" value="value of custom metric" namespace="metric namespace"> 
    <dimension name="dimension name" value="dimension value" /> 
</emit-metric> 

属性

属性 说明 必须 默认值
name 一个字符串。 自定义指标的名称。 不允许使用策略表达式。 空值
命名空间 一个字符串。 自定义指标的命名空间。 不允许使用策略表达式。 API 管理
value 以双精度表示的自定义指标的值。 允许使用策略表达式。 1

元素

元素 说明 必需
维度 为自定义指标中包含的每个维度添加一个或多个此类元素。

维度属性

属性 说明 必须 默认值
name 字符串或策略表达式。 维度的名称。 空值
value 字符串或策略表达式。 维度的值。 如果 name 与一个默认维度匹配,则只能省略。 如果是这样,则按维度名称提供值。 空值

无需值即可使用的默认维度名称

  • API ID
  • Operation ID
  • 产品 ID
  • 用户 ID
  • 订阅 ID
  • 位置
  • 网关 ID

使用情况

使用注意事项

  • 最多可以为此策略配置 10 个自定义维度。

  • 调用 emit-metric 策略会计入订阅中每个区域的自定义指标的使用限制。 了解详细信息

示例

以下示例发送一个自定义指标,用于统计 API 请求数,以及用户 ID、客户端 IP 和 API ID 作为自定义维度。

<policies>
  <inbound>
    <emit-metric name="Request" value="1" namespace="my-metrics"> 
        <dimension name="User ID" /> 
        <dimension name="Client IP" value="@(context.Request.IpAddress)" /> 
        <dimension name="API ID" /> 
    </emit-metric> 
  </inbound>
  <outbound>
  </outbound>
</policies>

后续步骤

有关使用策略的详细信息,请参阅: