feat: add progress reporting #376
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This comment was marked as outdated.
This comment was marked as outdated.
Sorry, something went wrong.
Co-authored-by: Nick <10092581+NickLarsenNZ@users.noreply.github.com>
Co-authored-by: Nick <10092581+NickLarsenNZ@users.noreply.github.com>
```shell cargo +nightly-2025-01-15 fmt --all ```
…d use span filtering toc ontrol indicatif output NOTE: Use `fields(indicatif.pb_show = true)` on instrumented functions that should have progress reporting
3 tasks
| @@ -303,14 +306,15 @@ fn describe_cmd( | |||
| } | |||
| } | |||
|
|
|||
| #[instrument(skip(cli, stack_list, transfer_client))] | |||
| #[instrument(skip(cli, stack_list, transfer_client), fields(indicatif.pb_show = true))] | |||
There was a problem hiding this comment.
Note to self, we should skip_all here, since args ends up looking so bad in the logs (since it uses the Debug impl). Nothing related to this PR though.
NickLarsenNZ
moved this from Development: Waiting for Review
to Development: In Review
in Stackable Engineering
NickLarsenNZ
moved this from Development: In Review
to Development: Done
in Stackable Engineering
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Implementation for #153
Adds various progress indications/visualizations to
stackablectlsubcommand outputs.Some explanation regarding
println!/eprintln!changes in this PR:When indicatif is active, it needs to control how text is printed. So instead of printing straight to
stdout/stderrviaprintln!/eprintln!, we useindicatif_println!/indicatif_eprintln!so it can deal with it while rendering progress bars. If it is not active, the indicatif macros just usestdout/stderr.Definition of Done Checklist