Gathering Appliance Diagnostics
A complete set of event broker diagnostic files and debug logs are sometimes required for Solace to determine the root cause of an operational problem.
The gather diagnostics command automatically gathers and packages the information. When the command completes, the retrieved files and logs are saved as a single compressed file, and the name of this diagnostics file and its location are printed to the screen.
A File Transfer User Account is required to access the generated diagnostic file. For more information about account creation see Configuring File Transfer User Accounts
You can use third-party applications, such as Filezilla or WinSCP (Windows), or command-line utilities, such as SCP or FTP to access the compressed files to transfer the files between the event broker and another location, such as your computer. To do this, enter the username and password of the file transfer account as credentials in the third-party application to access the event broker.
To gather event broker diagnostics, enter the following commands:
solace> enable solace# admin solace(admin)# gather-diagnostics [days-of-history <days>]
Where:
days-of-history <days> specifies the number of days to gather diagnostics data for. By default, diagnostic data is gathered for one day.
Running gather-diagnostics via legacy SEMP gather-diagnostics completes. Running gather-diagnostics normally takes several minutes. If this is a problem, we recommend that you run gather-diagnostics via the Solace CLI.
Gathering Diagnostics from the Linux host shell
If the Solace CLI is not available, you can run the gather-diagnostics command from the Linux host shell, provided that you have root access. This operation can also be performed by users with the sysadmin accounts. For more information, see Configuring Multiple Linux Shell Users.
gather-diagnostics [num-days]
Where:
num-days is the number of previous days diagnostic data to collect. The default is 1.
If you do not have root access, you can use sudo to run the gather‑diagnostics command from the Linux host shell using the support user account:
sudo gather-diagnostics [num-days]
If you are using a software event broker, you can gather diagnostics from the Linux host shell using the sysadmin user account:
sudo su -
gather-diagnostics-host [-d <num-days>]
Where:
-d <num-days> specifies the number of days to gather diagnostics data for. By default, diagnostic data is gathered for one day.