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 :
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.
Les horloges de tous les nœuds de synchronisateurs doivent être synchronisées et à l'heure UTC.
Sauf indication contraire, le contenu de cette page est régi par une licence Creative Commons Attribution 4.0, et les échantillons de code sont régis par une licence Apache 2.0. Pour en savoir plus, consultez les Règles du site Google Developers. Java est une marque déposée d'Oracle et/ou de ses sociétés affiliées.
Dernière mise à jour le 2025/09/04 (UTC).
[[["Facile à comprendre","easyToUnderstand","thumb-up"],["J'ai pu résoudre mon problème","solvedMyProblem","thumb-up"],["Autre","otherUp","thumb-up"]],[["Difficile à comprendre","hardToUnderstand","thumb-down"],["Informations ou exemple de code incorrects","incorrectInformationOrSampleCode","thumb-down"],["Il n'y a pas l'information/les exemples dont j'ai besoin","missingTheInformationSamplesINeed","thumb-down"],["Problème de traduction","translationIssue","thumb-down"],["Autre","otherDown","thumb-down"]],["Dernière mise à jour le 2025/09/04 (UTC)."],[[["\u003cp\u003eThe Debug tool in Apigee and Apigee hybrid allows users to troubleshoot and monitor API proxies by providing detailed insights into each step of an API proxy flow.\u003c/p\u003e\n"],["\u003cp\u003eDebug data, which captures the entire request/response flow and transformations, is crucial for debugging during API proxy development and deployment.\u003c/p\u003e\n"],["\u003cp\u003eApigee Support can access past debug sessions to assist in troubleshooting proxy issues, although they have read-only permissions.\u003c/p\u003e\n"],["\u003cp\u003eFor Apigee hybrid v1.13.1 and later, the Debug tool is supported for new organizations with data residency enabled.\u003c/p\u003e\n"],["\u003cp\u003eDebug data is not available in real-time, and is saved for 24 hours.\u003c/p\u003e\n"]]],[],null,["# Debug overview\n\n*This page\napplies to **Apigee** and **Apigee hybrid**.*\n\n\n*View [Apigee Edge](https://docs.apigee.com/api-platform/get-started/what-apigee-edge) documentation.*\n\n| **Note:** For Apigee hybrid v1.13.1, the new data pipeline is supported for newly created Apigee hybrid organizations with [data residency](/apigee/docs/api-platform/get-started/drz-concepts) enabled. See [Configure hybrid to use the new data pipeline](/apigee/docs/hybrid/v1.13/data-collection-with-data-residency). For Hybrid 1.14 or later, the new data pipeline is the default for all Hybrid organizations regardless of whether or not data residency is enabled.\n\nDebug is a tool for troubleshooting and monitoring API proxies running on Apigee. The Debug tool\nlets you probe the details of each step\nthrough an API proxy flow.\nApigee lets you collect debug data, which shows the entire request/response flow of your\nAPI proxies. This includes all request/response parameters along with transformations applied to\nthem at policy execution time. This is important for debugging and troubleshooting during API proxy development and deployment.\n| In previous versions of Apigee, the Debug tool was referred to as the Trace tool.\n| **Terminology:** The terms *debug data* and *debug\n| session data* are used interchangeably.\n\nDebug data collection and transmission\n--------------------------------------\n\nApigee gateway nodes collect debug session data and cache it internally,\nbefore transmitting that data to the control plane in the Cloud. From there it\nis shared to the debug session UI, for operators to analyze.\n\nIf you use [Debug masking](/apigee/docs/api-platform/security/data-masking),\nApigee performs the masking in the gateway nodes, before transmitting the debug data to the\ncontrol plane.\n\nUsing Debug\n-----------\n\n\nCreate and manage debug sessions using the Debug tool using the UI or API, as described in\n[Using Debug](/apigee/docs/api-platform/debug/trace).\nAlternatively, you can download debug sessions and view and analyze them offline, as described in\n[Using Offline Debug](/apigee/docs/api-platform/debug/offline-trace).\n\nApigee Support use of Debug\n---------------------------\n\n\nOnly customers can trigger a debug session, but Apigee Support can access non-deleted past debug sessions\nduring the course of a support case to help troubleshoot proxy-specific issues.\n\n\nNote the following:\n\n- Apigee Support has read-only permission to Debug data.\n- Apigee Support may request that you run a debug to capture information about an issue, and that you provide the debug session ID or a link to the debug session so that Support may review the captured debug. Since saved debug sessions are valid for only 24 hours, we recommend that you download the debug session and attach it to the case opened with Support to enable offline viewing.\n\nFor Apigee hybrid users\n-----------------------\n\n| **Note:** For Apigee hybrid v1.13.1 and later, the Debug tool is supported for newly created Apigee hybrid organizations with [data residency](/apigee/docs/api-platform/get-started/drz-concepts) enabled. See [Analytics and debug data collection with data residency](/apigee/docs/hybrid/v1.13/data-collection-with-data-residency).\n\n\nIf you are using Apigee hybrid, review the following sections.\n\n### Debug architecture\n\nThe following illustrates the process of creating a new debug session:\n\n| **Note:** Because of the asynchronous nature of multiple pollings, debug data is not available in real time; instead, there is a slight delay.\n\nDebug data is persisted in the management plane for up to 24 hours.\n\n### Apigee hybrid requirements\n\nThis section lists important information for Apigee hybrid users.\n\n#### Support for data residency\n\n- If you have a newly created Apigee hybrid v1.13.1 org with [data residency enabled](/apigee/docs/api-platform/get-started/drz-concepts), follow the steps in [Using data residency with Apigee hybrid](/apigee/docs/hybrid/v1.13/using-data-residency-with-apigee-hybrid).\n- Clocks on all Synchronizer nodes should be in sync and in UTC.\n\nOlder versions of Apigee hybrid do not support data residency.\n\n#### Other requirements\n\n- You must have the `apigee-udca` service account configured. See [Specify configuration overrides](./install-create-overrides#specify-configuration-overrides).\n- Clocks on all Synchronizer nodes should be in sync and in UTC."]]
