Skip to content

Support data collection #1287

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 8 commits into from
Dec 2, 2025
Merged

Support data collection #1287

merged 8 commits into from
Dec 2, 2025
+2,360 −6

Conversation

@troglobit
Copy link
Contributor

@troglobit troglobit commented Nov 30, 2025

Description

This PR adds a support script tailored for gathering system information. The recommended way of running the script is:

$ ssh user@device support collect > support-device-$(date -Iseconds).tar.gz

Also included is an initial prototype of a support analysis utility tool. Implemented in python using the textual framework, tui mode only atm., but possible to extend with a web front-end later on.

Checklist

Tick relevant boxes, this PR is-a or has-a:

  • Bugfix
    • Regression tests
    • ChangeLog updates (for next release)
  • Feature
    • YANG model change => revision updated?
    • Regression tests added?
    • ChangeLog updates (for next release)
    • Documentation added?
  • Test changes
    • Checked in changed Readme.adoc (make test-spec)
    • Added new test to group Readme.adoc and yaml file
  • Code style update (formatting, renaming)
  • Refactoring (please detail in commit messages)
  • Build related changes
  • Documentation content changes
    • ChangeLog updated (for major changes)
  • Other (please describe):

@jovatn jovatn added this to the Infix v25.11 milestone Dec 1, 2025
wkz
wkz reviewed Dec 1, 2025
View reviewed changes
Copy link
Contributor

@wkz wkz left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Excellent work! 🙏

jovatn
jovatn approved these changes Dec 1, 2025
View reviewed changes
Copy link
Contributor

@jovatn jovatn left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM! Note: I have only looked at user documentation and test documentation.
Perhaps you'd like to include gpg encryption in the test too?

@troglobit
Copy link
Contributor Author

troglobit commented Dec 1, 2025 •
edited
Loading

LGTM! Note: I have only looked at user documentation and test documentation.

Thank you! 🙏

Perhaps you'd like to include gpg encryption in the test too?

I'd a good idea, I considered it myself first but decided against it since we don't have gpg installed on all builds. I'm mostly concerned that the data gathering might break in the future. The gpg tool is checked for in the script and is not load bearing. Update: I ended up adding this anyway since we now also have custom --work-dir PATH support and needed to verify that too.

@troglobit troglobit requested a review from wkz December 2, 2025 10:11
@troglobit
bin: add system support data collection
a1067fd 
Signed-off-by: Joachim Wiberg <[email protected]>
@troglobit
doc: add Support Data Collection section to User Guide
0650e16 
Signed-off-by: Joachim Wiberg <[email protected]>
@troglobit
bin: add optional support for encrypting the support tarball
9ce4701 
This commit adds optional support for encrypting the tarball before it
leaves the target system.  Documentation and usage text updated.

Signed-off-by: Joachim Wiberg <[email protected]>
@troglobit
bin: collect data by default to /var/lib/support
cfeb875 
Also, adjust file suffix for json files.

Signed-off-by: Joachim Wiberg <[email protected]>
@troglobit
test: minor, update test specifications
d1f053b 
Sync with latest updates, including test path changes.

Signed-off-by: Joachim Wiberg <[email protected]>
@troglobit
test: new test, verify support data collection
d672174 
Signed-off-by: Joachim Wiberg <[email protected]>
@troglobit
utils: initial support data analysis tool
1728b68 
Signed-off-by: Joachim Wiberg <[email protected]>
@troglobit
Update ChangeLog, new 'support' command
1620fb5 
Signed-off-by: Joachim Wiberg <[email protected]>
@troglobit
Copy link
Contributor Author

troglobit commented Dec 2, 2025

@wkz would you mind having a final look and approve if you like what you see?

wkz
wkz approved these changes Dec 2, 2025
View reviewed changes
Copy link
Contributor

@wkz wkz left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Super trooper! 🎖️

test/case/misc/support_collect/test.py
if os.path.exists(output_file):
os.remove(output_file)

if has_gpg:
Copy link
Contributor

@wkz wkz Dec 2, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
if has_gpg:
if not has_gpg:
test.succeed()

Just for future endeavors: this pattern should work, IIRC. Avoids having to indent the whole following block 🤓

Copy link
Contributor Author

@troglobit troglobit Dec 2, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah, of course. Thanks!

@troglobit troglobit merged commit 76bc8da into main Dec 2, 2025
6 checks passed
@troglobit troglobit deleted the support branch December 2, 2025 14:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@wkz wkz wkz approved these changes

@jovatn jovatn jovatn approved these changes

@mattiaswal mattiaswal Awaiting requested review from mattiaswal

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

Infix v25.11

Development

Successfully merging this pull request may close these issues.

4 participants

@troglobit @wkz @jovatn