Skip to content

Fix classloading issue: put object holders into bootstrap classloader #256

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

Merged
merged 1 commit into from
Feb 8, 2021
Merged

Fix classloading issue: put object holders into bootstrap classloader #256

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
11 changes: 5 additions & 6 deletions ...avaagent/instrumentation/hypertrace/servlet/v3_0/nowrapping/BodyCaptureAsyncListener.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,8 +18,6 @@

import io.opentelemetry.api.trace.Span;
import io.opentelemetry.javaagent.instrumentation.api.ContextStore;
import io.opentelemetry.javaagent.instrumentation.hypertrace.servlet.v3_0.nowrapping.request.RequestStreamReaderHolder;
import io.opentelemetry.javaagent.instrumentation.hypertrace.servlet.v3_0.nowrapping.response.ResponseStreamWriterHolder;
import java.io.BufferedReader;
import java.io.PrintWriter;
import java.util.concurrent.atomic.AtomicBoolean;
Expand All @@ -34,6 +32,7 @@
import org.hypertrace.agent.config.Config.AgentConfig;
import org.hypertrace.agent.core.config.HypertraceConfig;
import org.hypertrace.agent.core.instrumentation.HypertraceSemanticAttributes;
import org.hypertrace.agent.core.instrumentation.SpanAndObjectPair;
import org.hypertrace.agent.core.instrumentation.buffer.BoundedByteArrayOutputStream;
import org.hypertrace.agent.core.instrumentation.buffer.BoundedCharArrayWriter;
import org.hypertrace.agent.core.instrumentation.buffer.ByteBufferSpanPair;
Expand All @@ -45,11 +44,11 @@ public class BodyCaptureAsyncListener implements AsyncListener {
private final AtomicBoolean responseHandled;
private final Span span;

private final ContextStore<HttpServletResponse, ResponseStreamWriterHolder> responseContextStore;
private final ContextStore<HttpServletResponse, SpanAndObjectPair> responseContextStore;
private final ContextStore<ServletOutputStream, BoundedByteArrayOutputStream> streamContextStore;
private final ContextStore<PrintWriter, BoundedCharArrayWriter> writerContextStore;

private final ContextStore<HttpServletRequest, RequestStreamReaderHolder> requestContextStore;
private final ContextStore<HttpServletRequest, SpanAndObjectPair> requestContextStore;
private final ContextStore<ServletInputStream, ByteBufferSpanPair> inputStreamContextStore;
private final ContextStore<BufferedReader, CharBufferSpanPair> readerContextStore;

Expand All @@ -58,10 +57,10 @@ public class BodyCaptureAsyncListener implements AsyncListener {
public BodyCaptureAsyncListener(
AtomicBoolean responseHandled,
Span span,
ContextStore<HttpServletResponse, ResponseStreamWriterHolder> responseContextStore,
ContextStore<HttpServletResponse, SpanAndObjectPair> responseContextStore,
ContextStore<ServletOutputStream, BoundedByteArrayOutputStream> streamContextStore,
ContextStore<PrintWriter, BoundedCharArrayWriter> writerContextStore,
ContextStore<HttpServletRequest, RequestStreamReaderHolder> requestContextStore,
ContextStore<HttpServletRequest, SpanAndObjectPair> requestContextStore,
ContextStore<ServletInputStream, ByteBufferSpanPair> inputStreamContextStore,
ContextStore<BufferedReader, CharBufferSpanPair> readerContextStore) {
this.responseHandled = responseHandled;
Expand Down
18 changes: 8 additions & 10 deletions ...nstrumentation/hypertrace/servlet/v3_0/nowrapping/Servlet31NoWrappingInstrumentation.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,8 +28,6 @@
import io.opentelemetry.javaagent.instrumentation.api.ContextStore;
import io.opentelemetry.javaagent.instrumentation.api.InstrumentationContext;
import io.opentelemetry.javaagent.instrumentation.api.Java8BytecodeBridge;
import io.opentelemetry.javaagent.instrumentation.hypertrace.servlet.v3_0.nowrapping.request.RequestStreamReaderHolder;
import io.opentelemetry.javaagent.instrumentation.hypertrace.servlet.v3_0.nowrapping.response.ResponseStreamWriterHolder;
import io.opentelemetry.javaagent.tooling.TypeInstrumentation;
import java.io.BufferedReader;
import java.io.PrintWriter;
Expand All @@ -51,6 +49,7 @@
import org.hypertrace.agent.config.Config.AgentConfig;
import org.hypertrace.agent.core.config.HypertraceConfig;
import org.hypertrace.agent.core.instrumentation.HypertraceSemanticAttributes;
import org.hypertrace.agent.core.instrumentation.SpanAndObjectPair;
import org.hypertrace.agent.core.instrumentation.buffer.BoundedByteArrayOutputStream;
import org.hypertrace.agent.core.instrumentation.buffer.BoundedCharArrayWriter;
import org.hypertrace.agent.core.instrumentation.buffer.ByteBufferSpanPair;
Expand Down Expand Up @@ -103,8 +102,8 @@ public static boolean start(
&& ContentTypeUtils.shouldCapture(contentType)) {
// The HttpServletRequest instrumentation uses this to
// enable the instrumentation
InstrumentationContext.get(HttpServletRequest.class, RequestStreamReaderHolder.class)
.put(httpRequest, new RequestStreamReaderHolder(currentSpan));
InstrumentationContext.get(HttpServletRequest.class, SpanAndObjectPair.class)
.put(httpRequest, new SpanAndObjectPair(currentSpan));
}

Utils.addSessionId(currentSpan, httpRequest);
Expand Down Expand Up @@ -152,18 +151,17 @@ public static void exit(
HttpServletRequest httpRequest = (HttpServletRequest) request;
AgentConfig agentConfig = HypertraceConfig.get();

// response context to capture body and clear the context
ContextStore<HttpServletResponse, SpanAndObjectPair> responseContextStore =
InstrumentationContext.get(HttpServletResponse.class, SpanAndObjectPair.class);
ContextStore<ServletOutputStream, BoundedByteArrayOutputStream> outputStreamContextStore =
InstrumentationContext.get(ServletOutputStream.class, BoundedByteArrayOutputStream.class);
ContextStore<PrintWriter, BoundedCharArrayWriter> writerContextStore =
InstrumentationContext.get(PrintWriter.class, BoundedCharArrayWriter.class);

// response context to capture body and clear the context
ContextStore<HttpServletResponse, ResponseStreamWriterHolder> responseContextStore =
InstrumentationContext.get(HttpServletResponse.class, ResponseStreamWriterHolder.class);

// request context to clear body buffer
ContextStore<HttpServletRequest, RequestStreamReaderHolder> requestContextStore =
InstrumentationContext.get(HttpServletRequest.class, RequestStreamReaderHolder.class);
ContextStore<HttpServletRequest, SpanAndObjectPair> requestContextStore =
InstrumentationContext.get(HttpServletRequest.class, SpanAndObjectPair.class);
ContextStore<ServletInputStream, ByteBufferSpanPair> inputStreamContextStore =
InstrumentationContext.get(ServletInputStream.class, ByteBufferSpanPair.class);
ContextStore<BufferedReader, CharBufferSpanPair> readerContextStore =
Expand Down
8 changes: 3 additions & 5 deletions ...entation/hypertrace/servlet/v3_0/nowrapping/Servlet31NoWrappingInstrumentationModule.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,10 +19,8 @@
import static io.opentelemetry.javaagent.tooling.bytebuddy.matcher.ClassLoaderMatcher.hasClassesNamed;

import com.google.auto.service.AutoService;
import io.opentelemetry.javaagent.instrumentation.hypertrace.servlet.v3_0.nowrapping.request.RequestStreamReaderHolder;
import io.opentelemetry.javaagent.instrumentation.hypertrace.servlet.v3_0.nowrapping.request.ServletInputStreamInstrumentation;
import io.opentelemetry.javaagent.instrumentation.hypertrace.servlet.v3_0.nowrapping.request.ServletRequestInstrumentation;
import io.opentelemetry.javaagent.instrumentation.hypertrace.servlet.v3_0.nowrapping.response.ResponseStreamWriterHolder;
import io.opentelemetry.javaagent.instrumentation.hypertrace.servlet.v3_0.nowrapping.response.ServletOutputStreamInstrumentation;
import io.opentelemetry.javaagent.instrumentation.hypertrace.servlet.v3_0.nowrapping.response.ServletResponseInstrumentation;
import io.opentelemetry.javaagent.tooling.InstrumentationModule;
Expand All @@ -32,6 +30,7 @@
import java.util.List;
import java.util.Map;
import net.bytebuddy.matcher.ElementMatcher;
import org.hypertrace.agent.core.instrumentation.SpanAndObjectPair;
import org.hypertrace.agent.core.instrumentation.buffer.BoundedByteArrayOutputStream;
import org.hypertrace.agent.core.instrumentation.buffer.BoundedCharArrayWriter;
import org.hypertrace.agent.core.instrumentation.buffer.ByteBufferSpanPair;
Expand Down Expand Up @@ -68,13 +67,12 @@ public List<TypeInstrumentation> typeInstrumentations() {
protected Map<String, String> contextStore() {
Map<String, String> context = new HashMap<>();
// capture request body
context.put("javax.servlet.http.HttpServletRequest", RequestStreamReaderHolder.class.getName());
context.put("javax.servlet.http.HttpServletRequest", SpanAndObjectPair.class.getName());
context.put("javax.servlet.ServletInputStream", ByteBufferSpanPair.class.getName());
context.put("java.io.BufferedReader", CharBufferSpanPair.class.getName());

// capture response body
context.put(
"javax.servlet.http.HttpServletResponse", ResponseStreamWriterHolder.class.getName());
context.put("javax.servlet.http.HttpServletResponse", SpanAndObjectPair.class.getName());
context.put("javax.servlet.ServletOutputStream", BoundedByteArrayOutputStream.class.getName());
context.put("java.io.PrintWriter", BoundedCharArrayWriter.class.getName());
return context;
Expand Down
35 changes: 16 additions & 19 deletions .../io/opentelemetry/javaagent/instrumentation/hypertrace/servlet/v3_0/nowrapping/Utils.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,8 +18,6 @@

import io.opentelemetry.api.trace.Span;
import io.opentelemetry.javaagent.instrumentation.api.ContextStore;
import io.opentelemetry.javaagent.instrumentation.hypertrace.servlet.v3_0.nowrapping.request.RequestStreamReaderHolder;
import io.opentelemetry.javaagent.instrumentation.hypertrace.servlet.v3_0.nowrapping.response.ResponseStreamWriterHolder;
import java.io.BufferedReader;
import java.io.PrintWriter;
import java.io.UnsupportedEncodingException;
Expand All @@ -29,6 +27,7 @@
import javax.servlet.http.HttpServletResponse;
import javax.servlet.http.HttpSession;
import org.hypertrace.agent.core.instrumentation.HypertraceSemanticAttributes;
import org.hypertrace.agent.core.instrumentation.SpanAndObjectPair;
import org.hypertrace.agent.core.instrumentation.buffer.BoundedByteArrayOutputStream;
import org.hypertrace.agent.core.instrumentation.buffer.BoundedCharArrayWriter;
import org.hypertrace.agent.core.instrumentation.buffer.ByteBufferSpanPair;
Expand All @@ -50,19 +49,19 @@ public static void addSessionId(Span span, HttpServletRequest httpRequest) {
public static void captureResponseBody(
Span span,
HttpServletResponse httpServletResponse,
ContextStore<HttpServletResponse, ResponseStreamWriterHolder> responseContextStore,
ContextStore<HttpServletResponse, SpanAndObjectPair> responseContextStore,
ContextStore<ServletOutputStream, BoundedByteArrayOutputStream> streamContextStore,
ContextStore<PrintWriter, BoundedCharArrayWriter> writerContextStore) {

ResponseStreamWriterHolder responseStreamWriterHolder =
responseContextStore.get(httpServletResponse);
SpanAndObjectPair responseStreamWriterHolder = responseContextStore.get(httpServletResponse);
if (responseStreamWriterHolder == null) {
return;
}
responseContextStore.put(httpServletResponse, null);

if (responseStreamWriterHolder.getServletOutputStream() != null) {
ServletOutputStream servletOutputStream = responseStreamWriterHolder.getServletOutputStream();
if (responseStreamWriterHolder.getAssociatedObject() instanceof ServletOutputStream) {
ServletOutputStream servletOutputStream =
(ServletOutputStream) responseStreamWriterHolder.getAssociatedObject();
BoundedByteArrayOutputStream buffer = streamContextStore.get(servletOutputStream);
if (buffer != null) {
try {
Expand All @@ -74,10 +73,8 @@ public static void captureResponseBody(
}
streamContextStore.put(servletOutputStream, null);
}
}

if (responseStreamWriterHolder.getPrintWriter() != null) {
PrintWriter printWriter = responseStreamWriterHolder.getPrintWriter();
} else if (responseStreamWriterHolder.getAssociatedObject() instanceof PrintWriter) {
PrintWriter printWriter = (PrintWriter) responseStreamWriterHolder.getAssociatedObject();
BoundedCharArrayWriter buffer = writerContextStore.get(printWriter);
if (buffer != null) {
span.setAttribute(HypertraceSemanticAttributes.HTTP_RESPONSE_BODY, buffer.toString());
Expand All @@ -88,22 +85,22 @@ public static void captureResponseBody(

public static void resetRequestBodyBuffers(
HttpServletRequest httpServletRequest,
ContextStore<HttpServletRequest, RequestStreamReaderHolder> requestContextStore,
ContextStore<HttpServletRequest, SpanAndObjectPair> requestContextStore,
ContextStore<ServletInputStream, ByteBufferSpanPair> streamContextStore,
ContextStore<BufferedReader, CharBufferSpanPair> bufferedReaderContextStore) {

RequestStreamReaderHolder requestStreamReaderHolder =
requestContextStore.get(httpServletRequest);
SpanAndObjectPair requestStreamReaderHolder = requestContextStore.get(httpServletRequest);
if (requestContextStore == null) {
return;
}
requestContextStore.put(httpServletRequest, null);

if (requestStreamReaderHolder.getServletInputStream() != null) {
streamContextStore.put(requestStreamReaderHolder.getServletInputStream(), null);
}
if (requestStreamReaderHolder.getBufferedReader() != null) {
bufferedReaderContextStore.put(requestStreamReaderHolder.getBufferedReader(), null);
if (requestStreamReaderHolder.getAssociatedObject() instanceof ServletInputStream) {
streamContextStore.put(
(ServletInputStream) requestStreamReaderHolder.getAssociatedObject(), null);
} else if (requestStreamReaderHolder.getAssociatedObject() instanceof BufferedReader) {
bufferedReaderContextStore.put(
(BufferedReader) requestStreamReaderHolder.getAssociatedObject(), null);
}
}
}
35 changes: 17 additions & 18 deletions ...rumentation/hypertrace/servlet/v3_0/nowrapping/request/ServletRequestInstrumentation.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,7 @@
import net.bytebuddy.description.type.TypeDescription;
import net.bytebuddy.matcher.ElementMatcher;
import net.bytebuddy.matcher.ElementMatcher.Junction;
import org.hypertrace.agent.core.instrumentation.SpanAndObjectPair;
import org.hypertrace.agent.core.instrumentation.buffer.ByteBufferSpanPair;
import org.hypertrace.agent.core.instrumentation.buffer.CharBufferSpanPair;

Expand Down Expand Up @@ -67,11 +68,11 @@ public Map<? extends ElementMatcher<? super MethodDescription>, String> transfor

static class ServletRequest_getInputStream_advice {
@Advice.OnMethodEnter(suppress = Throwable.class)
public static RequestStreamReaderHolder enter(@Advice.This ServletRequest servletRequest) {
public static SpanAndObjectPair enter(@Advice.This ServletRequest servletRequest) {
HttpServletRequest httpServletRequest = (HttpServletRequest) servletRequest;
// span is added in servlet/filter instrumentation if data capture is enabled
RequestStreamReaderHolder requestBufferWrapper =
InstrumentationContext.get(HttpServletRequest.class, RequestStreamReaderHolder.class)
SpanAndObjectPair requestBufferWrapper =
InstrumentationContext.get(HttpServletRequest.class, SpanAndObjectPair.class)
.get(httpServletRequest);
if (requestBufferWrapper == null) {
return null;
Expand All @@ -87,9 +88,9 @@ public static void exit(
@Advice.This ServletRequest servletRequest,
@Advice.Return ServletInputStream servletInputStream,
@Advice.Thrown Throwable throwable,
@Advice.Enter RequestStreamReaderHolder requestStreamReaderHolder) {
@Advice.Enter SpanAndObjectPair spanAndObjectPair) {

if (requestStreamReaderHolder == null) {
if (spanAndObjectPair == null) {
return;
}

Expand All @@ -111,36 +112,35 @@ public static void exit(
}

ByteBufferSpanPair bufferSpanPair =
Utils.createRequestByteBufferSpanPair(
httpServletRequest, requestStreamReaderHolder.getSpan());
Utils.createRequestByteBufferSpanPair(httpServletRequest, spanAndObjectPair.getSpan());
contextStore.put(servletInputStream, bufferSpanPair);
requestStreamReaderHolder.setServletInputStream(servletInputStream);
spanAndObjectPair.setAssociatedObject(servletInputStream);
}
}

static class ServletRequest_getReader_advice {
@Advice.OnMethodEnter(suppress = Throwable.class)
public static RequestStreamReaderHolder enter(@Advice.This ServletRequest servletRequest) {
public static SpanAndObjectPair enter(@Advice.This ServletRequest servletRequest) {
HttpServletRequest httpServletRequest = (HttpServletRequest) servletRequest;
RequestStreamReaderHolder requestStreamReaderHolder =
InstrumentationContext.get(HttpServletRequest.class, RequestStreamReaderHolder.class)
SpanAndObjectPair spanAndObjectPair =
InstrumentationContext.get(HttpServletRequest.class, SpanAndObjectPair.class)
.get(httpServletRequest);
if (requestStreamReaderHolder == null) {
if (spanAndObjectPair == null) {
return null;
}

CallDepthThreadLocalMap.incrementCallDepth(ServletRequest.class);
return requestStreamReaderHolder;
return spanAndObjectPair;
}

@Advice.OnMethodExit(suppress = Throwable.class, onThrowable = Throwable.class)
public static void exit(
@Advice.This ServletRequest servletRequest,
@Advice.Return BufferedReader reader,
@Advice.Thrown Throwable throwable,
@Advice.Enter RequestStreamReaderHolder requestStreamReaderHolder) {
@Advice.Enter SpanAndObjectPair spanAndObjectPair) {

if (requestStreamReaderHolder == null) {
if (spanAndObjectPair == null) {
return;
}

Expand All @@ -162,10 +162,9 @@ public static void exit(
}

CharBufferSpanPair bufferSpanPair =
Utils.createRequestCharBufferSpanPair(
httpServletRequest, requestStreamReaderHolder.getSpan());
Utils.createRequestCharBufferSpanPair(httpServletRequest, spanAndObjectPair.getSpan());
contextStore.put(reader, bufferSpanPair);
requestStreamReaderHolder.setBufferedReader(reader);
spanAndObjectPair.setAssociatedObject(reader);
}
}
}
44 changes: 0 additions & 44 deletions ...strumentation/hypertrace/servlet/v3_0/nowrapping/response/ResponseStreamWriterHolder.java
View file
Open in desktop

This file was deleted.

Loading