viewing Apigee X documentation.
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.
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
By default, Apigee allows Apigee Support to use the Debug tool on your API proxies to provide support.
Note the following:
- Apigee Support has read-only permission to Debug data.
- Apigee Support may request that you run a trace to capture information about an issue, and that you provide the trace session ID or a link to the trace session so that Support may review the captured trace. Since saved trace sessions are valid for only 24 hours, we recommend that you download the trace 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.
The following illustrates the process of creating a new debug session:
Debug data is persisted in the management plane for up to 24 hours.
If you are using Apigee hybrid, before you can use debug you must be sure that the following are configured:
apigee-synchronizer(role: Apigee Synchronizer Manager)
apigee-udca(role: Apigee Analytics Agent)
For more information for hybrid v1.3, see Create service accounts, for your platform as follows:
- Google Kubernetes Engine (GKE)
- Anthos (GKE on-prem)
- Azure Kubernetes Service (AKS)
- Amazon Elastic Kubernetes Service (EKS)
- Google Kubernetes Engine on AWS (GKE on AWS)
- Enable synchronizer access
- Clocks on all Synchronizer nodes should be in sync and in UTC