Make unexpected gRPC exceptions visible on the server-side #3235
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
Motivation: Server-side `GrpcRouter` works as a translation layer from HTTP to gRPC and back. It logs all exceptions at `DEBUG` level, which makes it hard for users to notice when their endpoints throw exceptions. Modifications: - Enhance `GrpcRouter` to log unexpected exceptions at `ERROR` level. Expected exceptions (`GrpcStatusException`, TimeoutException`, and `CancellationException`) will still be logged at `DEBUG` level. Result: Easier to spot unexpected server-side exceptions from gRPC endpoints.
Comment on lines
920
to
922
| private static boolean shouldLogAsError(final Throwable error) { | ||
| return !(error instanceof GrpcStatusException) && GrpcStatusException.serverCatchAllShouldLog(error); | ||
| } |
Contributor
There was a problem hiding this comment.
We could reduce a lot of duplication if we do something like this:
Suggested change
| private static boolean shouldLogAsError(final Throwable error) { | |
| return !(error instanceof GrpcStatusException) && GrpcStatusException.serverCatchAllShouldLog(error); | |
| } | |
| private static boolean logException(String msg, MethodDescriptor<?, ?> methodDescriptor, Throwable error) { | |
| boolean logAsError = !(error instanceof GrpcStatusException) && GrpcStatusException.serverCatchAllShouldLog(error); | |
| if (logAsError) { | |
| LOGGER.error(msg, methodDescriptor.httpPath(), t); | |
| } else { | |
| LOGGER.debug(msg, methodDescriptor.httpPath(), t); | |
| } | |
| } |
Member
Author
There was a problem hiding this comment.
Good idea, I also made all exception messages and logging conditions consistent. GrpcStatusException is something that users can intentionally return/throw as a way to return grpc-status they need. That's why we log it only at debug level
bryce-anderson
approved these changes
Apr 15, 2025
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.
Motivation:
Server-side
GrpcRouterworks as a translation layer from HTTP to gRPC and back. It logs all exceptions atDEBUGlevel, which makes it hard for users to notice when their endpoints throw exceptions.Modifications:
GrpcRouterto log unexpected exceptions atERRORlevel. Expected exceptions (GrpcStatusException,TimeoutException, andCancellationException) will still be logged atDEBUGlevel.Result:
Easier to spot unexpected server-side exceptions from gRPC endpoints.