KAFKA-9716: Clarify meaning of compression rate metrics #8664
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
hachikuji
reviewed
Jun 7, 2020
| @@ -84,7 +84,7 @@ public SenderMetricsRegistry(Metrics metrics) { | |||
| this.batchSizeMax = createMetricName("batch-size-max", | |||
| "The max number of bytes sent per partition per-request."); | |||
| this.compressionRateAvg = createMetricName("compression-rate-avg", | |||
| "The average compression rate of record batches."); | |||
| "The average compressed-to-uncompressed size ratio of record batches."); | |||
There was a problem hiding this comment.
It might be a little more verbose, but perhaps we could phrase it like this?
The average compression rate of record batches, defined as the average ratio of the compressed batch size over the uncompressed size.
There was a problem hiding this comment.
I was in fact going for brevity with my approach, but if more detail will mean increased clarity for the user then I'm all for it. With the way you've defined it, I think there can be little question regarding the meaning.
hachikuji
approved these changes
Jun 8, 2020
|
ok to test |
|
retest this please |
1 similar comment
|
retest this please |
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.
There is some confusion over the compression rate metrics, as the meaning of the value isn't clearly stated in the metric description. In this case, it was assumed that a higher compression rate value meant better compression. This PR clarifies the meaning of the value, to prevent misunderstandings.
Alternative approaches that were considered were to either change the name of the metric or its implementation, but this would have a negative impact on those who are already making use of this metric.
Committer Checklist (excluded from commit message)