[sru] sos upstream 4.3

Bug #1960996 reported by nikhil kshirsagar
16
This bug affects 1 person
Affects Status Importance Assigned to Milestone
sosreport (Ubuntu)
Fix Released
Medium
Eric Desrochers
Bionic
Fix Released
Medium
nikhil kshirsagar
Focal
Fix Released
Medium
nikhil kshirsagar
Impish
Fix Released
Medium
nikhil kshirsagar
Jammy
Fix Released
Medium
Eric Desrochers

Bug Description

[IMPACT]

The sos team is pleased to announce the release of sos-4.3. This release includes a number of quality-of-life changes to both end user experience and for contributors dealing with the plugin API.

[TEST PLAN]

Documentation for Special Cases:
https://wiki.ubuntu.com/SosreportUpdates

[WHERE PROBLEMS COULD OCCUR]

* Problem found and fixed during the packaging process:

 ** sos-help module wasn't part of the build process
 ** sos-help man page wasn't also not part of the build process nor mention in main sos man page

Bug:
https://github.com/sosreport/sos/issues/2860

Both commits of PR need to be part of 4.3 Ubuntu package:
https://github.com/sosreport/sos/pull/2861

Known issue:
https://bugs.launchpad.net/ubuntu/+source/sosreport/+bug/1962733

[OTHER INFORMATION]

