How to capture a Syslog-ng Store Box debug bundle (4233995)

This article contains the information necessary to capture a successful Debug Bundle from within Syslog-ng Store Box. In addition, this article contains the information necessary to start Syslog-ng Store Box in debug mode to capture live events which are included in a successfully created debug bundle.

When opening a new SR,  a case (see KB article “What to include when escalating a case” Solution ID 264290), it is imperative that a current, successfully created, debug bundle is included.

A successfully created debug bundle will contain logs, data, and other pertinent information necessary to aid in diagnosing errors and/or issues within the Syslog-ng Store Box environment.

First steps

Open a browser and navigate to the Web GUI portal for the Syslog-ng Store Box (SSB) from which a debug bundle is going to be created.

After navigating to the Web GUI, log in to the SSB.

Once logged into the SSB locate the "Basic Settings" option on the top left of the Web GUI and left click on it. The Basic Settings menu list will expand below the "Basic Settings" option, locate the "Troubleshooting" option in this expanded menu and left click on it. This will load a new page with several troubleshooting tools.

Towards the bottom of the page locate "System debug" and left click on the opposite facing arrows on the right-hand side of the "System debug" menu ribbon to expand the "System debug" options if it has not already been expanded.

If the System debug section is missing go to AAA | Access Control | select edit next to the auth-view  and check system debug and click save. Next select edit next to the auth-write  and check system debug and click save. 

Creating a current debug bundle

To create and save a debug bundle of the current state of the SSB, left click on the option "Collect and save current system state info". Upon left clicking this option the SSB will automatically enable debug mode, create a debug bundle, and, display a window in which a location can be designated for the debug bundle to be saved to. After choosing a location to save the debug bundle to, the debug bundle will be saved at which time it can be uploaded into the SR.

Enabling Debug Mode for Live Event Capture

To enable debug mode, which allows for the capture of live events for such purposes as the reciprocation of steps that in turn may cause an error, simply left click the "Start" option, instead of the "Collect and save current system state info" option. This will launch the SSB into debug mode where all live events will be captured until the debug mode is stopped.

To stop debug mode, simply left click the "Stop" option under System debug which can be found directly next to the "Start" option, and below the "Collect and save current system state info" option.

Once stopped, the SSB will compile the information gathered during the time in which debug mode was enabled.

To save the additional debug info that was captured, simply left click on the "Save collected debug info" option below the "Start" and "Stop" option in the "System debug" menu list of options. A new window will launch in which a location can be designated for the additional debug info  to be saved to. After choosing a location to save the additional debug info to, the additional debug info will be saved at which time it can be uploaded into the SR.