Using Offline Debug

Stay organized with collections Save and categorize content based on your preferences.

You're viewing Apigee X documentation.
View Apigee Edge documentation.

The Offline Debug tool lets you view and analyze "offline" debug sessions that were previously downloaded in the Debug view in the Proxy Editor. A saved debug session is essentially a "recording" of a debug session, and can be useful for cases where troubleshooting and further analysis is required. The UI for the Offline Debug tool is similar to the Debug view in the Proxy Editor.

To learn about the Debug Tool UI and on downloading debug sessions, see Using Debug.

New Proxy Editor

To view downloaded debug data using Offline Debug:

  1. Sign in to the Apigee UI.
  2. Select API Proxies from the main view.
  3. Select Develop > Offline Debug.

    The Offline Debug view displays:

    Offline
    Offline Debug view in new Proxy Editor

  4. To load data into the Offline Debug view, click the Open Debug Session button and select a previously downloaded offline debug session file in JSON format.

    Note: When you download a debug session in the Proxy Editor Debug view, the name of the download file has the form 'debug-{session ID}.json', where {session id} is the ID of the debug session. However, you can rename the file if you wish.

    The Apigee UI loads the debug file's data and displays a new row for the transaction in the left-hand panel.

    Offline
    Offline Debug view with debug file loaded.

  5. Click the row for the transaction in the left-hand panel to display a Gantt chart of the transaction in a Gantt chart.

    Gantt chart of transaction steps in right-hand pane.

From here, you can explore the debug session just as you would in the Debug view in the new Proxy Editor. See the section "Viewing the Gantt chart for a request and response."

Classic Proxy Editor

To view downloaded debug data using Offline Debug:

  1. Sign in to the Apigee UI.
  2. Select API Proxies from the main view.
  3. Select Develop > Offline Debug.

    The Offline Debug view displays:

    Offline
    Debug view

    Note the following regions of the Offline Debug view:

    • Debug file: Displays the request type. Use this area to navigate among the requests.
    • View Options: Displays configuration options, as described in Using Debug.
    • Debug Session Details: Displays details about the debug session.
    • Transactions Map: Shows the path of the request through the API proxy; this path is known as the transaction map; it shows which policies were encountered and indicates if any errors occurred during the execution of those policies.
    • Phase Details: Shows the request headers for the currently selected request.

    When viewing debug data in the Apigee UI, you can toggle various options such as whether to view policies that are disabled or variables and properties. For more information, see Debugging with the debug tool.

  4. To load data into the Offline Debug view, click the Choose File button in the left-hand pane of the Offline Debug tool and select a previously downloaded offline trace session file in JSON format.

    Offline
  Debug view

    Note: Do not use the Choose File button in the right-hand pane, as it does not accept JSON files.

    The Apigee UI loads the debug file's data and displays it.