Emisión de métricas personalizadas

  • Artículo

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.

Nota

Nota:

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.

Instrucción de la directiva

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

Atributos

Atributo Descripción Obligatorio Valor predeterminado
name Una cadena. Nombre de la métrica personalizada. No se permiten expresiones de directiva. Sí N/D
espacio de nombres Una cadena. 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

Elementos

Elemento Descripción Obligatorio
dimensión Agregue uno o varios de estos elementos para cada dimensión incluida en la métrica personalizada. Sí

Atributos de dimensión

Atributo Descripción Obligatorio Valor predeterminado
name Una cadena o expresión de directiva. Nombre de la dimensión. Sí N/D
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/D

Nombres de las dimensiones predeterminadas que se pueden usar sin valor

  • Id. de API
  • Id. de operación
  • Product ID
  • Identificador de usuario
  • Id. de suscripción
  • Id. de ubicación
  • Id. de puerta de enlace

Uso

Notas de uso

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

  • Invocar la directiva emit-metric cuenta para los límites de uso de métricas personalizadas por región en una suscripción. Más información

Ejemplo

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 usuario, la dirección IP del cliente y el identificador de API como dimensiones personalizadas.

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

Contenido relacionado

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