Sos is an extensible, portable, support data collection tool primarily aimed at Linux distributions and other UNIX-like operating systems.
This project is hosted at:
For the latest version, to contribute, and for more information, please visit the project pages or join the mailing list.
To clone the current main (development) branch run:
git clone git://github.com/sosreport/sos.git
Please report bugs via the mailing list or by opening an issue in the GitHub Issue Tracker
The SoS project has rooms in Matrix and in Libera.Chat.
Matrix Room: #sosreport:matrix.org
Libera.Chat: #sos
These rooms are bridged, so joining either is sufficient as messages from either will appear in both.
The Freenode #sos room is no longer used by this project.
The sos-devel list is the mailing list for any sos-related questions and discussion. Patch submissions and reviews are welcome too.
Patches can be submitted via the mailing list or as GitHub pull requests. If
using GitHub please make sure your branch applies to the current main branch as a
'fast forward' merge (i.e. without creating a merge commit). Use the git rebase command to update your branch to the current main if necessary.
Please refer to the contributor guidelines for guidance on formatting patches and commit messages.
Before sending a pull request, it is advisable to check your contribution
against the flake8 linter, the unit tests, and the stage one avocado test suite:
# from within the git checkout
$ flake8 sos
$ nosetests -v tests/unittests/
# as root
# PYTHONPATH=tests/ avocado run --test-runner=runner -t stageone tests/{cleaner,collect,report,vendor}_tests
Note that the avocado test suite will generate and remove several reports over its execution, but no changes will be made to your local system.
All contributions must pass the entire test suite before being accepted.
User and API documentation is automatically generated using Sphinx and Read the Docs.
To generate HTML documents locally, install dependencies using
pip install -r requirements.txt
and run
sphinx-build -b html docs <destination dir>
For more in-depth information on the project's features and functionality, please see the GitHub wiki.
If you are interested in contributing an entirely new plugin, or extending sos to support your distribution of choice, please see these wiki pages:
To help get your changes merged quickly with as few revisions as possible please refer to the Contributor Guidelines when submitting patches or pull requests.
You can simply run from the git checkout now:
$ sudo ./bin/sos report
The command sosreport is still available, as a legacy redirector,
and can be used like this:
$ sudo ./bin/sosreport
To see a list of all available plugins and plugin options, run
$ sudo ./bin/sos report -l
To install locally (as root):
# python3 setup.py install
Fedora/RHEL users install via dnf:
# dnf install sos
Debian users install via apt:
# apt install sosreport
Ubuntu (14.04 LTS and above) users install via apt:
# sudo apt install sosreport
# snap install sosreport --classic
