Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

#4056 remove oringin handler when removelast in netty #4123

Merged
merged 5 commits into from
Sep 17, 2021
Merged

#4056 remove oringin handler when removelast in netty #4123

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
88da9a1
removelast
tydhot Sep 14, 2021
00fe8ea
removelast
tydhot Sep 16, 2021
b3fb9b5
addAfter and removeLast
tydhot Sep 16, 2021
8a2b7f7
addAfter and removeLast
tydhot Sep 16, 2021
33dc4b1
addAfter and removeLast
tydhot Sep 17, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
56 changes: 52 additions & 4 deletions ...y/javaagent/instrumentation/netty/common/AbstractNettyChannelPipelineInstrumentation.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@
import static net.bytebuddy.matcher.ElementMatchers.named;
import static net.bytebuddy.matcher.ElementMatchers.returns;
import static net.bytebuddy.matcher.ElementMatchers.takesArgument;
import static net.bytebuddy.matcher.ElementMatchers.takesArguments;

import io.netty.channel.ChannelHandler;
import io.netty.channel.ChannelPipeline;
Expand Down Expand Up @@ -47,11 +48,18 @@ public void transform(TypeTransformer transformer) {
transformer.applyAdviceToMethod(
isMethod().and(named("remove").or(named("replace"))).and(takesArgument(0, Class.class)),
AbstractNettyChannelPipelineInstrumentation.class.getName() + "$RemoveByClassAdvice");
transformer.applyAdviceToMethod(
isMethod().and(named("removeFirst")).and(returns(named("io.netty.channel.ChannelHandler"))),
AbstractNettyChannelPipelineInstrumentation.class.getName() + "$RemoveFirstAdvice");
transformer.applyAdviceToMethod(
isMethod().and(named("removeLast")).and(returns(named("io.netty.channel.ChannelHandler"))),
AbstractNettyChannelPipelineInstrumentation.class.getName() + "$RemoveLastAdvice");
transformer.applyAdviceToMethod(
isMethod()
.and(named("removeFirst").or(named("removeLast")))
.and(returns(named("io.netty.channel.ChannelHandler"))),
AbstractNettyChannelPipelineInstrumentation.class.getName() + "$RemoveFirstLastAdvice");
.and(named("addAfter"))
.and(takesArgument(1, String.class))
.and(takesArguments(4)),
AbstractNettyChannelPipelineInstrumentation.class.getName() + "$AddAfterAdvice");
}

@SuppressWarnings("unused")
Expand Down Expand Up @@ -114,7 +122,23 @@ public static void removeHandler(
}

