Partager via

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 du traçage des requêtes dans la console de test quand le traçage est déclenché.
  • 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.

Important

  • Vous ne pouvez plus activer le traçage des requêtes du service Gestion des API en définissant l’en-tête Ocp-Apim-Trace dans une requête, et en utilisant la valeur de l’en-tête Ocp-Apim-Trace-Location dans la réponse pour récupérer la trace.
  • Pour améliorer la sécurité, le traçage est désormais activé au niveau d’une API individuelle via l’obtention d’un jeton d’une durée limitée à l’aide de l’API REST du service Gestion des API, et le passage du jeton à la passerelle dans une requête. Pour plus d’informations, consultez la suite de ce tutoriel.
  • Soyez prudent quand vous activez le traçage, car il peut exposer des informations sensibles dans les données de traçage. Veillez à mettre en place les mesures de sécurité appropriées pour protéger les données de trace.

Remarque

Pour le moment, 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 :