copy/embed all necessary classes.

Author: tylerbenson

instrumentation/servlet/servlet-3.0/javaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/servlet/v3_0/Servlet3Advice.java

@@ -6,11 +6,18 @@
 package io.opentelemetry.javaagent.instrumentation.servlet.v3_0;
 
 import static io.opentelemetry.javaagent.instrumentation.servlet.v3_0.Servlet3Singletons.getSnippetInjectionHelper;
+import static io.opentelemetry.javaagent.instrumentation.servlet.v3_0.Servlet3Singletons.helper;
 
+import io.opentelemetry.context.Context;
+import io.opentelemetry.context.Scope;
 import io.opentelemetry.javaagent.bootstrap.CallDepth;
+import io.opentelemetry.javaagent.bootstrap.http.HttpServerResponseCustomizerHolder;
 import io.opentelemetry.javaagent.bootstrap.servlet.AppServerBridge;
+import io.opentelemetry.javaagent.bootstrap.servlet.MappingResolver;
+import io.opentelemetry.javaagent.instrumentation.servlet.ServletRequestContext;
 import io.opentelemetry.javaagent.instrumentation.servlet.v3_0.snippet.Servlet3SnippetInjectingResponseWrapper;
 import javax.annotation.Nullable;
+import javax.servlet.Servlet;
 import javax.servlet.ServletRequest;
 import javax.servlet.ServletResponse;
 import javax.servlet.http.HttpServletRequest;
@@ -20,8 +27,70 @@
 import net.bytebuddy.asm.Advice.AssignReturned.ToArguments.ToArgument;
 import net.bytebuddy.implementation.bytecode.assign.Assigner;
 
