É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.
Notes
- Les métriques personnalisées sont une fonctionnalité de préversion d’Azure Monitor et soumises à des limitations.
- Pour plus d’informations sur les données de gestion des API ajoutées à Application Insights, consultez Guide pratique pour intégrer la gestion des API Azure à Azure Application Insights.
Notes
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.
Instruction de la stratégie
<emit-metric name="name of custom metric" value="value of custom metric" namespace="metric namespace">
<dimension name="dimension name" value="dimension value" />
</emit-metric>
Attributs
Attribut | Description | Obligatoire | Valeur par défaut |
---|---|---|---|
name | Chaîne. Nom de la métrique personnalisée Les expressions de stratégie ne sont pas autorisées. | Oui | N/A |
espace de noms | Chaîne. Espace de noms de la métrique personnalisée Les expressions de stratégie ne sont pas autorisées. | Non | Gestion des API |
value | Valeur de la métrique personnalisée exprimée en tant que double. Les expressions de stratégie sont autorisées. | Non | 1 |
Éléments
Élément | Description | Obligatoire |
---|---|---|
dimension | Ajoutez un ou plusieurs de ces éléments pour chaque dimension incluse dans la métrique personnalisée. | Oui |
Attributs de dimensions
Attribut | Description | Obligatoire | Valeur par défaut |
---|---|---|---|
name | Chaîne ou expression de stratégie. Nom de la dimension | Oui | 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. |
Non | N/A |
Noms de dimension par défaut qui peuvent être utilisés sans valeur
- ID d’API
- ID de l'opération
- Product ID
- ID d'utilisateur
- Identifiant d’abonnement
- ID d’emplacement
- ID de passerelle
Usage
- Sections de la stratégie : inbound, outbound, backend, on-error
- Étendues de la stratégie : global, espace de travail, produit, API, opération
- Passerelles : classiques, v2, de consommation, auto-hébergées
Notes d’utilisation
Vous pouvez configurer au maximum 10 dimensions personnalisées pour cette stratégie.
L’appel de la
emit-metric
stratégie compte pour les limites d’utilisation des métriques personnalisées par région dans un abonnement. En savoir plus
Exemple
L’exemple suivant envoie une métrique personnalisée pour compter le nombre de demandes d’API avec l’ID d’utilisateur, l’adresse IP du client et l’ID de l’API en tant que dimensions personnalisées.
<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>
Stratégies connexes
Contenu connexe
Pour plus d’informations sur l’utilisation des stratégies, consultez :
- Tutoriel : Transformer et protéger votre API
- Référence de stratégie pour obtenir la liste complète des instructions et des paramètres de stratégie
- Expressions de stratégie
- Définir ou modifier des stratégies
- Réutilisation de configurations de stratégie
- Référentiel d’extrait de stratégie
- Créer des stratégies à l’aide de Microsoft Copilot pour Azure