O Debug é uma ferramenta de solução de problemas e monitoramento de proxies de API em execução na Apigee. A ferramenta Debug permite que você examine os detalhes de cada etapa por meio de um fluxo de proxy da API.
A Apigee permite coletar dados de depuração, que mostram todo o fluxo de solicitação/resposta dos
proxies da API. Isso inclui todos os parâmetros de solicitação/resposta e as transformações aplicadas a
eles no tempo de execução da política. Isso é importante para a depuração e a solução de problemas durante o desenvolvimento e a implantação do proxy de API.
Como usar a depuração
Crie e gerencie sessões de depuração usando a ferramenta Debug usando a IU ou a API, conforme descrito em Como usar o Debug.
Também é possível fazer o download de sessões de depuração, visualizar e analisá-las off-line, conforme descrito em
Como usar o Debug Off-line.
Uso do Debug do suporte da Apigee
Somente os clientes podem acionar uma sessão de depuração, mas o suporte da Apigee pode acessar sessões de depuração anteriores não excluídas
durante um caso de suporte para ajudar a resolver problemas específicos do proxy.
Observações:
O suporte da Apigee tem permissão somente leitura aos dados do Debug.
O suporte da Apigee pode solicitar que você execute uma depuração para obter informações sobre um
problema e que você forneça o ID da sessão de depuração ou um link para a sessão de depuração. Assim, o suporte pode revisar a depuração obtida. Como as sessões de depuração salvas são válidas por
apenas 24 horas, é recomendável fazer o download dela e anexá-la ao
caso aberto com suporte para ativar a visualização off-line.
Para usuários da Apigee híbrida
Se você estiver usando a Apigee híbrida, leia as seções a seguir.
Arquitetua do Debug
O exemplo a seguir ilustra o processo de criação de uma nova sessão de depuração:
Os dados de Debug são mantidos no plano de gerenciamento por até 24 horas.
Requisitos da Apigee híbrida
Esta seção lista informações importantes para usuários da Apigee híbrida.
[[["Fácil de entender","easyToUnderstand","thumb-up"],["Meu problema foi resolvido","solvedMyProblem","thumb-up"],["Outro","otherUp","thumb-up"]],[["Difícil de entender","hardToUnderstand","thumb-down"],["Informações incorretas ou exemplo de código","incorrectInformationOrSampleCode","thumb-down"],["Não contém as informações/amostras de que eu preciso","missingTheInformationSamplesINeed","thumb-down"],["Problema na tradução","translationIssue","thumb-down"],["Outro","otherDown","thumb-down"]],["Última atualização 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."]]
