Trace

  • Article

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

La stratégie trace ajoute une trace personnalisée dans la sortie de suivi des requêtes dans la console de test, les télémétries Application Insights et/ou les journaux de ressources.

  • La stratégie ajoute une trace personnalisée à la sortie de suivi des requêtes dans la console de test quand le suivi est déclenché, c’est-à-dire que l’en-tête de demande Ocp-Apim-Trace est présent et a la valeur true et que l’en-tête de requête Ocp-Apim-Subscription-Key est présent et contient une clé valide qui autorise le traçage.
  • La stratégie crée des données de télémétrie Trace dans Application Insights, quand l’intégration à Application Insights est activée et que la severity spécifiée dans la stratégie est supérieur ou égal à la verbosity spécifiée dans le paramètre du diagnostic.
  • La stratégie ajoute une propriété dans l’entrée du journal quand les journaux de ressources sont activés et que le niveau de gravité spécifié dans la stratégie est supérieur ou égal au niveau de verbosité spécifié dans le paramètre du diagnostic.
  • La stratégie n’est pas affectée par l’échantillonnage d’Application Insights. Tous les appels de la stratégie seront enregistrés.

Avertissement

  • Autoriser uniquement le suivi sur les abonnements destinés au débogage. Le partage de clés d’abonnement avec le suivi autorisé avec des utilisateurs non autorisés peut entraîner la divulgation d’informations sensibles contenues dans les journaux de suivi, tels que les clés, les jetons d’accès, les mots de passe, les noms d’hôte internes et les adresses IP.
  • Dans la console de test, la gestion des API désactive automatiquement le traçage 1 heure après son activation sur un abonnement.

Remarque

Actuellement, le traçage des requêtes d’API n’est pas pris en charge dans les niveaux Essentiel v2 et Standard v2.

Remarque

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

<trace source="arbitrary string literal" severity="verbose | information | error">
    <message>String literal or expressions</message>
    <metadata name="string literal or expressions" value="string literal or expressions"/>
</trace>

Attributs

Attribut Description Obligatoire Default
source Littéral chaîne significatif pour la visionneuse de trace, qui spécifie la source du message. Les expressions de stratégie ne sont pas autorisées. Oui N/A
severity Spécifie le niveau de gravité de la trace. Les valeurs autorisées sont verbose, information et error (de la plus petite à la plus élevée). Les expressions de stratégie ne sont pas autorisées. Non verbose

Éléments

Nom Description Obligatoire
message Chaîne ou expression à journaliser. Les expressions de stratégie sont autorisées. Oui
metadata Ajoute une propriété personnalisée aux données de télémétrie Trace Application Insights. Non

Attributs de métadonnées

Attribut Description Obligatoire Default
name Nom de la propriété. Oui N/A
value Valeur de la propriété. Oui N/A

Usage

Exemple

<trace source="PetStore API" severity="verbose">
    <message>@((string)context.Variables["clientConnectionID"])</message>
    <metadata name="Operation Name" value="New-Order"/>
</trace>

Contenu connexe

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