@SuppressWarnings("unused")
public static class RemoveFirstLastAdvice {
public static class RemoveFirstAdvice {

@Advice.OnMethodExit(suppress = Throwable.class)
public static void removeHandler(
@Advice.This ChannelPipeline pipeline, @Advice.Return ChannelHandler handler) {
ContextStore<ChannelHandler, ChannelHandler> contextStore =
InstrumentationContext.get(ChannelHandler.class, ChannelHandler.class);
ChannelHandler ourHandler = contextStore.get(handler);
if (ourHandler != null) {
pipeline.remove(ourHandler);
contextStore.put(handler, null);
}
}
}

@SuppressWarnings("unused")
public static class RemoveLastAdvice {

@Advice.OnMethodExit(suppress = Throwable.class)
public static void removeHandler(
Expand All @@ -125,6 +149,30 @@ public static void removeHandler(
if (ourHandler != null) {
pipeline.remove(ourHandler);
contextStore.put(handler, null);
} else if (handler
.getClass()
.getName()
.startsWith("io.opentelemetry.javaagent.instrumentation.netty.")) {
pipeline.removeLast();
Comment on lines +152 to +156
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hmm, what if somebody calls pipeline.addAfter(originalHandler, ...)? Then we'll remove some random custom handler that has nothing to do with our instrumentation. If we want this method to work correctly we should

  1. Maintain a two-way association between the originalHandler and ourHandler (i.e. put ourHandler -> originalHandler into the ContextStore too) and remove the originalHandler whenever removeLast() removes our handler
  2. Instrument addAfter() so that it actually adds the new handler after ourHandler whenever it's associated to the originalHandler

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yes, u r right.Maybe we can instrument addAfter() to make sure ourhandler will always be added after the originalHandler. I'll have a try.

}
}
}

@SuppressWarnings("unused")
public static class AddAfterAdvice {

@Advice.OnMethodEnter(suppress = Throwable.class)
public static void addAfterHandler(
@Advice.This ChannelPipeline pipeline,
@Advice.Argument(value = 1, readOnly = false) String name) {
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you add takesArgument(1, String.class) to the method matcher? In general we aim to enclose all types that we use in advice classes (arguments, return types) in the method matcher.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yes, of course

ChannelHandler handler = pipeline.get(name);
if (handler != null) {
ContextStore<ChannelHandler, ChannelHandler> contextStore =
InstrumentationContext.get(ChannelHandler.class, ChannelHandler.class);
ChannelHandler ourHandler = contextStore.get(handler);
if (ourHandler != null) {
name = ourHandler.getClass().getName();
}
}
}
}
Expand Down
42 changes: 42 additions & 0 deletions instrumentation/netty/netty-4.0/javaagent/src/test/groovy/ChannelPipelineTest.groovy
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -89,6 +89,48 @@ class ChannelPipelineTest extends AgentInstrumentationSpecification {
"by name" | { pipeline, oldName, oldHandler, newName, newHandler -> pipeline.replace(oldName, newName, newHandler) }
}

// regression test for https://github.com/open-telemetry/opentelemetry-java-instrumentation/issues/4056
def "should addAfter and removeLast handler #desc"() {
setup:
def channel = new EmbeddedChannel(new NoopChannelHandler())
def channelPipeline = new DefaultChannelPipeline(channel)
def httpHandler = new HttpClientCodec()

expect: "no handlers initially"
channelPipeline.size() == 0

when:
channelPipeline.addLast("http", httpHandler)

then: "add http and instrumentation handlers"
channelPipeline.size() == 2
channelPipeline.first() == httpHandler
channelPipeline.last().getClass() == HttpClientTracingHandler

when:
def noopHandler = new NoopChannelHandler()
channelPipeline.addAfter("http", "noop", noopHandler)

then: "instrumentation handler is between with http and noop"
channelPipeline.size() == 3
channelPipeline.first() == httpHandler
channelPipeline.last() == noopHandler

when:
channelPipeline.removeLast()

then: "http and instrumentation handlers will be remained"
channelPipeline.size() == 2
channelPipeline.first() == httpHandler
channelPipeline.last().getClass() == HttpClientTracingHandler

when:
channelPipeline.removeLast()

then: "there is no handler in pipeline"
channelPipeline.size() == 0
}

private static class NoopChannelHandler extends ChannelHandlerAdapter {
}
}
42 changes: 42 additions & 0 deletions instrumentation/netty/netty-4.1/javaagent/src/test/groovy/ChannelPipelineTest.groovy
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -87,6 +87,48 @@ class ChannelPipelineTest extends AgentInstrumentationSpecification {
"by name" | { pipeline, oldName, oldHandler, newName, newHandler -> pipeline.replace(oldName, newName, newHandler) }
}

// regression test for https://github.com/open-telemetry/opentelemetry-java-instrumentation/issues/4056
def "should addAfter and removeLast handler #desc"() {
setup:
def channel = new EmbeddedChannel()
def channelPipeline = new DefaultChannelPipeline(channel)
def httpHandler = new HttpClientCodec()

expect: "no handlers initially"
channelPipeline.size() == 0

when:
channelPipeline.addLast("http", httpHandler)

then: "add http and instrumentation handlers"
channelPipeline.size() == 2
channelPipeline.first() == httpHandler
channelPipeline.last().getClass() == HttpClientTracingHandler

when:
def noopHandler = new NoopChannelHandler()
channelPipeline.addAfter("http", "noop", noopHandler)

then: "instrumentation handler is between with http and noop"
channelPipeline.size() == 3
channelPipeline.first() == httpHandler
channelPipeline.last() == noopHandler

when:
channelPipeline.removeLast()

then: "http and instrumentation handlers will be remained"
channelPipeline.size() == 2
channelPipeline.first() == httpHandler
channelPipeline.last().getClass() == HttpClientTracingHandler

when:
channelPipeline.removeLast()

then: "there is no handler in pipeline"
channelPipeline.size() == 0
}

private static class NoopChannelHandler extends ChannelHandlerAdapter {
}
}