Skip to content

feat: tedge diag adds summary output to the archive#3687

Merged
rina23q merged 1 commit intothin-edge:mainfrom
rina23q:improve/3646/add-summary-output-to-diag-tarball
Jun 18, 2025
Merged

feat: tedge diag adds summary output to the archive#3687
rina23q merged 1 commit intothin-edge:mainfrom
rina23q:improve/3646/add-summary-output-to-diag-tarball

Conversation

@rina23q
Copy link
Copy Markdown
Member

@rina23q rina23q commented Jun 13, 2025 •
edited
Loading

Proposed changes

The copy of the console output by tedge diag collect is now added as summary.log to a tarball archive.

Types of changes

  • Bugfix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Improvement (general improvements like code refactoring that doesn't explicitly fix a bug or add any new functionality)
  • Documentation Update (if none of the other choices apply)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)

Paste Link to the issue

#3646

Checklist

  • I have read the CONTRIBUTING doc
  • I have signed the CLA (in all commits with git commit -s. You can activate automatic signing by running just prepare-dev once)
  • I ran just format as mentioned in CODING_GUIDELINES
  • I used just check as mentioned in CODING_GUIDELINES
  • I have added tests that prove my fix is effective or that my feature works
  • I have added necessary documentation (if appropriate)

Further comments

@rina23q rina23q had a problem deploying to Test Pull Request June 13, 2025 16:57 — with GitHub Actions Failure
@rina23q rina23q force-pushed the improve/3646/add-summary-output-to-diag-tarball branch from 2993bbb to 081cd95 Compare June 13, 2025 17:00
@rina23q rina23q temporarily deployed to Test Pull Request June 13, 2025 17:01 — with GitHub Actions Inactive
@rina23q rina23q mentioned this pull request Jun 13, 2025
Closed
7 tasks
@github-actions
Copy link
Copy Markdown
Contributor

github-actions bot commented Jun 16, 2025 •
edited
Loading

Robot Results

✅ Passed ❌ Failed ⏭️ Skipped Total Pass % ⏱️ Duration
642 0 3 642 100 1h50m27.366114999s

didier-wenzek
didier-wenzek requested changes Jun 16, 2025
View reviewed changes
Copy link
Copy Markdown
Contributor

@didier-wenzek didier-wenzek left a comment •
edited
Loading

Choose a reason for hiding this comment

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

There is a bug. The call to file::create_directory_with_defaults(&self.diag_dir) in DiagCollectCommand::execute() must be the very first step before self.read_diag_plugins().await?, otherwise all the warnings emitted by diag_log! and diag_warning! are not pushed to summary.log.

albinsuresh
albinsuresh reviewed Jun 16, 2025
View reviewed changes
@reubenmiller
Copy link
Copy Markdown
Contributor

reubenmiller commented Jun 16, 2025

@rina23q One of the system tests should also be adjusted to add a check for the creation of the summary.log file within the tarball.

@reubenmiller reubenmiller added theme:troubleshooting Theme: Troubleshooting and remote control skip-release-notes Don't include the ticket in the auto generated release notes labels Jun 16, 2025
@reubenmiller reubenmiller marked this pull request as draft June 17, 2025 09:09
@rina23q rina23q had a problem deploying to Test Pull Request June 17, 2025 14:25 — with GitHub Actions Failure
@codecov
Copy link
Copy Markdown

codecov bot commented Jun 17, 2025 •
edited
Loading

Codecov Report

Attention: Patch coverage is 38.88889% with 44 lines in your changes missing coverage. Please review.

Files with missing lines Patch % Lines
crates/core/tedge/src/cli/diag/collect.rs 42.85% 28 Missing ⚠️
crates/core/tedge/src/cli/diag/logger.rs 30.43% 15 Missing and 1 partial ⚠️

📢 Thoughts on this report? Let us know!

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@rina23q rina23q had a problem deploying to Test Pull Request June 17, 2025 15:16 — with GitHub Actions Failure
@rina23q rina23q temporarily deployed to Test Pull Request June 17, 2025 15:27 — with GitHub Actions Inactive
@rina23q rina23q marked this pull request as ready for review June 17, 2025 16:08
@rina23q rina23q requested a review from a team as a code owner June 17, 2025 16:08
@rina23q
Copy link
Copy Markdown
Member Author

rina23q commented Jun 17, 2025

@rina23q One of the system tests should also be adjusted to add a check for the creation of the summary.log file within the tarball.

Done in cf090a6

albinsuresh
albinsuresh approved these changes Jun 18, 2025
View reviewed changes
Copy link
Copy Markdown
Contributor

@albinsuresh albinsuresh left a comment

Choose a reason for hiding this comment

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

LGTM

@rina23q rina23q had a problem deploying to Test Pull Request June 18, 2025 12:36 — with GitHub Actions Failure
didier-wenzek
didier-wenzek approved these changes Jun 18, 2025
View reviewed changes
Copy link
Copy Markdown
Contributor

@didier-wenzek didier-wenzek left a comment

Choose a reason for hiding this comment

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

Approved. Thank you for taking the time to refactor your first proposal.

@rina23q
feat: tedge diag adds summary output to the archive
20c1062 
summary.log is added to a tarball archive

Signed-off-by: Rina Fujino <rina.fujino.23@gmail.com>
@rina23q rina23q force-pushed the improve/3646/add-summary-output-to-diag-tarball branch from f1b1aa3 to 20c1062 Compare June 18, 2025 13:01
@rina23q rina23q temporarily deployed to Test Pull Request June 18, 2025 13:01 — with GitHub Actions Inactive
@rina23q rina23q enabled auto-merge June 18, 2025 13:13
@rina23q rina23q added this pull request to the merge queue Jun 18, 2025
Merged via the queue into thin-edge:main with commit f976ca3 Jun 18, 2025
34 checks passed
@rina23q rina23q deleted the improve/3646/add-summary-output-to-diag-tarball branch August 8, 2025 11:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@reubenmiller reubenmiller reubenmiller left review comments

@albinsuresh albinsuresh albinsuresh approved these changes

@didier-wenzek didier-wenzek didier-wenzek approved these changes

@jarhodes314 jarhodes314 Awaiting requested review from jarhodes314 jarhodes314 is a code owner

Assignees

No one assigned

Labels

skip-release-notes Don't include the ticket in the auto generated release notes theme:troubleshooting Theme: Troubleshooting and remote control

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@rina23q @reubenmiller @albinsuresh @didier-wenzek