[sled-diagnostics] Output for support bundles should be structured #7228
Conversation
This file contains 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
Created using spr 1.3.6-beta.1
|
Deployed this on my bench gimlet to ensure things looked sane: |
smklein
approved these changes
Dec 11, 2024
sled-diagnostics/src/queries.rs
Outdated
| #[serde(rename_all = "snake_case")] | ||
| pub enum SledDiagnosticsQueryOutput { | ||
| Success { | ||
| /// The command and it's arguments. |
There was a problem hiding this comment.
Suggested change
| /// The command and it's arguments. | |
| /// The command and its arguments. |
There was a problem hiding this comment.
Fixed in 7b67092
sled-diagnostics/src/queries.rs
Outdated
| /// The exit status of the command. This will be the exit code (if any) | ||
| /// and exit reason such as from a signal. | ||
| exit_status: String, | ||
| /// The exit code if one was present when the comman exited. |
There was a problem hiding this comment.
Suggested change
| /// The exit code if one was present when the comman exited. | |
| /// The exit code if one was present when the command exited. |
There was a problem hiding this comment.
Fixed in 7b67092
hawkw
reviewed
Dec 11, 2024
Comment on lines
+42
to
+43
| /// Any stdout/stderr produced by the command. | ||
| stdio: String, |
There was a problem hiding this comment.
if we're now returning structured output, would it make sense to start separating stderr and stdout? or is it more useful to keep interleaving them?
There was a problem hiding this comment.
I personally think it's more useful to have them interleaved but I am open to changing it if others think it's better.
My reasoning is being able to see where an error occurred in a command's output vs just that an error occurred at some point.
Created using spr 1.3.6-beta.1
Created using spr 1.3.6-beta.1
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.
This introduces the
SledDiagnosticsQueryOutputtype so support bundles can now have structured output in collected files. This makes it potentially easier for an operator to write scripts that search for particular commands based on various fields.This is on top of: