[MIR] sosreport

Bug #1206106 reported by Adam Stokes on 2013-07-29
This bug affects 11 people
Affects Status Importance Assigned to Milestone
sosreport (Ubuntu)

Bug Description

Availability: Package is synced from Debian and builds for amd64, armhf, x86, and powerpc

Rationale: This is a very extensive set of data collection routines that are necessary to further troubleshoot and fix problems. These problems can range from configuring a mail server to verifying a node in the cloud (lxc, ec2, rackspace, azure) is configured and working as intended.

Security: There have been no security advisories released for this application.

Quality assurance:

Running sosreport with defaults where it attempts to collect data on all plugins it knows about for the distribution:

# sudo sosreport --batch

Once complete a report is generated and accessible in /tmp/sosreport*tar.gz

There are no outstanding bugs in Debian or Launchpad for this application.

This package passes unittests during build phase, does not deal with exotic hardware, and is maintained by me (Adam Stokes) in both Debian and Ubuntu.

UI standards: (generally only for user-facing applications)

sosreport is translated the standard gettext tools.


Only dependency is python 2.7 and is satisfiable in main.

Standards compliance: The package passes both Debian Policy and FHS

Maintenance: The package must have an acceptable level of maintenance corresponding to its complexity:

   This command line application requires minimal maintenance and may only see increase in development activity when new plugins are added.

Background information:

    Both end-users and enterprise customers run into issues from time to time and trying to explain the exact issue can be difficult. Sosreport allows those support reprasentatives to walk the end user through collecting the right system data so that it may be diagnosed properly and efficiently. It also reduces the amount of back and forth that may occur when a support engineer is attempting to narrow down the problem. In my professional experience sosreport has been used by thousands of customers ranging from small businesses to corporations that have 4000 or more employees to support. Sosreport is an invaluable tool when it comes to properly tracking down and fixing issues and is on its way to becoming the de-facto tool for support engineers. It should also be noted that sosreport plays a huge part in cloud environments because of its non-interactive options to collecting specific data, for example, clients wishing to debug an openstack node could have sosreport capture just the data specific to openstack with:

# sosreport -o openstack --batch

Thank you

Changed in sosreport (Ubuntu):
importance: Undecided → High
Launchpad Janitor (janitor) wrote :

Status changed to 'Confirmed' because the bug affects multiple users.

Changed in sosreport (Ubuntu):
status: New → Confirmed
Michael Terry (mterry) wrote :

Why does this need to be in main? Like, is it going to be seeded on the server images?

Adam Stokes (adam-stokes) wrote :

For cloud images it would require to be seeded

David Medberry (med) wrote :

Yes, what adam-stokes said, we'd like to get this seeded in cloud-images. It makes the support/debugging process much more straight-forward.

David Medberry (med) wrote :

and, moreover, to get into cloud-images in needs to be in main (just trying to be VERY clear)

Michael Terry (mterry) wrote :

Seems mostly fine. Well maintained, runs its tests, clean packaging. Just one paperworky thing: please add a team bug subscriber. I get that you maintain it mostly yourself, Adam, but we like to have a team contact.

Changed in sosreport (Ubuntu):
status: Confirmed → Incomplete
Adam Stokes (adam-stokes) wrote :


Added our Canonical engineering team to the subscriber list as this can be the main point of contact for any technical and support related requests.


Changed in sosreport (Ubuntu):
status: Incomplete → Confirmed
Michael Terry (mterry) wrote :

Looks good, thanks!

Changed in sosreport (Ubuntu):
status: Confirmed → Fix Committed
Adam Conrad (adconrad) wrote :

Seeded to supported while people argue about if it does or doesn't belong on any install media and if it does or doesn't need to be ported to python3 before that does or doesn't happen.

Changed in sosreport (Ubuntu):
status: Fix Committed → Fix Released
Adam Conrad (adconrad) wrote :

Override component to main
sosreport 3.0-1 in saucy: universe/misc -> main
sosreport 3.0-1 in saucy amd64: universe/admin/optional/100% -> main
sosreport 3.0-1 in saucy armhf: universe/admin/optional/100% -> main
sosreport 3.0-1 in saucy i386: universe/admin/optional/100% -> main
sosreport 3.0-1 in saucy powerpc: universe/admin/optional/100% -> main
Override [y|N]? y
5 publications overridden.

To post a comment you must log in.
This report contains Public information  Edit
Everyone can see this information.

Other bug subscribers