Présentation de l'outil Debug

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

Consultez la documentation d'Apigee Edge.

Debug est un outil permettant de dépanner et de surveiller les proxys d'API exécutés sur Apigee. L'outil Debug vous permet de vérifier les détails de chaque étape via un flux de proxy d'API. Apigee vous permet de collecter des données de débogage, qui présentent l'intégralité du flux de requêtes/réponses de vos proxys d'API. Cela inclut tous les paramètres de requête/réponse, ainsi que les transformations qui leur sont appliquées au moment de l'exécution de la règle. Cette étape est importante pour le débogage et le dépannage pendant le développement et le déploiement du proxy d'API.

Utiliser l'outil Debug

Créez et gérez des sessions de débogage à l'aide de l'outil Debug depuis l'interface utilisateur ou l'API, comme décrit dans la section Utiliser l'outil Debug. Vous pouvez également télécharger des sessions de débogage, et les afficher et les analyser hors connexion, comme décrit dans la page Utiliser Offline Debug.

Compatibilité d'Apigee avec l'utilisation de Debug

Seuls les clients peuvent déclencher une session de débogage, mais l'assistance Apigee peut accéder aux sessions de débogage non supprimées pendant une demande d'assistance afin de résoudre les problèmes spécifiques au proxy.

Veuillez noter les points suivants :

  • L'assistance Apigee est autorisée à accéder en lecture seule aux données de Debug.
  • L'assistance Apigee peut vous demander d'exécuter un débogage pour capturer des informations sur un problème, et de fournir l'ID de session de débogage ou un lien vers la session de débogage afin que l'assistance puisse examiner le débogage capturé. Étant donné que les sessions de débogage enregistrées ne sont valides que pendant 24 heures, nous vous recommandons de télécharger la session de débogage et de l'associer à la demande ouverte auprès de l'assistance pour activer l'affichage hors connexion.

Pour les utilisateurs d'Apigee hybrid

Si vous utilisez Apigee Hybrid, consultez les sections suivantes.

Architecture de l'outil Debug

Le processus suivant illustre le processus de création d'une session de débogage :

Vue d'ensemble d'une requête de démarrage d'une session de débogage : 1. Vous lancez une requête pour démarrer une session de débogage, à l'aide de l'interface utilisateur ou de l'API. 2. Le plan de gestion émet une demande de création de session de débogage au plan d'exécution à l'aide du modèle Pub/Sub. 3. Le synchronisateur, qui s'abonne aux notifications de session de débogage, propage les requêtes de création aux processeurs de messages. 4. Les processeurs de messages collectent les données de débogage et les transmettent vers un pod de collecte de données. 5. fluentd écrit immédiatement les données de débogage dans le système de fichiers du pod. 6. L'UDCA interroge le système de fichiers du pod à la recherche de nouveaux fichiers de données. 7. Lorsqu'il trouve un nouveau fichier de données, l'UDCA l'importe dans le service UAP. 8. Vous pouvez ensuite accéder aux données via les services Apigee tels que l'interface utilisateur d'Apigee hybrid ou les API Apigee.

Les données de débogage sont conservées dans le plan de gestion pendant 24 heures au maximum.

Configuration requise pour Apigee hybrid

Cette section présente des informations importantes pour les utilisateurs d'Apigee Hybrid.

Compatibilité avec la résidence des données

Les anciennes versions d'Apigee Hybrid ne sont pas compatibles avec la résidence des données.

Autres conditions requises

  • Vous devez avoir configuré le compte de service apigee-udca. Consultez la section Spécifier des remplacements de configuration.
  • Les horloges de tous les nœuds de synchronisateurs doivent être synchronisées et à l'heure UTC.