Add a ServiceTalk debugging utilities example #1459
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
bondolo
commented
Mar 25, 2021
Motivation: HttpExecutionStrategies.noOffloadsStrategy() does not disable all offloading. Modifications: Improve the description of HttpExecutionStrategies.noOffloadsStrategy() to better explain where the default offloading executor will still be used. A recipe is provided to completely disable offloading. Result: Behaviour of HttpExecutionStrategies.noOffloadsStrategy() is clarified.
Scottmitch
approved these changes
Mar 27, 2021
...p/debugging/src/main/java/io/servicetalk/examples/http/debugging/DebuggingExampleClient.java
Outdated
Show resolved
Hide resolved
...p/debugging/src/main/java/io/servicetalk/examples/http/debugging/DebuggingExampleServer.java
Outdated
Show resolved
Hide resolved
...p/debugging/src/main/java/io/servicetalk/examples/http/debugging/DebuggingExampleClient.java
Outdated
Show resolved
Hide resolved
...p/debugging/src/main/java/io/servicetalk/examples/http/debugging/DebuggingExampleClient.java
Outdated
Show resolved
Hide resolved
...p/debugging/src/main/java/io/servicetalk/examples/http/debugging/DebuggingExampleClient.java
Outdated
Show resolved
Hide resolved
...p/debugging/src/main/java/io/servicetalk/examples/http/debugging/DebuggingExampleClient.java
Outdated
Show resolved
Hide resolved
...p/debugging/src/main/java/io/servicetalk/examples/http/debugging/DebuggingExampleClient.java
Show resolved
Hide resolved
...p/debugging/src/main/java/io/servicetalk/examples/http/debugging/DebuggingExampleServer.java
Outdated
Show resolved
Hide resolved
servicetalk-examples/http/debugging/src/main/resources/log4j2.xml
Outdated
Show resolved
Hide resolved
|
|
||
| dependencies { | ||
| implementation project(":servicetalk-annotations") | ||
| implementation project(":servicetalk-encoding-netty") |
There was a problem hiding this comment.
This dependency is not used in this example
There was a problem hiding this comment.
Is there an IntelliJ detector for this? I used to use one in Netbeans with Maven and would like to turn it on for Gradle if I could.
There was a problem hiding this comment.
Not that I'm aware of 🤷♂️
...p/debugging/src/main/java/io/servicetalk/examples/http/debugging/DebuggingExampleClient.java
Outdated
Show resolved
Hide resolved
| // Enables visibility for all wire log messages | ||
| System.setProperty("servicetalk.logger.wireLogLevel", "TRACE"); | ||
| // Disables the context associated with individual request/responses to simplify execution tracing | ||
| AsyncContext.disable(); |
There was a problem hiding this comment.
Not sure, but something to discuss and consider: because it's easy to forget to remove this statement after the debugging we may demonstrate it can be protected by the system property. Something like:
static {
if (Boolean.getBoolean("debuggingMode")) {
AsyncContext.disable();
}
}There was a problem hiding this comment.
It would be good to standardize how we use system properties and/or environment variables for configuration and control of debugging features. It is definitely a useful tool. In other orgs I have used
(public|private) static final boolean SOMETHING_DEBUG = Boolean.getBoolean("package.name.Feature.debug");`
and then triggered all use off of the boolean. One advantage is that it lets the JIT remove dead code and also makes it easy to find all the references.
Motivation: ServiceTalk has purpose-built features for improving the debugging experience for both applications and for ServiceTalk itself. An example with explanatory comments would improve exposure of these features. Modifications: A new HTTP debugging example is provided demonstrating wire logging, disabling offloading, disabling async context. Result: ServiceTalk debugging features are more visible.
provide (very verbose) samples of the output
bondolo
force-pushed
the
debugging-example
branch
from
847e548 to
e50b16d
Compare
|
Thank you for the feedback. I think this will be a really useful example. |
idelpivnitskiy
added a commit
to idelpivnitskiy/servicetalk
that referenced
this pull request
Mar 30, 2021
Motivation: Fixing a few typos, adding links to appropriate features in javadoc, clarifying difference between wire-logger and h2-frame-logger. Modifications: - Fix typos in `index.adoc` and `log4j2.xml` name; - Add links in javadoc for all demonstrated features; - Use a different name for h2 frame logger; - Use another comment style to highlight comments for demonstrated features; - Add `CLOSE/INACTIVE/UNREGISTERED` wire logger events; Result: More details in the example.
idelpivnitskiy
added a commit
that referenced
this pull request
Mar 31, 2021
Motivation: Fixing a few typos, adding links to appropriate features in javadoc, clarifying the difference between wire-logger and h2-frame-logger. Modifications: - Fix typos in `index.adoc` and `log4j2.xml` name; - Add links in javadoc for all demonstrated features; - Use a different name for h2 frame logger; - Use another comment style to highlight comments for demonstrated features and let IDE use shortcut to uncomment the code line; - Add `CLOSE/INACTIVE/UNREGISTERED` wire logger events; Result: More details in the example.
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:
ServiceTalk has purpose-built features for improving the debugging
experience for both applications and for ServiceTalk itself. An example
with explanatory comments would improve exposure of these features.
Modifications:
A new HTTP debugging example is provided demonstrating wire logging,
disabling offloading, disabling async context.
Result:
ServiceTalk debugging features are more visible.