Technical Tip: How to collect a debug bundle remotely

Traditionally, debug bundles were collected and stored on target machines by executing local commands. This is sometimes a time-consuming process.

To streamline this process, from Agent v7.11.2 or later, operators can collect and access debug bundles from target machines by carrying out actions from the Reveal web UI. This functionality is present on Windows, macOS, and Linux.

Note:

This requires the target machine's Reveal Agent to be running and able to communicate with the Reveal infrastructure.

Directions:

1. Go to 'Nodes", then navigate to the target machine's page through the active nodes or another filter.

2. Select the 'Perform action' button:

3. If a verbose debug bundle is required, please ensure the box is ticked for 'Collect a verbose debug bundle including profiling data'. Otherwise, proceed to step 5.
4. Select the "Request debug bundle" button. A request for a debug bundle will now be sent to the agent on the target machine.

5. Navigate to 'Action log' (circled in red in the screenshot below), to view the status of the bundle collection and download the debug bundle.

6. Select the relevant request bundle event.
7. The debug bundle can be downloaded by expanding 'Content', and selecting 'Action result' (circled in red in the screenshot below).

Note:

The time it takes for the debug bundle to become downloadable from the web UI can vary depending on the size of the bundle file and the speed of the network connection.

Requesting bundles exceeding 200MB will result in the timeout error shown below: