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

Fix netty issue #6469

Merged
merged 3 commits into from
Aug 18, 2022
Merged

Fix netty issue #6469

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
759b8b2
Fix
trask Aug 17, 2022
751d66d
Merge remote-tracking branch 'upstream/main' into fix-netty-issue
trask Aug 18, 2022
280c028
Comment
trask Aug 18, 2022
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
14 changes: 13 additions & 1 deletion ...etry/javaagent/instrumentation/netty/v4/common/client/NettySslInstrumentationHandler.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,11 @@
package io.opentelemetry.javaagent.instrumentation.netty.v4.common.client;

import io.netty.channel.ChannelDuplexHandler;
import io.netty.channel.ChannelHandler;
import io.netty.channel.ChannelHandlerContext;
import io.netty.channel.ChannelPromise;
import io.opentelemetry.context.Context;
import io.opentelemetry.instrumentation.api.util.VirtualField;
import java.lang.invoke.MethodHandle;
import java.lang.invoke.MethodHandles;
import java.lang.invoke.MethodType;
Expand All @@ -20,6 +22,11 @@ public final class NettySslInstrumentationHandler extends ChannelDuplexHandler {
private static final Class<?> SSL_HANDSHAKE_COMPLETION_EVENT;
private static final MethodHandle GET_CAUSE;

// this is used elsewhere to manage the link between the underlying (user) handler and our handler
// which is needed below so that we can unlink this handler when we remove it below
private static final VirtualField<ChannelHandler, ChannelHandler> instrumentationHandlerField =
Copy link
Contributor

Choose a reason for hiding this comment

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

Perhaps here should be a comment that the same virtual field is used elsewhere. Currently it is not obvious what it is for because in this file this virtual field is only set to null.

VirtualField.find(ChannelHandler.class, ChannelHandler.class);

static {
Class<?> sslHandshakeCompletionEvent = null;
MethodHandle getCause = null;
Expand All @@ -41,12 +48,15 @@ public final class NettySslInstrumentationHandler extends ChannelDuplexHandler {
}

private final NettySslInstrumenter instrumenter;
private final ChannelHandler realHandler;
private Context parentContext;
private NettySslRequest request;
private Context context;

public NettySslInstrumentationHandler(NettySslInstrumenter instrumenter) {
public NettySslInstrumentationHandler(
NettySslInstrumenter instrumenter, ChannelHandler realHandler) {
this.instrumenter = instrumenter;
this.realHandler = realHandler;
}

@Override
Expand All @@ -55,6 +65,7 @@ public void channelRegistered(ChannelHandlerContext ctx) {
// are on classpath); checking just to be extra safe
if (SSL_HANDSHAKE_COMPLETION_EVENT == null) {
ctx.pipeline().remove(this);
instrumentationHandlerField.set(realHandler, null);
ctx.fireChannelRegistered();
return;
}
Expand Down Expand Up @@ -94,6 +105,7 @@ public void userEventTriggered(ChannelHandlerContext ctx, Object evt) {
if (SSL_HANDSHAKE_COMPLETION_EVENT.isInstance(evt)) {
if (ctx.pipeline().context(this) != null) {
ctx.pipeline().remove(this);
instrumentationHandlerField.set(realHandler, null);
}

if (context != null) {
Expand Down
2 changes: 1 addition & 1 deletion ...entelemetry/javaagent/instrumentation/netty/v4_0/NettyChannelPipelineInstrumentation.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -95,7 +95,7 @@ public static void addHandler(
// the SslHandler lives in the netty-handler module, using class name comparison to avoid
// adding a dependency
} else if (handler.getClass().getName().equals("io.netty.handler.ssl.SslHandler")) {
ourHandler = new NettySslInstrumentationHandler(sslInstrumenter());
ourHandler = new NettySslInstrumentationHandler(sslInstrumenter(), handler);
}

if (ourHandler != null) {
Expand Down
2 changes: 1 addition & 1 deletion ...entelemetry/javaagent/instrumentation/netty/v4_1/NettyChannelPipelineInstrumentation.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -120,7 +120,7 @@ public static void addHandler(
// the SslHandler lives in the netty-handler module, using class name comparison to avoid
// adding a dependency
} else if (handler.getClass().getName().equals("io.netty.handler.ssl.SslHandler")) {
ourHandler = new NettySslInstrumentationHandler(sslInstrumenter());
ourHandler = new NettySslInstrumentationHandler(sslInstrumenter(), handler);
}

if (ourHandler != null) {
Expand Down