Cleanup: Fix grammar in error message, also improve readability. #13451
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
Contributor
mayankshriv
commented
Jun 20, 2024
mayankshriv
commented
- Fixed grammar.
- Now logging table name first, before the list of segments, for better readability.
mayankshriv
force-pushed
the
msg-cleanup
branch
2 times, most recently
from
dd847fd to
822afe5
Compare
| @@ -243,7 +243,7 @@ protected BrokerResponse handleRequest(long requestId, String query, @Nullable S | |||
| Set<String> unavailableSegments = entry.getValue(); | |||
| numUnavailableSegments += unavailableSegments.size(); | |||
| brokerResponse.addException(QueryException.getException(QueryException.SERVER_SEGMENT_MISSING_ERROR, | |||
| String.format("Find unavailable segments: %s for table: %s", unavailableSegments, tableName))); | |||
| String.format("Found unavailable segments for table {%s}: {%s}", tableName, unavailableSegments))); | |||
There was a problem hiding this comment.
Suggested change
| String.format("Found unavailable segments for table {%s}: {%s}", tableName, unavailableSegments))); | |
| String.format("Found unavailable segments for table %s: %s", tableName, unavailableSegments))); |
There was a problem hiding this comment.
Consider adding number of unavailable segments, and only log up to 10 segments. If there are more than 10 segments unavailable, append ... after the list
There was a problem hiding this comment.
Done @Jackie-Jiang. Also, given that error path will be very infrequent, I felt it was ok to use stream way to build the string as opposed to StringBuilder and for loop.
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## master #13451 +/- ##
============================================
+ Coverage 61.75% 61.98% +0.23%
+ Complexity 207 198 -9
============================================
Files 2436 2557 +121
Lines 133233 141194 +7961
Branches 20636 21914 +1278
============================================
+ Hits 82274 87519 +5245
- Misses 44911 47021 +2110
- Partials 6048 6654 +606
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. |
Jackie-Jiang
approved these changes
Jun 24, 2024
| @@ -243,7 +244,8 @@ protected BrokerResponse handleRequest(long requestId, String query, @Nullable S | |||
| Set<String> unavailableSegments = entry.getValue(); | |||
| numUnavailableSegments += unavailableSegments.size(); | |||
| brokerResponse.addException(QueryException.getException(QueryException.SERVER_SEGMENT_MISSING_ERROR, | |||
| String.format("Find unavailable segments: %s for table: %s", unavailableSegments, tableName))); | |||
| String.format("Found unavailable segments for table %s: %s", tableName, | |||
There was a problem hiding this comment.
Suggest adding the count Found %d unavailable segments ...
* Fixed grammar. * Now logging table name first, before the list of segments, for better readability.
suyashpatel98
pushed a commit
to suyashpatel98/pinot
that referenced
this pull request
Jul 6, 2024
…che#13451) * Fixed grammar. * Now logging table name first, before the list of segments, for better readability.
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.