Skip to content

Fix continuation leakage on netty http2 client pipeline #11595

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

Open
amarziali wants to merge 2 commits into
base: master
Choose a base branch
from
+138 −8
Open

Fix continuation leakage on netty http2 client pipeline #11595

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3bf8a31
Fix continuation leakage on netty http2 client pipeline
amarziali Jun 8, 2026
b1ed4c7
handle http2 connect failures
amarziali Jun 8, 2026
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
8 changes: 8 additions & 0 deletions .../main/java/datadog/trace/instrumentation/netty41/NettyChannelPipelineInstrumentation.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@
import static datadog.trace.bootstrap.instrumentation.api.AgentTracer.captureActiveSpan;
import static datadog.trace.bootstrap.instrumentation.api.AgentTracer.noopContinuation;
import static datadog.trace.instrumentation.netty41.AttributeKeys.CONNECT_PARENT_CONTINUATION_ATTRIBUTE_KEY;
import static datadog.trace.instrumentation.netty41.AttributeKeys.HTTP2_CONNECTION_CODEC_ATTRIBUTE_KEY;
import static net.bytebuddy.matcher.ElementMatchers.isMethod;
import static net.bytebuddy.matcher.ElementMatchers.returns;
import static net.bytebuddy.matcher.ElementMatchers.takesArgument;
Expand Down Expand Up @@ -175,6 +176,9 @@ public static void addHandler(
handler2 instanceof ChannelHandler ? (ChannelHandler) handler2 : handler3;

try {
if (NettyHttp2Helper.isHttp2ConnectionCodec(handler)) {
pipeline.channel().attr(HTTP2_CONNECTION_CODEC_ATTRIBUTE_KEY).set(Boolean.TRUE);
}
// Server pipeline handlers
if (handler instanceof HttpServerCodec) {
NettyPipelineHelper.addHandlerAfter(
Expand Down Expand Up @@ -250,6 +254,10 @@ else if (handler instanceof HttpClientCodec) {
public static class ConnectAdvice {
@Advice.OnMethodEnter(suppress = Throwable.class)
public static void addParentSpan(@Advice.This final ChannelPipeline pipeline) {
if (Boolean.TRUE.equals(
pipeline.channel().attr(HTTP2_CONNECTION_CODEC_ATTRIBUTE_KEY).get())) {
return;
}
Comment thread
amarziali marked this conversation as resolved.
Outdated
AgentScope.Continuation continuation = captureActiveSpan();
if (continuation != noopContinuation()) {
final Attribute<AgentScope.Continuation> attribute =
Expand Down
21 changes: 21 additions & 0 deletions ...netty/netty-4.1/src/main/java/datadog/trace/instrumentation/netty41/NettyHttp2Helper.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,11 +10,13 @@

public class NettyHttp2Helper {
private static final Class HTTP2_CODEC_CLS;
private static final Class HTTP2_FRAME_CODEC_CLS;
private static final MethodHandle IS_SERVER_FIELD;
private static final Logger LOGGER = LoggerFactory.getLogger(NettyHttp2Helper.class);

static {
Class codecClass;
Class frameCodecClass;
MethodHandle isServerField;
try {
codecClass =
Expand All @@ -38,14 +40,33 @@ public class NettyHttp2Helper {
isServerField = null;
LOGGER.debug("Unable to setup netty http2 instrumentation", t);
}
try {
frameCodecClass =
Class.forName(
"io.netty.handler.codec.http2.Http2FrameCodec",
false,
NettyHttp2Helper.class.getClassLoader());
} catch (final ClassNotFoundException cnfe) {
// can be expected
frameCodecClass = null;
} catch (Throwable t) {
// unexpected
frameCodecClass = null;
LOGGER.debug("Unable to setup netty http2 connection detection", t);
}
HTTP2_CODEC_CLS = codecClass;
HTTP2_FRAME_CODEC_CLS = frameCodecClass;
IS_SERVER_FIELD = isServerField;
}

public static boolean isHttp2FrameCodec(final ChannelHandler handler) {
return HTTP2_CODEC_CLS != null && HTTP2_CODEC_CLS.isInstance(handler);
}

public static boolean isHttp2ConnectionCodec(final ChannelHandler handler) {
return HTTP2_FRAME_CODEC_CLS != null && HTTP2_FRAME_CODEC_CLS.isInstance(handler);
}

public static boolean isServer(final ChannelHandler handler) {
try {
return IS_SERVER_FIELD != null && (boolean) IS_SERVER_FIELD.invokeExact(handler);
Expand Down
16 changes: 14 additions & 2 deletions ...in/java/datadog/trace/instrumentation/netty41/client/HttpClientRequestTracingHandler.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@
import datadog.trace.api.Config;
import datadog.trace.bootstrap.instrumentation.api.AgentScope;
import datadog.trace.bootstrap.instrumentation.api.AgentSpan;
import io.netty.channel.Channel;
import io.netty.channel.ChannelHandler;
import io.netty.channel.ChannelHandlerContext;
import io.netty.channel.ChannelOutboundHandlerAdapter;
Expand Down Expand Up @@ -54,8 +55,7 @@ public void write(final ChannelHandlerContext ctx, final Object msg, final Chann
}

AgentScope parentScope = null;
final AgentScope.Continuation continuation =
ctx.channel().attr(CONNECT_PARENT_CONTINUATION_ATTRIBUTE_KEY).getAndRemove();
final AgentScope.Continuation continuation = takeConnectParentContinuation(ctx);
if (continuation != null) {
parentScope = continuation.activate();
}
Expand Down Expand Up @@ -111,4 +111,16 @@ public void write(final ChannelHandlerContext ctx, final Object msg, final Chann
}
}
}

private static AgentScope.Continuation takeConnectParentContinuation(
final ChannelHandlerContext ctx) {
final Channel channel = ctx.channel();
AgentScope.Continuation continuation =
channel.attr(CONNECT_PARENT_CONTINUATION_ATTRIBUTE_KEY).getAndRemove();
if (continuation == null && channel.parent() != null) {
continuation =
channel.parent().attr(CONNECT_PARENT_CONTINUATION_ATTRIBUTE_KEY).getAndRemove();
}
return continuation;
}
}
3 changes: 3 additions & 0 deletions ...netty/netty-common/src/main/java/datadog/trace/instrumentation/netty41/AttributeKeys.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,9 @@ public final class AttributeKeys {
CONNECT_PARENT_CONTINUATION_ATTRIBUTE_KEY =
attributeKey("datadog.connect.parent.continuation");

public static final AttributeKey<Boolean> HTTP2_CONNECTION_CODEC_ATTRIBUTE_KEY =
attributeKey("datadog.http2.connection.codec");

public static final AttributeKey<Context> PARENT_CONTEXT_ATTRIBUTE_KEY =
attributeKey("datadog.server.parent-context");

Expand Down
5 changes: 0 additions & 5 deletions ...gent/instrumentation/reactor-netty-1.0/src/test/groovy/ReactorNettyHttp2ClientTest.groovy
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,11 +24,6 @@ class ReactorNettyHttp2ClientTest extends InstrumentationSpecification {
.handle { req, res -> res.status(200).send() }
.bindNow()

@Override
boolean useStrictTraceWrites() {
false
}

@Override
def cleanupSpec() {
server?.disposeNow()
Expand Down
Loading