13.1. About sosreport

13.1. About sosreport
Prev	Chapter 13. Support Diagnostic Tools	Next

13.1.1. Configuring and Using sosreport

The sosreport utility collects information about a system such as hardware configuration, software configuration, and operational state. You can also use sosreport to enable diagnostics and analytical functions. To assist in troubleshooting a problem, sosreport records the information in a compressed file that you can send to a support representative.

13.1.1. Configuring and Using sosreport

If the sos package is not already installed on your system, use yum to install it.

Use the following command to list the available plugins and plugin options.

# sosreport –l
The following plugins are currently enabled:

acpid            acpid related information
anaconda         Anaconda / Installation information
.
.
.
The following plugins are currently disabled:

amd                Amd automounter information
cluster            cluster suite and GFS related information
.
.
.
The following plugin options are available:
apache.log             off gathers all apache logs
auditd.syslogsize      15 max size (MiB) to collect per syslog file
.
.
.

See the sosreport(1) manual page for information about how to enable or disable plugins, and how to set values for plugin options.

To run sosreport:

Enter the command, specifying any options that you need to tailor the report to report information about a problem area.
```
# sosreport [options ...]
```
For example, to record only information about Apache and Tomcat, and to gather all the Apache logs:
```
# sosreport -o apache,tomcat -k apache.log=on

sosreport (version 2.2)
.
.
.
Press ENTER to continue, or CTRL-C to quit.
```

Type Enter, and enter additional information when prompted.

Please enter your first initial and last name [email_address]: AName
Please enter the case number that you are generating this report for: case#

  Running plugins. Please wait ...

  Completed [55/55] ...      
Creating compressed archive...

Your sosreport has been generated and saved in:
  /tmp/sosreport-AName.case#-datestamp-ID.tar.xz

The md5sum is: checksum

Please send this file to your support representative.

sosreport saves the report as an xz-compressed tar file in /tmp.