cli: Deprecate -o json, recommend -o jsonpb instead
#738
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
maintainer-s-little-helper
bot
added
the
dont-merge/needs-release-note-label
gandro
added
release-note/major
rolinh
approved these changes
Jun 7, 2022
kaworu
approved these changes
Jun 7, 2022
The `-o json` output had been added to Hubble very early, when we assumed that all relevant information would be contained in the `Flow` protobuf message. Hubble has however since gained the `-o jsonpb` output, which contains additional information such as the node name which produced the network flow. More importantly, `-o json` cannot be piped into `hubble observe` for additional filtering, therefore further limiting its usability. To avoid users accidentally using `-o json` instead of the likely more correct `-o jsonpb`, this commit deprecates `-o json` and prints a warning to stderr whenever it is used. This allows us to fully remove `-o json` in a future release. Signed-off-by: Sebastian Wicki <sebastian@isovalent.com>
gandro
force-pushed
the
pr/gandro/deprecate-json-output
branch
from
67f5162
to
379e2fb
Compare
michi-covalent
approved these changes
Jun 7, 2022
pchaigno
approved these changes
Jun 7, 2022
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.
The
-o jsonoutput had been added to Hubble very early, when weassumed that all relevant information would be contained in the
Flowprotobuf message. Hubble has however since gained the
-o jsonpboutput, which contains additional information such as the node name
which produced the network flow.
More importantly,
-o jsoncannot be piped intohubble observeforadditional filtering, therefore further limiting its usability. To avoid
users accidentally using
-o jsoninstead of the likely more correct-o jsonpb, this commit deprecates-o jsonand prints a warning tostderr whenever it is used.
This allows us to fully remove
-o jsonin a future release.