GatherLogs utility

Smart Update Manager (SUM) provides the gatherlogs utility to simplify troubleshooting. The utility collects SUM configuration files, SUM application logs, SUM service logs, installer logs, SUT logs, AMS logs, database files, and optional OS diagnostic information into a single support bundle.

During collection, gatherlogs copies files to a current working directory, removes sensitive information of the copied SUM configuration files, SUM application logs, and SUM service logs, and then packages the copied files. Gatherlogs does not modify the original files on the host.

IMPORTANT
The current implementation includes the SUM database by default. Database files, SUT logs, AMS logs, and OS diagnostic files may still contain sensitive information. Review the support bundle accordance with your organization's security policy before sharing it outside your environment. If support does not require the database, run gatherlogs with --include-db=false.

Gatherlogs executable locations

OS Installed command
Windows %ProgramFiles%\SUM\bin\x64\gatherlogs.exe
Linux /opt/sum/bin/x64/gatherlogs

On Linux, the RPM package also creates a /usr/local/bin/gatherlogs symbolic link when the gatherlogs binary is included in the package.

Default gatherlogs output location

By default, gatherlogs writes the support bundle archive to the current working directory where the command is run. To write the archive to a different location, use the --output-dir option.

Common commands

Table 1. Collect support bundle
OS Command

Windows PowerShell

.\gatherlogs.exe --verbose

Linux bash

sudo gatherlogs --verbose
Table 2. Save to a custom location
OS Command

Windows PowerShell

.\gatherlogs.exe --output-dir "$env:TEMP\SUM\support-bundles" --verbose

Linux bash

sudo gatherlogs --output-dir /var/tmp/sum/support-bundles --verbose

Collect logs for a specific time range

By default, gatherlogs collects logs from the previous 360 hours. The following example limits collection to the previous 10 days: sudo gatherlogs --since 240h --verbose

Exclude OS diagnostics in restricted environments

Use the --no-os-commands option to skip OS diagnostic commands.

sudo gatherlogs --no-os-commands --verbose

Additional options

Option Description
--output-dir <path>

Writes the support bundle archive to the specified directory
--install-dir <path>

Uses the specified SUM installation directory when locating configuration and database files
--since <duration>

Includes logs newer than the specified duration and the default value is 360 hours
--include-db=false

Excludes the SUM database and database backups from the support bundle
--no-os-commands

Skips OS diagnostic command collection
--verbose

Prints detailed collection progress

Support bundle naming convention

Gatherlogs generates archive files using the following format: 
text
SUM_Gatherlogs_<hostname>_<YYYY-MM-DD_HH-MM-SS>_<os>
The generated archive uses the following formats:
OS Archive format
Windows .zip
Linux .tar.gz