Regression could occur at core functionality, which may prevent sos (or its subcommand to work. I consider this regression type as 'low'. That is generally well tested, and we would find a problem at an early stage during the verification phase if it is the case.

On the other end, regression could happen and are some kind of expected at plugins levels. As of today, sos has more than 300 plugins. It is nearly impossible to test them all.

If a regression is found in a plugin, it is rarely affecting sos core functionalities nor other plugins. So mainly the impact would be limited to that plugin. The impact being that the plugin can't or partially can collect the information that it is instructed to gather.

A 3rd party vendor would then ask user/customer to collect the information manually for that particular plugins.

Plugins are segmented by services and/or applications (e.g. openstack_keystone, bcache, system, logs, ...) in order to collect things accordingly to the plugin detected or intentionally requested for.

Sosreport plugins philosophy is to (as much as possible) maintain backward compatibility when updating a plugin. The risk that an ancient version of a software has been dropped, is unlikely, unless it was intended to be that way for particular reasons. Certain plugin also support the DEB installation way and the snap one (MAAS, LXD, ...) so all Ubuntu standard installation types are covered.

Release note:
https://github.com/sosreport/sos/releases/tag/4.3

Eric Desrochers (slashd)
Changed in sosreport (Ubuntu Jammy):
assignee: nobody → Eric Desrochers (slashd)
importance: Undecided → Medium
status: New → In Progress
tags: added: seg sts
Revision history for this message
Eric Desrochers (slashd) wrote :

Found one bug that I have reported upstream with regard to sos.help module
https://github.com/sosreport/sos/issues/2860

Revision history for this message
Eric Desrochers (slashd) wrote :

Uploaded in Jammy with a quilt patch to fix setup.py (see comment #1)

Eric Desrochers (slashd)
Changed in sosreport (Ubuntu Impish):
assignee: nobody → nikhil kshirsagar (nkshirsagar)
Changed in sosreport (Ubuntu Focal):
assignee: nobody → nikhil kshirsagar (nkshirsagar)
Changed in sosreport (Ubuntu Bionic):
assignee: nobody → nikhil kshirsagar (nkshirsagar)
importance: Undecided → Medium
Changed in sosreport (Ubuntu Focal):
importance: Undecided → Medium
Changed in sosreport (Ubuntu Impish):
importance: Undecided → Medium
Revision history for this message
Launchpad Janitor (janitor) wrote :

This bug was fixed in the package sosreport - 4.3-1ubuntu1

---------------
sosreport (4.3-1ubuntu1) jammy; urgency=medium

  * New 4.3 upstream. (LP: #1960996)

  * For more details, full release note is available here:
    - https://github.com/sosreport/sos/releases/tag/4.3

  * New patches:
    - d/p/0002-fix-setup-py.patch:
      Add python sos.help module, it was miss in
      upstream release.

  * Former patches, now fixed:
    - d/p/0002-report-implement_estimate-only.patch
    - d/p/0003-ceph-add-support-for-containerized-ceph-setup.patch
    - d/p/0004-ceph-split-plugin-by-components.patch
    - d/p/0005-openvswitch-get-userspace-datapath-implementations.patch
    - d/p/0006-report-check-for-symlink-before-rmtree.patch

  * Remaining patches:
    - d/p/0001-debian-change-tmp-dir-location.patch:

 -- Eric Desrochers <email address hidden> Tue, 15 Feb 2022 23:10:27 -0500

Changed in sosreport (Ubuntu Jammy):
status: In Progress → Fix Released
Revision history for this message
Eric Desrochers (slashd) wrote :

Just notice man page doesn't include sos help.

I'll push another update (4.3-1ubuntu2) in Jammy.

- Eric

Revision history for this message
Eric Desrochers (slashd) wrote :
Eric Desrochers (slashd)
description: updated
Revision history for this message
Eric Desrochers (slashd) wrote :

For full changelog reference:

This bug was fixed in the package sosreport - 4.3-1ubuntu2
---------------

sosreport (4.3-1ubuntu2) jammy; urgency=medium

  * d/p/0003-mention-sos-help-in-sos-manpage.patch:
    Fix sos-help manpage.

 -- Eric Desrochers <email address hidden> Wed, 16 Feb 2022 13:05:13 -0500

---------------
sosreport (4.3-1ubuntu1) jammy; urgency=medium

  * New 4.3 upstream. (LP: #1960996)

  * For more details, full release note is available here:
    - https://github.com/sosreport/sos/releases/tag/4.3

  * New patches:
    - d/p/0002-fix-setup-py.patch:
      Add python sos.help module, it was miss in
      upstream release.

  * Former patches, now fixed:
    - d/p/0002-report-implement_estimate-only.patch
    - d/p/0003-ceph-add-support-for-containerized-ceph-setup.patch
    - d/p/0004-ceph-split-plugin-by-components.patch
    - d/p/0005-openvswitch-get-userspace-datapath-implementations.patch
    - d/p/0006-report-check-for-symlink-before-rmtree.patch

  * Remaining patches:
    - d/p/0001-debian-change-tmp-dir-location.patch:

 -- Eric Desrochers <email address hidden> Tue, 15 Feb 2022 23:10:27 -0500

description: updated
Revision history for this message
nikhil kshirsagar (nkshirsagar) wrote :

Focal debdiff attached.

Regards,
Nikhil.

Changed in sosreport (Ubuntu Impish):
status: New → In Progress
Changed in sosreport (Ubuntu Focal):
status: New → In Progress
Revision history for this message
Brian Murray (brian-murray) wrote : Please test proposed package

Hello nikhil, or anyone else affected,

Accepted sosreport into impish-proposed. The package will build now and be available at https://launchpad.net/ubuntu/+source/sosreport/4.3-1ubuntu0.21.10.1 in a few hours, and then in the -proposed repository.

Please help us by testing this new package. See https://wiki.ubuntu.com/Testing/EnableProposed for documentation on how to enable and use -proposed. Your feedback will aid us getting this update out to other Ubuntu users.

If this package fixes the bug for you, please add a comment to this bug, mentioning the version of the package you tested, what testing has been performed on the package and change the tag from verification-needed-impish to verification-done-impish. If it does not fix the bug for you, please add a comment stating that, and change the tag to verification-failed-impish. In either case, without details of your testing we will not be able to proceed.

Further information regarding the verification process can be found at https://wiki.ubuntu.com/QATeam/PerformingSRUVerification . Thank you in advance for helping!

N.B. The updated package will be released to -updates after the bug(s) fixed by this package have been verified and the package has been in -proposed for a minimum of 7 days.

Changed in sosreport (Ubuntu Impish):
status: In Progress → Fix Committed
tags: added: verification-needed verification-needed-impish
Changed in sosreport (Ubuntu Bionic):
assignee: nikhil kshirsagar (nkshirsagar) → nobody
importance: Medium → Low
Changed in sosreport (Ubuntu Bionic):
importance: Low → Medium
assignee: nobody → nikhil kshirsagar (nkshirsagar)
status: New → In Progress
Revision history for this message
Łukasz Zemczak (sil2100) wrote :

Hello nikhil, or anyone else affected,

Accepted sosreport into focal-proposed. The package will build now and be available at https://launchpad.net/ubuntu/+source/sosreport/4.3-1ubuntu0.20.04.1 in a few hours, and then in the -proposed repository.

Please help us by testing this new package. See https://wiki.ubuntu.com/Testing/EnableProposed for documentation on how to enable and use -proposed. Your feedback will aid us getting this update out to other Ubuntu users.

If this package fixes the bug for you, please add a comment to this bug, mentioning the version of the package you tested, what testing has been performed on the package and change the tag from verification-needed-focal to verification-done-focal. If it does not fix the bug for you, please add a comment stating that, and change the tag to verification-failed-focal. In either case, without details of your testing we will not be able to proceed.

Further information regarding the verification process can be found at https://wiki.ubuntu.com/QATeam/PerformingSRUVerification . Thank you in advance for helping!

N.B. The updated package will be released to -updates after the bug(s) fixed by this package have been verified and the package has been in -proposed for a minimum of 7 days.

Changed in sosreport (Ubuntu Focal):
status: In Progress → Fix Committed
tags: added: verification-needed-focal
Changed in sosreport (Ubuntu Bionic):
status: In Progress → Fix Committed
tags: added: verification-needed-bionic
Revision history for this message
Łukasz Zemczak (sil2100) wrote :

Hello nikhil, or anyone else affected,

Accepted sosreport into bionic-proposed. The package will build now and be available at https://launchpad.net/ubuntu/+source/sosreport/4.3-1ubuntu0.18.04.1 in a few hours, and then in the -proposed repository.

Please help us by testing this new package. See https://wiki.ubuntu.com/Testing/EnableProposed for documentation on how to enable and use -proposed. Your feedback will aid us getting this update out to other Ubuntu users.

If this package fixes the bug for you, please add a comment to this bug, mentioning the version of the package you tested, what testing has been performed on the package and change the tag from verification-needed-bionic to verification-done-bionic. If it does not fix the bug for you, please add a comment stating that, and change the tag to verification-failed-bionic. In either case, without details of your testing we will not be able to proceed.

Further information regarding the verification process can be found at https://wiki.ubuntu.com/QATeam/PerformingSRUVerification . Thank you in advance for helping!

N.B. The updated package will be released to -updates after the bug(s) fixed by this package have been verified and the package has been in -proposed for a minimum of 7 days.

Revision history for this message
Łukasz Zemczak (sil2100) wrote :

I accepted the update, but a few remarks:

a) The bionic upload had some handling of misplaced conf file, moving it into debian/sosreport/etc/sos/sos.conf. Is that not applicable in focal? Is it all good in focal?
b) The two new patches have no DEB-3 headers. Please always provide descriptions for changes you do in patches, even if they seem straightforwards as they are here. I think they were rather obvious so I didn't reject based on that.

Revision history for this message
nikhil kshirsagar (nkshirsagar) wrote :

Hello Lukasz,

Thank you for accepting the update.

The focal release already has the sos.conf changes because they had landed in 4.2.. However, 4.2 did not release for bionic (https://bugs.launchpad.net/ubuntu/+source/sosreport/+bug/1941745 has it as confirmed but not fix released) so for 4.3, for bionic, I needed to take the 4.2 changes as well as the new patches for 4.3. Hence the additional patches.

I've mentioned in the changelog for bionic,

------------------

sosreport (4.3-1ubuntu0.18.04.1) bionic; urgency=medium

  * New 4.3 upstream. (LP: #1960996)

  * For more details, full release note is available here:
    - https://github.com/sosreport/sos/releases/tag/4.3

  * New patches:
    - d/p/0002-fix-setup-py.patch:
      Add python sos.help module, it was missed in
      upstream release.
    - d/p/0003-mention-sos-help-in-sos-manpage.patch:
      Fix sos-help manpage.

  * Former patches, now fixed:
    - d/p/0002-clean-prevent-parsing-ubuntu-user.patch
    - d/p/0003-ubuntu-policy-fix-upload.patch
    - d/p/0004-chrony-configuration-can-now-be-fragmented.patch
    - d/p/0005-global-drop-plugin-version.patch
    - d/p/0006-networking-check-presence-of-devlink.patch
    - d/p/0007-sosnode-avoid-checksum-cleanup-if-no-archive.patch

  * d/control:
   - Add 'python3-coverage' as part of the build depends.

  * d/rules:
   - Fix misplaced and duplicated sos.conf file in /usr/config.

  * Remaining patches:
    - d/p/0001-debian-change-tmp-dir-location.patch

------------------

Regards,
Nikhil.

Revision history for this message
Ubuntu SRU Bot (ubuntu-sru-bot) wrote : Autopkgtest regression report (sosreport/4.3-1ubuntu0.20.04.1)

All autopkgtests for the newly accepted sosreport (4.3-1ubuntu0.20.04.1) for focal have finished running.
The following regressions have been reported in tests triggered by the package:

sosreport/4.3-1ubuntu0.20.04.1 (amd64)

Please visit the excuses page listed below and investigate the failures, proceeding afterwards as per the StableReleaseUpdates policy regarding autopkgtest regressions [1].

https://people.canonical.com/~ubuntu-archive/proposed-migration/focal/update_excuses.html#sosreport

[1] https://wiki.ubuntu.com/StableReleaseUpdates#Autopkgtest_Regressions

Thank you!

description: updated
description: updated
description: updated
Revision history for this message
nikhil kshirsagar (nkshirsagar) wrote :

I have opened https://bugs.launchpad.net/ubuntu/+source/sosreport/+bug/1962733 for issue flagged in the autopkgtests.

I've also reported it upstream since I was able to reproduce it with upstream code as well - https://github.com/sosreport/sos/issues/2873

description: updated
Revision history for this message
nikhil kshirsagar (nkshirsagar) wrote :

Hi Lukasz,

I have tested bionic in a VM and also a bionic container and verified the installed package is OK.

root@juju-677128-1-lxd-0:~# dpkg -l | grep sos
ii sosreport 4.3-1ubuntu0.18.04.1 amd64 Set of tools to gather troubleshooting data from a system
root@juju-677128-1-lxd-0:~# lsb_release -a
No LSB modules are available.
Distributor ID: Ubuntu
Description: Ubuntu 18.04.6 LTS
Release: 18.04
Codename: bionic

testing:
https://pastebin.canonical.com/p/bNbcGmS2yM/

The produced sos archive looks reasonable. (some ceph commands error out due to those not being present in luminous, that is expected)

I also ran latest hotsos on the produced bionic archive and verified it works fine.
https://pastebin.canonical.com/p/QHhR4hSF6b/

Revision history for this message
nikhil kshirsagar (nkshirsagar) wrote :

I have tested sos 4.3-1ubuntu0.20.04.2 on focal (baremetal) - https://pastebin.canonical.com/p/RD9ThxMHX3/

I've verified the generated sosreport is reasonable. I've also tested hotsos on the generated archive.

It looks good to me.

Regards,
Nikhil.

tags: added: verification-done-bionic verification-done-focal
removed: verification-needed-bionic verification-needed-focal
Revision history for this message
nikhil kshirsagar (nkshirsagar) wrote :

I have tested sos 4.3-1ubuntu0.21.10.1 on an impish VM and verified that everything looks OK.

I also tested hotsos on the generated sos archive.

Some details of the testing done - https://pastebin.canonical.com/p/Ns5x94MrJY/

Also used Jorge's script with an additional python script I hacked together to brute force search missing files in the new sos version - https://gist.github.com/drencrom/c455f7ff0e55b819a7a9f1901cc6cc60 and https://gist.github.com/drencrom/c455f7ff0e55b819a7a9f1901cc6cc60?permalink_comment_id=4090486#gistcomment-4090486

tags: added: verification-done-impish
removed: verification-needed-impish
Revision history for this message
Launchpad Janitor (janitor) wrote :

This bug was fixed in the package sosreport - 4.3-1ubuntu0.21.10.1

---------------
sosreport (4.3-1ubuntu0.21.10.1) impish; urgency=medium

  * New 4.3 upstream. (LP: #1960996)

  * For more details, full release note is available here:
    - https://github.com/sosreport/sos/releases/tag/4.3

  * New patches:
    - d/p/0002-fix-setup-py.patch:
      Add python sos.help module, it was missed in
      upstream release.
    - d/p/0003-mention-sos-help-in-sos-manpage.patch:
      Fix sos-help manpage.

  * Former patches, now fixed:
    - d/p/0002-report-implement_estimate-only.patch
    - d/p/0003-ceph-add-support-for-containerized-ceph-setup.patch
    - d/p/0004-ceph-split-plugin-by-components.patch
    - d/p/0005-openvswitch-get-userspace-datapath-implementations.patch
    - d/p/0006-report-check-for-symlink-before-rmtree.patch

  * Remaining patches:
    - d/p/0001-debian-change-tmp-dir-location.patch

 -- Nikhil Kshirsagar <email address hidden> Fri, 18 Feb 2022 10:15:33 +0000

Changed in sosreport (Ubuntu Impish):
status: Fix Committed → Fix Released
Revision history for this message
Łukasz Zemczak (sil2100) wrote : Update Released

The verification of the Stable Release Update for sosreport has completed successfully and the package is now being released to -updates. Subsequently, the Ubuntu Stable Release Updates Team is being unsubscribed and will not receive messages about this bug report. In the event that you encounter a regression using the package from -updates please report a new bug using ubuntu-bug and tag the bug report regression-update so we can easily find any regressions.

Revision history for this message
Launchpad Janitor (janitor) wrote :

This bug was fixed in the package sosreport - 4.3-1ubuntu0.20.04.1

---------------
sosreport (4.3-1ubuntu0.20.04.1) focal; urgency=medium

  * New 4.3 upstream. (LP: #1960996)

  * For more details, full release note is available here:
    - https://github.com/sosreport/sos/releases/tag/4.3

  * New patches:
    - d/p/0002-fix-setup-py.patch:
      Add python sos.help module, it was miss in
      upstream release.
    - d/p/0003-mention-sos-help-in-sos-manpage.patch:
      Fix sos-help manpage.

  * Former patches, now fixed:
    - d/p/0002-report-implement_estimate-only.patch
    - d/p/0003-ceph-add-support-for-containerized-ceph-setup.patch
    - d/p/0004-ceph-split-plugin-by-components.patch
    - d/p/0005-openvswitch-get-userspace-datapath-implementations.patch
    - d/p/0006-report-check-for-symlink-before-rmtree.patch

  * Remaining patches:
    - d/p/0001-debian-change-tmp-dir-location.patch

 -- Nikhil Kshirsagar <email address hidden> Thu, 17 Feb 2022 12:26:59 +0000

Changed in sosreport (Ubuntu Focal):
status: Fix Committed → Fix Released
Revision history for this message
Launchpad Janitor (janitor) wrote :

This bug was fixed in the package sosreport - 4.3-1ubuntu0.18.04.1

---------------
sosreport (4.3-1ubuntu0.18.04.1) bionic; urgency=medium

  * New 4.3 upstream. (LP: #1960996)

  * For more details, full release note is available here:
    - https://github.com/sosreport/sos/releases/tag/4.3

  * New patches:
    - d/p/0002-fix-setup-py.patch:
      Add python sos.help module, it was missed in
      upstream release.
    - d/p/0003-mention-sos-help-in-sos-manpage.patch:
      Fix sos-help manpage.

  * Former patches, now fixed:
    - d/p/0002-clean-prevent-parsing-ubuntu-user.patch
    - d/p/0003-ubuntu-policy-fix-upload.patch
    - d/p/0004-chrony-configuration-can-now-be-fragmented.patch
    - d/p/0005-global-drop-plugin-version.patch
    - d/p/0006-networking-check-presence-of-devlink.patch
    - d/p/0007-sosnode-avoid-checksum-cleanup-if-no-archive.patch

  * d/control:
   - Add 'python3-coverage' as part of the build depends.

  * d/rules:
   - Fix misplaced and duplicated sos.conf file in /usr/config.

  * Remaining patches:
    - d/p/0001-debian-change-tmp-dir-location.patch

 -- Nikhil Kshirsagar <email address hidden> Mon, 28 Feb 2022 09:19:37 +0000

Changed in sosreport (Ubuntu Bionic):
status: Fix Committed → Fix Released
tags: added: verification-done
removed: verification-needed
To post a comment you must log in.
This report contains Public information  
Everyone can see this information.

Other bug subscribers

Remote bug watches

Bug watches keep track of this bug in other bug trackers.