Compartir a través de

Emisión de métricas personalizadas

SE APLICA A: todos los niveles de API Management

La directiva emit-metric envía métricas personalizadas en el formato especificado a Application Insights.

Note

Establezca los elementos de la directiva y los elementos secundarios en el orden proporcionado en la instrucción de directiva. Obtenga más información sobre el establecimiento o modificación de directivas de API Management.

Límites de métricas personalizadas

Azure Monitor impone límites de uso para métricas personalizadas que pueden afectar la capacidad de emitir métricas de API Management. Por ejemplo, Azure Monitor establece actualmente un límite de 10 claves de dimensión por métrica y un límite de 50 000 series temporales activas totales por región en una suscripción (dentro de un período de 12 horas). En API Management, se usan 5 de estas dimensiones para las dimensiones predeterminadas, incluidas las siguientes:

  • Region
  • Service ID
  • Service Name
  • Service Type

Estos límites tienen las siguientes implicaciones para configurar métricas personalizadas en una directiva de API Management como emit-metric o azure-openai-emit-token-metric:

  • Puede configurar un máximo de 5 dimensiones personalizadas por directiva.

  • El número de series temporales activas generadas por la directiva en un período de 12 horas es el producto del número de valores únicos de cada dimensión configurada durante el período. Por ejemplo, si se configuraron tres dimensiones personalizadas en la directiva y cada dimensión tenía 10 valores posibles en el período, la directiva contribuiría a 1000 (10 x 10 x 10) series temporales activas.

  • Si configura la directiva en varias instancias de API Management que se encuentran en la misma región de una suscripción, todas las instancias pueden contribuir al límite regional de series temporales activas.

Obtenga más información sobre las limitaciones y consideraciones de diseño para las métricas personalizadas en Azure Monitor.

Prerequisites

Policy statement

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

Attributes

Attribute Description Required Default value
name A string. Nombre de la métrica personalizada. No se permiten expresiones de directiva. Yes N/A
namespace A string. Espacio de nombres de la métrica personalizada. No se permiten expresiones de directiva. No API Management
value Valor de la métrica personalizada expresada como un double. Se permiten expresiones de directiva. No 1

Elements

Element Description Required
dimension Agregue uno o varios de estos elementos para cada dimensión incluida en la métrica personalizada. Yes

Dimension attributes

Attribute Description Required Default value
name Una cadena o expresión de directiva. Nombre de la dimensión. Yes N/A
value Una cadena o expresión de directiva. Valor de la dimensión. Solo se puede omitir si name coincide con una de las dimensiones predeterminadas. Si es así, el valor se proporciona según el nombre de la dimensión. No N/A

Nombres de las dimensiones predeterminadas que se pueden usar sin valor

  • API ID
  • Operation ID
  • Product ID
  • User ID
  • Subscription ID
  • Location
  • Gateway ID
  • Id. de back-end (use solo en la sección de directiva de salida)

Usage

Usage notes

  • Puede configurar como máximo 5 dimensiones personalizadas para esta directiva.

Example

En el ejemplo siguiente se envía una métrica personalizada para contar el número de solicitudes de API junto con el identificador de API como una dimensión predeterminada.

<policies>
  <inbound>
    <emit-metric name="Request" value="1" namespace="my-metrics"> 
        <dimension name="API ID" /> 
    </emit-metric> 
  </inbound>
  <outbound>
  </outbound>
</policies>

Related content

Para más información sobre el trabajo con directivas, vea:

  • Last updated on