Afficher les données d'un message avec la vue Debug

Cette page s'applique à Apigee et à Apigee hybrid.

Consultez la documentation d' Apigee Edge.

Points abordés

Dans ce tutoriel, vous allez apprendre à effectuer les opérations suivantes :

• Consulter les en-têtes et le contenu du corps de la réponse.
• Afficher les messages d'erreur.

Prérequis

Avant de commencer ce tutoriel, procédez comme suit :

• Assurez-vous que curl est installé sur votre ordinateur pour effectuer des appels d'API à partir de la ligne de commande.
• Suivez les étapes de la section Avant de commencer.
• Ajoutez une règle SpikeArrest à votre proxy. La règle SpikeArrest est une règle qui limite le nombre de requêtes pouvant être envoyées à votre proxy d'API. Votre proxy doit comporter au moins une règle.

Afficher les données du message

La vue Debug de l'éditeur de proxys Apigee vous permet d'afficher les en-têtes, les variables, les objets et d'autres détails tels que le temps de réponse dans le flux de requêtes et de réponses du proxy d'API. La vue Debug vous permet également de voir comment une requête ou une réponse change lorsqu'elle est traitée par un proxy d'API. Pour obtenir une description plus détaillée de la vue Debug, consultez Utiliser la vue Debug.

Cette page explique comment utiliser la vue Debug pour voir ce qui se passe lorsque le taux de la règle SpikeArrest est dépassé.

Remarque : L'outil Debug est disponible dans la console Google Cloud et dans l'UI classique. Certaines actions de débogage peuvent être effectuées à l'aide de l'API, comme décrit dans les onglets suivants. Les options de la console Google Cloud sont les suivantes : Debug v2 (nouveau) et Debug v1 (publié le 01/07/2022). Vous pouvez basculer entre les versions de l'outil de débogage dans la console Google Cloud et l'UI classique.

Console Apigee Cloud

Déboguer v2 (nouveau)

Pour utiliser la vue "Debug" dans l'interface utilisateur de la console Cloud afin de voir ce qui se passe lorsque le taux de la règle SpikeArrest est dépassé :

1. Dans la console Google Cloud , accédez à la page Développement de proxys > Proxys d'API.

   Accéder aux proxys d'API

2. Assurez-vous que le nom de votre organisation est sélectionné dans le sélecteur de projet du volet de la console  Google Cloud . Le nom de l'organisation est identique à celui de votre projet Google Cloud.
3. Cliquez sur le nom du proxy d'API que vous souhaitez déboguer.
4. Cliquez sur l'onglet Développer :
5. Cliquez sur la règle Règles > SpikeArrest.
6. Dans le volet "Modifier", remplacez Rate par 1pm.
7. Cliquez sur Enregistrer.Cela vous permettra d'afficher les appels d'API ayant réussi et ceux ayant échoué (au-delà de la limite).
8. Déployez le proxy mis à jour.
9. Cliquez sur l'onglet Débogage.
10. Cliquez sur Démarrer la session de débogage.

    Dans la boîte de dialogue :

    1. Sélectionnez l'environnement dans lequel vous souhaitez exécuter la session de débogage.

    2. (Facultatif) Dans la liste Filtre, sélectionnez un filtre à appliquer à toutes les transactions de la session de débogage que vous créez. La valeur par défaut est None (All transactions) (Aucun), qui inclut toutes les transactions des données de débogage.

       Pour plus d'informations sur l'utilisation des filtres, consultez Utiliser des filtres dans une session de débogage. Pour en savoir plus sur les filtres intégrés, consultez Utiliser des filtres prédéfinis.

    3. Cliquez sur Démarrer.

