Partager via

Émettre des métriques personnalisées

S’APPLIQUE À : Tous les niveaux de Gestion des API

La stratégie emit-metric envoie des métriques personnalisées dans le format spécifié à Application Insights.

Note

Définissez les éléments enfants et de stratégie dans l’ordre fourni dans l’instruction de stratégie. En savoir plus sur comment définir ou modifier des stratégies du service Gestion des API.

Limites pour les métriques personnalisées

Azure Monitor impose des limites d’utilisation pour les métriques personnalisées qui peuvent affecter votre capacité à émettre des métriques à partir de Gestion des API. Par exemple, Azure Monitor définit actuellement une limite de 10 clés de dimension par métrique et une limite de 50 000 séries chronologiques actives totales par région dans un abonnement (dans une période de 12 heures). Dans Gestion des API, 5 d’entre elles sont utilisées pour les dimensions par défaut, notamment les suivantes :

  • Region
  • Service ID
  • Service Name
  • Service Type

Ces limites ont les implications suivantes pour la configuration des métriques personnalisées dans une stratégie de gestion des API telle que emit-metric ou azure-openai-emit-token-metric :

  • Vous pouvez configurer un maximum de 5 dimensions personnalisées par stratégie.

  • Le nombre de séries chronologiques actives générées par la stratégie dans une période de 12 heures est le produit du nombre de valeurs uniques de chaque dimension configurée au cours de la période. Par exemple, si trois dimensions personnalisées ont été configurées dans la stratégie et que chaque dimension a 10 valeurs possibles au cours de la période, la stratégie contribuera à 1 000 (10 x 10 x 10) séries chronologiques actives.

  • Si vous configurez la stratégie dans plusieurs instances Gestion des API qui se trouvent dans la même région d’un abonnement, toutes les instances peuvent contribuer à la limite des séries chronologiques actives régionales.

Découvrez plus en détail les limitations et considérations relatives à la conception de métriques personnalisées dans 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. Nom de la métrique personnalisée Les expressions de stratégie ne sont pas autorisées. Yes N/A
namespace A string. Espace de noms de la métrique personnalisée Les expressions de stratégie ne sont pas autorisées. No API Management
value Valeur de la métrique personnalisée exprimée en tant que double. Les expressions de stratégie sont autorisées. No 1

Elements

Element Description Required
dimension Ajoutez un ou plusieurs de ces éléments pour chaque dimension incluse dans la métrique personnalisée. Yes

Dimension attributes

Attribute Description Required Default value
name Chaîne ou expression de stratégie. Nom de la dimension Yes N/A
value Chaîne ou expression de stratégie. Valeur de la dimension. Ne peut être omise que si name correspond à l’une des dimensions par défaut. Si c’est le cas, la valeur est fournie en fonction du nom de la dimension. No N/A

Noms de dimension par défaut qui peuvent être utilisés sans valeur

  • API ID
  • Operation ID
  • Product ID
  • User ID
  • Subscription ID
  • Location
  • Gateway ID
  • ID principal (utiliser uniquement dans la section stratégie sortante)

Usage

Usage notes

  • Vous pouvez configurer au maximum 5 dimensions personnalisées pour cette stratégie.

Example

L’exemple suivant envoie une métrique personnalisée pour compter le nombre de requêtes d’API ainsi que l’ID d’API comme dimension par défaut.

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

Related content

Pour plus d’informations sur l’utilisation des stratégies, consultez :

  • Last updated on