How long does sosreport take

The sosreport command has a plugin structure and allows the user to enable and disable plugins and specify plugin options via the command line. Available plugins and their options may be listed by running the following command:. These options take comma-delimited lists of plugin names or may be specified multiple times. For example, to disable the amd and kvm plugins, use the following:.

Individual plugins may provide additional options that may be specified via the -k option. These options are listed in the same output as the listing of available plugins sosreport -l.

For example, to enable collection of container logs, use the following:. Options will specify whether they are boolean toggles or expect a string or integer. For boolean toggles, users may use True , on , or yes and False , off , or no interchangeably.

Some commands called by certain plugins may automatically trigger a change load a kernel module in the example above and are thus gated by default. If making these changes is acceptable for your environment, and you would like to have sosreport make them in order to collect the skipped commands, run sosreport like so:. By default sosreport will run up to 4 plugins in parallel in an effort to reduce total runtime.

This may cause memory contention or high CPU usage on certain systems depending on which plugins are being run and particularly if each of those plugins collects journal output. To reduce the number of simultaneous collections use the --threads option. For example, to run plugins one at a time, use the following:.

The sos package must be installed in order to run the sosreport command. You can check to see if the sos package is installed and whether there is any problems with the installation using the following command:. The rpm command may be used to install the package on any version of Red Hat Enterprise Linux:.

Note that each plugin has a default timeout of 5 minutes controllable by the timeout plugin option available to all plugins. Please allow enough time for this timeout threshold to be hit, and sosreport should automatically terminate that plugin's execution. In the event that this termination does not happen, use the option highlighted above. If an sosreport can not be completed at all for one reason or another, please see How to gather data from a Red Hat Enterprise Linux system for troubleshooting if the sosreport process goes to hung state?

Please see sosreport fails. What data should I provide in its place? For issue-specific guidance in the case of sosreport failure, please see Additional and alternative steps for gathering an sosreport for a Red Hat Enterprise Linux support case.

There are following ways to understand what a particular plugin does when its is executed through the sosreport command. Check the source of sos package that provides sosreport command. For a specific version of source code, see downloads section on Customer Portal. Check sos. For example, for plugin scsi there would be something similar to as shown below.

Generate the sosreport only with that particular plugin and check the files and directories and the output of the commands in the collected archive. Skip to primary navigation Skip to main content Skip to primary sidebar Skip to footer navigation.

This process may take a while to complete. No changes will be made to your system. Please enter your first initial and last name [geeklab]: Sandeep Please enter the case number that you are generating this report for [None]:. The command will normally complete within a few minutes on Red Hat Enterprise Linux 6. Older versions may take longer to complete. Depending on local configuration and the options specified in some cases the command may take longer to finish. If you are concerned about the run time of the sosreport command contact your Red Hat support representative for assistance.

Different versions use different compression schemes gz , bz2 , or xz. The file should be provided to your support representative normally as an attachment to an open case. If the collected sosreport is too big to upload to the case, it could be uploaded to Red Hat ftp site at dropbox. To avoid the need to enter user and account information interactively the command may be run in batch mode by use of the --batch option.

In this case user information is obtained from the system RHN configuration files:. The sosreport command has a modular structure and allows the user to enable and disable modules and specify module options via the command line.

To list available modules plug-ins use the following command:. For instance, to temporarily disable both the kvm and amd modules if broken :. Individual modules may provide additional options that may be specified via the -k option.

For example on Red Hat Enterprise Linux 4 and 5 installations the sos rpm module collects " rpm -Va " output by default. As this may be time-consuming the behavior may be disabled via:. Red Hat Enterprise Linux 4. If possible update your system to the sos package included in later releases however sysreports may still be submitted to Red Hat if needed What is a sysreport and how to run it in Red Hat Enterprise Linux?

The sos package in Red Hat Enterprise Linux 4 and 5 also includes the sysreport command. This is a symbolic link provided for backwards compatibility:. To use the original legacy version of the sysreport script on these installations use the sysreport. Otherwise you may encounter the issue documented in KCS