11. Appelez à nouveau le proxy d'API à l'aide de curl (ou avec l'URL dans un navigateur Web) plusieurs fois jusqu'à ce que vous voyiez au moins une réponse 200 et une réponse 429 dans le volet Transactions.

    
    Remarque : Le code d'état HTTP pour le dépassement de la limitation du débit est 429 Too many requests.

12. Cliquez sur une transaction 429. Dans le volet Transaction map (Carte des transactions), un schéma de flux s'affiche, y compris une règle SpikeArrest avec une icône d'erreur.

    

13. Cliquez sur l'icône Erreur. Le volet Propriétés de l'erreur s'affiche.

    

Vous pouvez cliquer sur les boutons Précédent et Suivant pour vous déplacer entre les étapes du flux et afficher les détails de chaque étape.

Pour télécharger l'intégralité de la session de débogage en un seul document, cliquez sur Télécharger la session. Une session de débogage est supprimée dans les 24 heures suivant sa fin. Par conséquent, si vous souhaitez afficher la session au-delà de cette période, vous devez la télécharger avant.

Déboguer v1

1. Dans l'onglet Développer du proxy d'API, définissez à nouveau le paramètre <Rate> de la règle SpikeArrest sur 1pm, puis enregistrez le proxy. Cela permettra d'afficher les appels d'API ayant réussi et ceux ayant échoué (au-delà de la limite).
2. Dans l'éditeur de proxy, cliquez sur l'onglet Debug.
3. Cliquez sur Start Debug Session (Démarrer la session Debug).

Dans la boîte de dialogue, effectuez les étapes suivantes :

1. Sélectionnez l'environnement dans lequel vous souhaitez exécuter la session de débogage.
2. (Facultatif) Dans la liste déroulante Filter (Filtre), sélectionnez un filtre à appliquer à toutes les transactions de la session de débogage que vous créez. La valeur par défaut est None (All transactions) (Aucun), qui inclut toutes les transactions des données de débogage.

   Pour plus d'informations sur l'utilisation des filtres, consultez la section Utiliser des filtres dans une session de débogage. Pour plus d'informations sur les filtres intégrés, consultez la section Utiliser des filtres prédéfinis.

3. Cliquez sur Démarrer.

4. Appelez à nouveau le proxy d'API à l'aide de curl (ou avec l'URL dans un navigateur Web) plusieurs fois jusqu'à ce que vous voyiez au moins une réponse 200 et une réponse 429 dans le volet de gauche.

   

   Remarque : Le code d'état HTTP pour le dépassement de la limitation du débit est 429 Too many requests.
5. Cliquez sur la transaction 429 dans le volet de gauche. Un diagramme de Gantt s'affiche pour la transaction dans le volet de droite.

   

   Notez qu'il existe une ligne pour la règle SpikeArrest, qui s'affiche avec une icône d'erreur.

6. Cliquez sur la ligne intitulée Error (Erreur). Les détails de l'erreur s'affichent à droite du graphique. L'image ci-dessous montre la section Properties (Propriétés) des détails de l'erreur :

   

Vous pouvez cliquer sur les boutons Retour et Suivant sous le graphique de Gantt pour vous déplacer entre les étapes du flux et afficher les détails de chacune d'elles.

Pour télécharger l'intégralité de la session de débogage en un seul document, cliquez sur Télécharger la session. Une session de débogage est supprimée dans les 24 heures suivant sa fin. Par conséquent, si vous souhaitez afficher la session au-delà de cette période, vous devez la télécharger avant.

UI classique

1. Dans l'onglet Développer du proxy d'API, définissez à nouveau le paramètre <Rate> de la règle SpikeArrest sur 1pm, puis enregistrez le proxy. Cela permettra d'afficher les appels d'API ayant réussi et ceux ayant échoué (au-delà de la limite).
2. Dans l'éditeur de proxy, cliquez sur l'onglet Debug.
3. Sous Démarrer une session de débogage, sélectionnez l'environnement dans lequel votre proxy est déployé.
4. Cliquez sur Start Debug Session (Démarrer la session Debug).

5. Appelez à nouveau le proxy d'API à l'aide de curl (ou de l'URL dans un navigateur Web) jusqu'à ce que vous voyiez au moins une réponse 200 et une réponse 429 dans le volet Transactions Debug.

   curl -v https://YOUR_ENV_GROUP_HOSTNAME/my-proxy

   où YOUR ENV_GROUP_HOSTNAME est le nom d'hôte du groupe d'environnements. Consultez la page Rechercher le nom d'hôte du groupe d'environnements.

   Une réponse 200 et une réponse 429 sont présentées ci-dessous.

   

   Remarque : Le code d'état HTTP par défaut pour le dépassement de la limitation du débit est 429 Too many requests.

   Si vous souhaitez que le code d'état soit différent (500, par exemple) pour toutes les règles SpikeArrest utilisées dans une organisation, une propriété doit être définie sur l'organisation. Si vous êtes un client Cloud, contactez Google Cloud Customer Care pour définir cette propriété.

6. Cliquez sur la transaction 200 dans le volet Transactions de gauche. Les détails de Debug sont chargés dans la fenêtre principale sous Transaction Map, qui affiche un schéma de requête/réponse. L'icône SpikeArrest se trouve dans le flux de requêtes.
7. Dans le schéma de flux, cliquez sur l'icône circulaire dans la réponse, située le plus à droite (comme le montre le schéma suivant).

   Le volet Phase Details (Détails de la phase) affiche les données disponibles à ce stade du flux. Si vous faites défiler ce volet, les en-têtes de réponse HTTP et le contenu du corps s'affichent.

8. Examinons maintenant une erreur dans Debug.

   Cliquez sur la transaction 429 dans le volet "Transactions". Dans la fenêtre de l'éditeur principal, vous voyez un schéma de flux contenant des éléments dans la requête uniquement, y compris une icône SpikeArrest avec un point d'exclamation rouge indiquant une erreur.

   Cliquez sur l'icône d'erreur en forme de tube située à droite de l'icône SpikeArrest, puis examinez les détails de violation des arrêts de pics dans le volet Détails de la phase.

   

Vous pouvez cliquer sur les boutons Retour et Suivant dans le schéma de flux pour déplacer des points dans le flux et afficher les détails de débogage.

Si vous souhaitez voir l'intégralité de la session Debug sous forme de document unique, téléchargez celui-ci en cliquant sur Télécharger la session Debug.

Pour en savoir plus, consultez la page Utiliser la vue Debug.