Tutoriel : Déboguer vos API à l’aide du suivi des demandes
S’APPLIQUE À : Consommation | Développeur | Essentiel | Standard | Premium
Ce tutoriel explique comment inspecter (tracer) le traitement des requêtes dans le service Gestion des API Azure. Le traçage vous aide à résoudre les bogues et les problèmes liés à votre API.
Dans ce tutoriel, vous allez apprendre à :
- Suivre un exemple d’appel
- Passer en revue les étapes du traitement des demandes
Remarque
Actuellement, le suivi des requêtes d’API n’est pas pris en charge dans les niveaux Essentiel v2 et Standard v2.
Prérequis
- Apprenez la terminologie relative à Gestion des API Azure.
- Suivez le guide de démarrage rapide suivant : Créer une instance du service Gestion des API Azure.
- Effectuez toutes les étapes du tutoriel suivant : Importer et publier votre première API.
Vérifier le paramètre Autoriser le suivi
Pour suivre le traitement des demandes, vous devez activer le paramètre Autoriser le suivi pour l’abonnement utilisé pour déboguer votre API. Pour vérifier dans le portail :
Accédez à votre instance Gestion des API et sélectionnez Abonnements pour passer en revue les paramètres.
Si le suivi n’est pas activé pour l’abonnement que vous utilisez, sélectionnez l’abonnement et activez Autoriser le suivi.
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 suivi 1 heure après son activation sur un abonnement.
Suivre un appel
Connectez-vous au portail Azure et accédez à votre instance de Gestion des API.
Sélectionnez API.
Sélectionnez Demo Conference API dans votre liste d’API.
Sélectionnez l’onglet Test.
Sélectionnez l’opération GetSpeakers.
Si vous le souhaitez, vérifiez la valeur de l’en-tête Ocp-Apim-Subscription-Key utilisé dans la demande en sélectionnant l’icône « œil ».
Conseil
Vous pouvez remplacer la valeur Ocp-Apim-Subscription-Key en récupérant une clé pour un autre abonnement dans le portail. Sélectionnez Abonnements, puis ouvrez le menu contextuel (...) pour un autre abonnement. Sélectionnez Afficher/masquer les clés et copiez l’une des clés. Vous pouvez également regénérer les clés si nécessaire. Ensuite, dans la console de test, sélectionnez + Ajouter un en-tête pour ajouter un en-tête Ocp-Apim-Subscription-Key avec la nouvelle valeur de clé.
Sélectionnez Trace.
Si votre abonnement n’autorise pas déjà le suivi, vous êtes invité à l’activer si vous souhaitez suivre l’appel.
Vous pouvez également choisir d’envoyer la demande sans suivi.
Examiner les informations de suivi
Une fois l’appel terminé, accédez à l’onglet Trace dans la réponse HTTP.
Sélectionnez les liens suivants pour accéder aux informations de suivi détaillées : Entrant, Principal, Sortant, En cas d’erreur.
Entrant : affiche la demande d’origine reçue par le service Gestion des API de l’appelant et les stratégies appliquées à la demande. Par exemple, si vous avez ajouté des stratégies dans le Tutoriel : Transformer et protéger votre API, ces stratégies s’affichent ici.
Principal : affiche les demandes envoyées par le service Gestion des API au backend d’API et la réponse qu’il a reçue.
Sortant : affiche toutes les stratégies appliquées à la réponse avant son envoi à l’appelant.
En cas d’erreur : affiche les erreurs qui se sont produites pendant le traitement de la demande et les stratégies appliquées aux erreurs.
Conseil
Chaque étape indique également le temps écoulé depuis la réception de la demande par le service Gestion des API.
Sous l’onglet Message, l’en-tête ocp-apim-trace-location affiche l’emplacement des données de suivi dans le stockage d’objets blob Azure. Si nécessaire, accédez à cet emplacement pour récupérer le suivi. Les données de trace sont accessibles jusqu’à 24 heures.
Activer le suivi à l’aide de l’en-tête Ocp-Apim-Trace
Lorsque vous effectuez des demandes auprès de Gestion des API avec curl, un client REST tel que Postman ou une application cliente, activez le suivi en ajoutant les en-têtes de demande suivants :
- Ocp-Apim-Trace : définissez la valeur sur
true - Ocp-Apim-Subscription-Key : définissez la valeur sur la clé d’un abonnement avec suivi activé qui autorise l’accès à l’API
La réponse inclut l’en-tête Ocp-Apim-Trace-Location, avec une URL vers l’emplacement des données de suivi dans le stockage Blob Azure.
Pour plus d’informations sur la personnalisation des informations de suivi, consultez la stratégie trace.
Étapes suivantes
Dans ce didacticiel, vous avez appris à :
- Suivre un exemple d’appel
- Passer en revue les étapes du traitement des demandes
Passez au tutoriel suivant :