Make Netty Instrumentation HttpServerRequestTracingHandler propagate "Channel Inactive" event to downstream according to parent contract #10303
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
laurit
reviewed
Jan 22, 2024
...ing/src/main/java/io/opentelemetry/instrumentation/netty/v4_1/AbstractNetty41ServerTest.java
Outdated
Show resolved
Hide resolved
…"Channel Inactive" event to downstream according to parent contract
laurit
approved these changes
Jan 22, 2024
|
@laurit can we merge it? |
github-actions bot
pushed a commit
that referenced
this pull request
Jan 23, 2024
…"Channel Inactive" event to downstream according to parent contract (#10303)
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
Current Netty instrumentation of ChannelHandlerAdapter violates parent contract of ChannelHandler. It does not propagate Channel Inactive event to downstream handlers, which may lead to bad side effects(In my case there was a memory leak, because connection-close channel handler was not called with Channel Inactive event).
That PR calls super.channelInactive(ctx) on each execution path of HttpServerRequestTracingHandler channelInactive method to avoid that situation.
Additional considerations
I suggest backporting that fix to 1.32.x, as that issue can break a lot of custom Netty-based code.