sos (son of sysreport)

Sos Project Home

The SOS project provides tools for gathering information and running

Although this project was begun by people in Red Hat's support organization, it is released under the GPL , with all Red Hat specific parts isolated in plugins so that it will be generally useful to others.

Contributors to this project are welcome, especially if you are interested in writing plugins or in helping make this tool useful across many linux distributions. All development and testing to date has occurred on Fedora Core 5, and contributors working with other distributions are welcome.

The first stage of the project, sosreport, has a first implementation, and is available now. If you maintain linux software, please consider delivering a plugin for sos that will gather the information needed to help troubleshoot or debug your application.

: This project will provide a number of tools, in the following areas:

1. System Information Gathering (released)

This application (sosreport) performs a function similar to what sysreport does now, but has a pluggable architecture that will allow the inclusion of sos plugins to be delivered with any package. These plugins can gather information needed for troubleshooting that package, provide the ability to turn on other debugging or reporting that is of interest for that package, provide some analysis to be done to notify the customer of improper configuration or operation, and integrate the reporting from the plugin with other system information.

Reports are provided in html. The report integrates reports from various plugins, along with the results of analysis performed by those plugins. In addition, future policy plugins may provide links in the output for additional operations, such as opening a ticket with a Support CRM system, submitting the system information to a web hosted tool for further analysis, or submitting the information for attachment to a ticket already open within a support CRM system.

2. Integration of additional debugging tools (future)

An API will be provided that allows delivery of additional tools which may be enabled and disabled through a simple unified interface by the end user. For example, we expect to provide scripts that will use sar, systemtap, enable performance counters, etc. For all tools that are enabled, reports will be included in subsequent system information reports and integrated in the heirarchical result navigation.

This will allow Support Organizations to easily walk the customer (by phone or email or chat) through a simple interface to enable the gathering of troubleshooting information specific to the problem being addressed.

3. Integration with Support CRM and other ticketing systems

The tools in the package will allow simplified interaction with Support CRM systems. Once system information is gathered, the customer will have an option to open an issue with support. Verification of entitlement for support and filing the ticket with the system information and problem description attached will be handled by policy plugins that can be customized for integration with different CRM systems.


sos is the international distress call, and also stands for "son of sysreport"