+@SuppressWarnings("unused")
 public class Servlet3Advice {
 
+  public static class AdviceScope {
+    private final CallDepth callDepth;
+    private final ServletRequestContext<HttpServletRequest> requestContext;
+    private final Context context;
+    private final Scope scope;
+
+    public AdviceScope(
+        CallDepth callDepth,
+        HttpServletRequest request,
+        HttpServletResponse response,
+        Object servletOrFilter) {
+      this.callDepth = callDepth;
+      this.callDepth.getAndIncrement();
+
+      Context currentContext = Context.current();
+      Context attachedContext = helper().getServerContext(request);
+      Context contextToUpdate;
+
+      requestContext = new ServletRequestContext<>(request, servletOrFilter);
+      if (attachedContext == null && helper().shouldStart(currentContext, requestContext)) {
+        context = helper().start(currentContext, requestContext);
+        helper().setAsyncListenerResponse(context, response);
+
+        contextToUpdate = context;
+      } else if (attachedContext != null
+          && helper().needsRescoping(currentContext, attachedContext)) {
+        // Given request already has a context associated with it.
+        // see the needsRescoping() javadoc for more explanation
+        contextToUpdate = attachedContext;
+        context = null;
+      } else {
+        // We are inside nested servlet/filter/app-server span, don't create new span
+        contextToUpdate = currentContext;
+        context = null;
+      }
+
+      // Update context with info from current request to ensure that server span gets the best
+      // possible name.
+      // In case server span was created by app server instrumentations calling updateContext
+      // returns a new context that contains servlet context path that is used in other
+      // instrumentations for naming server span.
+      MappingResolver mappingResolver = Servlet3Singletons.getMappingResolver(servletOrFilter);
+      boolean servlet = servletOrFilter instanceof Servlet;
+      contextToUpdate = helper().updateContext(contextToUpdate, request, mappingResolver, servlet);
+      scope = contextToUpdate.makeCurrent();
+
+      if (context != null) {
+        // Only trigger response customizer once, so only if server span was created here
+        HttpServerResponseCustomizerHolder.getCustomizer()
+            .customize(contextToUpdate, response, Servlet3Accessor.INSTANCE);
+      }
+    }
+
+    public void exit(
+        @Nullable Throwable throwable, HttpServletRequest request, HttpServletResponse response) {
+
+      boolean topLevel = callDepth.decrementAndGet() == 0;
+      helper().end(requestContext, request, response, throwable, topLevel, context, scope);
+    }
+  }
+
   @AssignReturned.ToArguments({
     @ToArgument(value = 0, index = 1),
     @ToArgument(value = 1, index = 2)
@@ -45,8 +114,8 @@ public static Object[] onEnter(
       response =
           new Servlet3SnippetInjectingResponseWrapper((HttpServletResponse) response, snippet);
     }
-    Servlet3RequestAdviceScope adviceScope =
-        new Servlet3RequestAdviceScope(
+    AdviceScope adviceScope =
+        new AdviceScope(
             CallDepth.forClass(AppServerBridge.getCallDepthKey()),
             (HttpServletRequest) request,
             (HttpServletResponse) response,
@@ -60,7 +129,7 @@ public static void stopSpan(
       @Advice.Argument(1) ServletResponse response,
       @Advice.Thrown @Nullable Throwable throwable,
       @Advice.Enter Object[] enterResult) {
-    Servlet3RequestAdviceScope adviceScope = (Servlet3RequestAdviceScope) enterResult[0];
+    AdviceScope adviceScope = (AdviceScope) enterResult[0];
     if (adviceScope == null
         || !(request instanceof HttpServletRequest)
         || !(response instanceof HttpServletResponse)) {

instrumentation/servlet/servlet-3.0/javaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/servlet/v3_0/Servlet3ResponseSendAdvice.java

@@ -5,23 +5,67 @@
 
 package io.opentelemetry.javaagent.instrumentation.servlet.v3_0;
 
+import static io.opentelemetry.javaagent.instrumentation.servlet.v3_0.Servlet3Singletons.responseInstrumenter;
+
+import io.opentelemetry.context.Context;
+import io.opentelemetry.context.Scope;
+import io.opentelemetry.instrumentation.api.incubator.semconv.util.ClassAndMethod;
 import io.opentelemetry.javaagent.bootstrap.CallDepth;
+import io.opentelemetry.javaagent.instrumentation.servlet.common.response.HttpServletResponseAdviceHelper;
+import javax.annotation.Nullable;
 import javax.servlet.http.HttpServletResponse;
 import net.bytebuddy.asm.Advice;
 
 @SuppressWarnings("unused")
 public class Servlet3ResponseSendAdvice {
 
+  public static class AdviceScope {
+    private final CallDepth callDepth;
+    private final ClassAndMethod classAndMethod;
+    private final Context context;
+    private final Scope scope;
+
+    public AdviceScope(CallDepth callDepth, Class<?> declaringClass, String methodName) {
+      this.callDepth = callDepth;
+      if (callDepth.getAndIncrement() > 0) {
+        this.classAndMethod = null;
+        this.context = null;
+        this.scope = null;
+        return;
+      }
+      HttpServletResponseAdviceHelper.StartResult result =
+          HttpServletResponseAdviceHelper.startSpan(
+              responseInstrumenter(), declaringClass, methodName);
+      if (result != null) {
+        classAndMethod = result.getClassAndMethod();
+        context = result.getContext();
+        scope = result.getScope();
+      } else {
+        classAndMethod = null;
+        context = null;
+        scope = null;
+      }
+    }
+
+    public void exit(@Nullable Throwable throwable) {
+      if (callDepth.decrementAndGet() > 0) {
+        return;
+      }
+      HttpServletResponseAdviceHelper.stopSpan(
+          responseInstrumenter(), throwable, context, scope, classAndMethod);
+    }
+  }
+
   @Advice.OnMethodEnter(suppress = Throwable.class)
-  public static Servlet3ResponseAdviceScope start(
+  public static AdviceScope start(
       @Advice.Origin("#t") Class<?> declaringClass, @Advice.Origin("#m") String methodName) {
-    return new Servlet3ResponseAdviceScope(
+    return new AdviceScope(
         CallDepth.forClass(HttpServletResponse.class), declaringClass, methodName);
   }
 
   @Advice.OnMethodExit(onThrowable = Throwable.class, suppress = Throwable.class)
   public static void stopSpan(
-      @Advice.Thrown Throwable throwable, @Advice.Enter Servlet3ResponseAdviceScope adviceScope) {
+      @Advice.Thrown Throwable throwable, @Advice.Enter AdviceScope adviceScope) {
     adviceScope.exit(throwable);
   }
 }

instrumentation/servlet/servlet-3.0/library/build.gradle.kts

@@ -4,14 +4,7 @@ plugins {
 
 dependencies {
   library("javax.servlet:javax.servlet-api:3.0.1")
-
-  // FIXME: These dependencies need to be shadowed into the library.
-  library(project(":instrumentation:servlet:servlet-3.0:javaagent"))
-  library(project(":instrumentation:servlet:servlet-common:javaagent"))
-  library(project(":instrumentation:servlet:servlet-common:bootstrap"))
-  library(project(":javaagent-extension-api"))
-
-//  testImplementation(project(":testing:agent-exporter"))
+  library("io.opentelemetry.semconv:opentelemetry-semconv-incubating")
 
   testLibrary("org.eclipse.jetty:jetty-server:8.0.0.v20110901")
   testLibrary("org.eclipse.jetty:jetty-servlet:8.0.0.v20110901")
@@ -21,7 +14,7 @@ dependencies {
 
 tasks {
   withType<Test>().configureEach {
-    // required on jdk17 to allow tomcat to shutdown properly.
+    // required on jdk17+ to allow tomcat to shutdown properly.
     jvmArgs("--add-opens=java.base/java.util=ALL-UNNAMED")
     jvmArgs("-XX:+IgnoreUnrecognizedVMOptions")
   }

instrumentation/servlet/servlet-3.0/library/src/main/java/io/opentelemetry/instrumentation/servlet/v3_0/OpenTelemetryServletFilter.java

@@ -4,12 +4,11 @@
  */
 
 package io.opentelemetry.instrumentation.servlet.v3_0;
+import static io.opentelemetry.instrumentation.servlet.v3_0.copied.Servlet3Singletons.FILTER_MAPPING_RESOLVER;
 
-import static io.opentelemetry.javaagent.instrumentation.servlet.v3_0.Servlet3Singletons.FILTER_MAPPING_RESOLVER;
-
-import io.opentelemetry.javaagent.bootstrap.CallDepth;
-import io.opentelemetry.javaagent.instrumentation.servlet.v3_0.Servlet3FilterMappingResolverFactory;
-import io.opentelemetry.javaagent.instrumentation.servlet.v3_0.Servlet3RequestAdviceScope;
+import io.opentelemetry.instrumentation.servlet.v3_0.copied.CallDepth;
+import io.opentelemetry.instrumentation.servlet.v3_0.copied.Servlet3FilterMappingResolverFactory;
+import io.opentelemetry.instrumentation.servlet.v3_0.copied.Servlet3RequestAdviceScope;
 import java.io.IOException;
 import javax.servlet.Filter;
 import javax.servlet.FilterChain;

instrumentation/servlet/servlet-3.0/library/src/main/java/io/opentelemetry/instrumentation/servlet/v3_0/OtelAsyncContext.java

@@ -5,7 +5,7 @@
 
 package io.opentelemetry.instrumentation.servlet.v3_0;
 
-import static io.opentelemetry.javaagent.instrumentation.servlet.v3_0.Servlet3Singletons.helper;
+import static io.opentelemetry.instrumentation.servlet.v3_0.copied.Servlet3Singletons.helper;
 
 import javax.servlet.AsyncContext;
 import javax.servlet.AsyncListener;

instrumentation/servlet/servlet-3.0/library/src/main/java/io/opentelemetry/instrumentation/servlet/v3_0/OtelHttpServletRequest.java

@@ -5,7 +5,7 @@
 
 package io.opentelemetry.instrumentation.servlet.v3_0;
 
-import static io.opentelemetry.javaagent.instrumentation.servlet.v3_0.Servlet3Singletons.helper;
+import static io.opentelemetry.instrumentation.servlet.v3_0.copied.Servlet3Singletons.helper;
 
 import io.opentelemetry.context.Context;
 import javax.servlet.AsyncContext;

instrumentation/servlet/servlet-3.0/library/src/main/java/io/opentelemetry/instrumentation/servlet/v3_0/OtelHttpServletResponse.java

@@ -5,8 +5,8 @@
 
 package io.opentelemetry.instrumentation.servlet.v3_0;
 
-import io.opentelemetry.javaagent.bootstrap.CallDepth;
-import io.opentelemetry.javaagent.instrumentation.servlet.v3_0.Servlet3ResponseAdviceScope;
+import io.opentelemetry.instrumentation.servlet.v3_0.copied.CallDepth;
+import io.opentelemetry.instrumentation.servlet.v3_0.copied.Servlet3ResponseAdviceScope;
 import java.io.IOException;
 import javax.servlet.http.HttpServletResponse;
 import javax.servlet.http.HttpServletResponseWrapper;

instrumentation/servlet/servlet-3.0/library/src/main/java/io/opentelemetry/instrumentation/servlet/v3_0/copied/AgentCommonConfig.java

@@ -0,0 +1,22 @@
+/*
+ * Copyright The OpenTelemetry Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+package io.opentelemetry.instrumentation.servlet.v3_0.copied;
+
+import io.opentelemetry.instrumentation.api.incubator.config.internal.CommonConfig;
+
+/**
+ * This class is internal and is hence not for public use. Its APIs are unstable and can change at
+ * any time.
+ */
+public class AgentCommonConfig {
+  private AgentCommonConfig() {}
+
+  private static final CommonConfig instance = new CommonConfig(AgentInstrumentationConfig.get());
+
+  public static CommonConfig get() {
+    return instance;
+  }
+}

instrumentation/servlet/servlet-3.0/library/src/main/java/io/opentelemetry/instrumentation/servlet/v3_0/copied/AgentInstrumentationConfig.java

@@ -0,0 +1,47 @@
+/*
+ * Copyright The OpenTelemetry Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+package io.opentelemetry.instrumentation.servlet.v3_0.copied;
+
+import static java.util.Objects.requireNonNull;
+
+import io.opentelemetry.instrumentation.api.incubator.config.internal.InstrumentationConfig;
+import java.util.logging.Logger;
+
+/**
+ * This class is internal and is hence not for public use. Its APIs are unstable and can change at
+ * any time.
+ */
+public class AgentInstrumentationConfig {
+  private AgentInstrumentationConfig() {}
+
+  private static final Logger logger = Logger.getLogger(AgentInstrumentationConfig.class.getName());
+
+  private static final InstrumentationConfig DEFAULT = new EmptyInstrumentationConfig();
+
+  // lazy initialized, so that javaagent can set it
+  private static volatile InstrumentationConfig instance = DEFAULT;
+
+  /**
+   * Sets the instrumentation configuration singleton. This method is only supposed to be called
+   * once, during the agent initialization, just before {@link AgentInstrumentationConfig#get()} is
+   * used for the first time.
+   *
+   * <p>This method is internal and is hence not for public use. Its API is unstable and can change
+   * at any time.
+   */
+  public static void internalInitializeConfig(InstrumentationConfig config) {
+    if (instance != DEFAULT) {
+      logger.warning("InstrumentationConfig#instance was already set earlier");
+      return;
+    }
+    instance = requireNonNull(config);
+  }
+
+  /** Returns the global instrumentation configuration. */
+  public static InstrumentationConfig get() {
+    return instance;
+  }
+}