KAFKA-19941: Improved property spacing/readability of kafka-features.sh output #21072
+86
−32
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
chia7712
reviewed
Dec 4, 2025
Member
chia7712
left a comment
chia7712
left a comment
There was a problem hiding this comment.
@rionmonster thanks for this patch. This patch requires a little bit of artistry 😄
| short finalizedLevel = (featureMetadata.finalizedFeatures().get(feature) == null) ? 0 : featureMetadata.finalizedFeatures().get(feature).maxVersionLevel(); | ||
| SupportedVersionRange range = featureMetadata.supportedFeatures().get(feature); | ||
| System.out.printf("Feature: %s\tSupportedMinVersion: %s\tSupportedMaxVersion: %s\tFinalizedVersionLevel: %s\tEpoch: %s%n", | ||
| System.out.printf("Feature: %s\t\tSupportedMinVersion: %s\t\tSupportedMaxVersion: %s\t\tFinalizedVersionLevel: %s\t\tEpoch: %s%n", |
Member
There was a problem hiding this comment.
Is there a way to align these console outputs based on tab?
Author
There was a problem hiding this comment.
Totally! We could introduce fixed width fields to handle the formatting (instead of tabs) which would make it more consistent as seen below:
…tput KAFKA-19941: Standardized property alignment for kafka-features.sh output
rionmonster
force-pushed
the
kafka-19941
branch
from
5c89d5f to
38012e6
Compare
Author
|
I've gone ahead and updated the PR to include the width-based alignment approach and adjusted the associated tests. Let me know what you think and if we need to make any other changes on this front. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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
Closes: KAFKA-19941
The goal of this minor pull request was to improve the existing
readability for the
kafka-features.shoutput which could be difficultto decipher due to the inadequate spacing between properties. This
change improves that spacing by replacing the previous tab-based spacing
with a fixed-width approach to standardize property alignment.
In addition to these changes all of the affected tests within the
FeatureCommandTestsuite were updated to ensure all of the existingtests were passing after the changes were made.
Discussion and Rationale
These changes were discussed briefly within this mailing list
thread,
however the conversation was primarily about if adjusting output would
equate to changing a public interface -- thus requiring a KIP.
While there were several possible options to improve the readability or
to support multiple formats potentially via an output parameter (e.g.
--output=tableto table-formatted output, similarly with JSON, etc.),these would be much larger bodies of work. The simplest approach in this
case was to just improve the spacing and allow the end-user to adopt
their preferred transformation from the existing format.
Example Output
Mentions
Tagging @chia7712 for review (as the initial creator of the JIRA)