Clarify debugging examples with more comments #2330
Merged
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
Motivation: Users unintentionally copy HTTP/2 configuration when they should debug only HTTP/1.1 and still ask questions why trace logs are not visible. Modifications: - Clarify 2nd and 3rd argument of `enableWireLogging` and `enableFrameLogging`; - Clarify that `HttpProtocolConfigs.h2()` is required only for HTTP/2; - Clarify how to `enableFrameLogging` in case of ALPN; Result: More comments for debugging examples.
bondolo
reviewed
Aug 23, 2022
...les/grpc/debugging/src/main/java/io/servicetalk/examples/grpc/debugging/DebuggingClient.java
Outdated
Show resolved
Hide resolved
...les/grpc/debugging/src/main/java/io/servicetalk/examples/grpc/debugging/DebuggingServer.java
Outdated
Show resolved
Hide resolved
| @@ -28,6 +28,7 @@ | |||
| <!-- Additional useful loggers of interest - include relevant loggers in your log4j2.xml file --> | |||
There was a problem hiding this comment.
Is this file needed since the example also has a dependency on test resources? Perhaps also make this change in test resources log4j.xml as well.
There was a problem hiding this comment.
I believe it's needed here. log4j.xml form test-resources is for tests purposes only, we don't want too much debug level logging there. In this example, it's useful to show what loggers they can enable for extra visibility.
…lk/examples/grpc/debugging/DebuggingClient.java Co-authored-by: Mike Duigou <[email protected]>
Co-authored-by: Mike Duigou <[email protected]>
bondolo
approved these changes
Aug 24, 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.
Motivation:
Users unintentionally copy HTTP/2 configuration when they should debug
only HTTP/1.1 and still ask questions why trace logs are not visible.
Modifications:
enableWireLoggingandenableFrameLogging;HttpProtocolConfigs.h2()is required only for HTTP/2;enableFrameLoggingin case of ALPN;Result:
More comments for debugging examples.