This page applies to Apigee and Apigee hybrid.
View Apigee Edge documentation.
Debug is a tool for troubleshooting and monitoring API proxies running on Apigee. The Debug tool lets you probe the details of each step through an API proxy flow. Apigee lets you collect debug data, which shows the entire request/response flow of your API proxies. This includes all request/response parameters along with transformations applied to them at policy execution time. This is important for debugging and troubleshooting during API proxy development and deployment.
Using Debug
Create and manage debug sessions using the Debug tool using the UI or API, as described in Using Debug. Alternatively, you can download debug sessions and view and analyze them offline, as described in Using Offline Debug.
Apigee Support use of Debug
Only customers can trigger a debug session, but Apigee Support can access non-deleted past debug sessions during the course of a support case to help troubleshoot proxy-specific issues.
Note the following:
- Apigee Support has read-only permission to Debug data.
- 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.
For Apigee hybrid users
If you are using Apigee hybrid, review the following sections.
Debug architecture
The following illustrates the process of creating a new debug session:
Debug data is persisted in the management plane for up to 24 hours.
Apigee hybrid requirements
This section lists important information for Apigee hybrid users.
Support for data residency
- If you have a newly created Apigee hybrid v1.13.1 org with data residency enabled, follow the steps in Using data residency with Apigee hybrid.
- Clocks on all Synchronizer nodes should be in sync and in UTC.
Older versions of Apigee hybrid do not support data residency.
Other requirements
- You must have the
apigee-udca
service account configured. See Specify configuration overrides. - Clocks on all Synchronizer nodes should be in sync and in UTC.