Jersey and cxf server span naming (#2919)

Author: laurit

instrumentation/jaxrs/jaxrs-2.0/jaxrs-2.0-common/javaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/jaxrs/v2_0/JaxRsPathUtil.java

@@ -0,0 +1,25 @@
+/*
+ * Copyright The OpenTelemetry Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+package io.opentelemetry.javaagent.instrumentation.jaxrs.v2_0;
+
+public final class JaxRsPathUtil {
+  private JaxRsPathUtil() {}
+
+  public static String normalizePath(String path) {
+    // ensure that non-empty path starts with /
+    if (path == null || "/".equals(path)) {
+      path = "";
+    } else if (!path.startsWith("/")) {
+      path = "/" + path;
+    }
+    // remove trailing /
+    if (path.endsWith("/")) {
+      path = path.substring(0, path.length() - 1);
+    }
+
+    return path;
+  }
+}

instrumentation/jaxrs/jaxrs-2.0/jaxrs-2.0-cxf-3.2/javaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/jaxrs/v2_0/CxfInstrumentationModule.java

@@ -23,6 +23,7 @@ public List<TypeInstrumentation> typeInstrumentations() {
     return asList(
         new CxfRequestContextInstrumentation(),
         new CxfServletControllerInstrumentation(),
-        new CxfRsHttpListenerInstrumentation());
+        new CxfRsHttpListenerInstrumentation(),
+        new CxfJaxRsInvokerInstrumentation());
   }
 }

instrumentation/jaxrs/jaxrs-2.0/jaxrs-2.0-cxf-3.2/javaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/jaxrs/v2_0/CxfJaxRsInvokerInstrumentation.java

@@ -0,0 +1,57 @@
+/*
+ * Copyright The OpenTelemetry Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+package io.opentelemetry.javaagent.instrumentation.jaxrs.v2_0;
+
+import static java.util.Collections.singletonMap;
+import static net.bytebuddy.matcher.ElementMatchers.named;
+import static net.bytebuddy.matcher.ElementMatchers.takesArgument;
+
+import io.opentelemetry.context.Context;
+import io.opentelemetry.context.Scope;
+import io.opentelemetry.javaagent.tooling.TypeInstrumentation;
+import java.util.Map;
+import net.bytebuddy.asm.Advice;
+import net.bytebuddy.description.method.MethodDescription;
+import net.bytebuddy.description.type.TypeDescription;
+import net.bytebuddy.matcher.ElementMatcher;
+import org.apache.cxf.message.Exchange;
+
+public class CxfJaxRsInvokerInstrumentation implements TypeInstrumentation {
+
+  @Override
+  public ElementMatcher<TypeDescription> typeMatcher() {
+    return named("org.apache.cxf.jaxrs.JAXRSInvoker");
+  }
+
+  @Override
+  public Map<? extends ElementMatcher<? super MethodDescription>, String> transformers() {
+    return singletonMap(
+        named("invoke")
+            .and(takesArgument(0, named("org.apache.cxf.message.Exchange")))
+            .and(takesArgument(1, Object.class))
+            .and(takesArgument(2, Object.class)),
+        CxfJaxRsInvokerInstrumentation.class.getName() + "$InvokeAdvice");
+  }
+
+  public static class InvokeAdvice {
+
+    @Advice.OnMethodEnter(suppress = Throwable.class)
+    public static void onEnter(
+        @Advice.Argument(0) Exchange exchange, @Advice.Local("otelScope") Scope scope) {
+      Context context = CxfTracingUtil.updateServerSpanName(exchange);
+      if (context != null) {
+        scope = context.makeCurrent();
+      }
+    }
+
+    @Advice.OnMethodExit(onThrowable = Throwable.class, suppress = Throwable.class)
+    public static void stopSpan(@Advice.Local("otelScope") Scope scope) {
+      if (scope != null) {
+        scope.close();
+      }
+    }
+  }
+}

instrumentation/jaxrs/jaxrs-2.0/jaxrs-2.0-cxf-3.2/javaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/jaxrs/v2_0/CxfTracingUtil.java

@@ -0,0 +1,61 @@
+/*
+ * Copyright The OpenTelemetry Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+package io.opentelemetry.javaagent.instrumentation.jaxrs.v2_0;
+
+import static io.opentelemetry.javaagent.instrumentation.jaxrs.v2_0.JaxRsPathUtil.normalizePath;
+
+import io.opentelemetry.api.trace.Span;
+import io.opentelemetry.context.Context;
+import io.opentelemetry.instrumentation.api.servlet.ServerSpanNaming;
+import io.opentelemetry.instrumentation.api.servlet.ServletContextPath;
+import io.opentelemetry.instrumentation.api.tracer.ServerSpan;
+import io.opentelemetry.javaagent.instrumentation.api.jaxrs.JaxrsContextPath;
+import org.apache.cxf.jaxrs.model.ClassResourceInfo;
+import org.apache.cxf.jaxrs.model.OperationResourceInfo;
+import org.apache.cxf.jaxrs.model.URITemplate;
+import org.apache.cxf.message.Exchange;
+
+public final class CxfTracingUtil {
+
+  private CxfTracingUtil() {}
+
+  public static Context updateServerSpanName(Exchange exchange) {
+    Context context = Context.current();
+    Span serverSpan = ServerSpan.fromContextOrNull(context);
+    if (serverSpan == null) {
+      return null;
+    }
+
+    OperationResourceInfo ori = exchange.get(OperationResourceInfo.class);
+    ClassResourceInfo cri = ori.getClassResourceInfo();
+    String name = getName(cri.getURITemplate(), ori.getURITemplate());
+    if (name.isEmpty()) {
+      return null;
+    }
+
+    serverSpan.updateName(
+        ServletContextPath.prepend(context, JaxrsContextPath.prepend(context, name)));
+    // mark span name as updated from controller to avoid JaxRsAnnotationsTracer updating it
+    ServerSpanNaming.updateSource(context, ServerSpanNaming.Source.CONTROLLER);
+
+    return JaxrsContextPath.init(context, JaxrsContextPath.prepend(context, name));
+  }
+
+  private static String getName(URITemplate classTemplate, URITemplate operationTemplate) {
+    String classPath = normalize(classTemplate);
+    String operationPath = normalize(operationTemplate);
+
+    return classPath + operationPath;
+  }
+
+  private static String normalize(URITemplate uriTemplate) {
+    if (uriTemplate == null) {
+      return "";
+    }
+
+    return normalizePath(uriTemplate.getValue());
+  }
+}

instrumentation/jaxrs/jaxrs-2.0/jaxrs-2.0-cxf-3.2/javaagent/src/test/groovy/CxfHttpServerTest.groovy

@@ -39,9 +39,4 @@ class CxfHttpServerTest extends JaxRsHttpServerTest<Server> {
   void stopServer(Server httpServer) {
     httpServer.stop()
   }
-
-  @Override
-  boolean hasFrameworkInstrumentation() {
-    false
-  }
 }

instrumentation/jaxrs/jaxrs-2.0/jaxrs-2.0-cxf-3.2/javaagent/src/test/groovy/CxfJettyHttpServerTest.groovy

@@ -4,9 +4,4 @@
  */
 
 class CxfJettyHttpServerTest extends JaxRsJettyHttpServerTest {
-
-  @Override
-  boolean hasFrameworkInstrumentation() {
-    false
-  }
 }

instrumentation/jaxrs/jaxrs-2.0/jaxrs-2.0-jersey-2.0/javaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/jaxrs/v2_0/JerseyInstrumentationModule.java

@@ -21,6 +21,8 @@ public JerseyInstrumentationModule() {
   @Override
   public List<TypeInstrumentation> typeInstrumentations() {
     return asList(
-        new JerseyRequestContextInstrumentation(), new JerseyServletContainerInstrumentation());
+        new JerseyRequestContextInstrumentation(),
+        new JerseyServletContainerInstrumentation(),
+        new JerseyResourceMethodDispatcherInstrumentation());
   }
 }

instrumentation/jaxrs/jaxrs-2.0/jaxrs-2.0-jersey-2.0/javaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/jaxrs/v2_0/JerseyResourceMethodDispatcherInstrumentation.java

@@ -0,0 +1,46 @@
+/*
+ * Copyright The OpenTelemetry Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+package io.opentelemetry.javaagent.instrumentation.jaxrs.v2_0;
+
+import static java.util.Collections.singletonMap;
+import static net.bytebuddy.matcher.ElementMatchers.named;
+import static net.bytebuddy.matcher.ElementMatchers.takesArgument;
+
+import io.opentelemetry.javaagent.tooling.TypeInstrumentation;
+import java.util.Map;
+import javax.ws.rs.core.Request;
+import net.bytebuddy.asm.Advice;
+import net.bytebuddy.description.method.MethodDescription;
+import net.bytebuddy.description.type.TypeDescription;
+import net.bytebuddy.matcher.ElementMatcher;
+
+public class JerseyResourceMethodDispatcherInstrumentation implements TypeInstrumentation {
+
+  @Override
+  public ElementMatcher<TypeDescription> typeMatcher() {
+    return named("org.glassfish.jersey.server.model.internal.AbstractJavaResourceMethodDispatcher");
+  }
+
+  @Override
+  public Map<? extends ElementMatcher<? super MethodDescription>, String> transformers() {
+    return singletonMap(
+        named("dispatch")
+            .and(
+                takesArgument(
+                    1,
+                    named("javax.ws.rs.core.Request")
+                        .or(named("org.glassfish.jersey.server.ContainerRequest")))),
+        JerseyResourceMethodDispatcherInstrumentation.class.getName() + "$DispatchAdvice");
+  }
+
+  public static class DispatchAdvice {
+
+    @Advice.OnMethodEnter(suppress = Throwable.class)
+    public static void onEnter(@Advice.Argument(1) Request request) {
+      JerseyTracingUtil.updateServerSpanName(request);
+    }
+  }
+}

instrumentation/jaxrs/jaxrs-2.0/jaxrs-2.0-jersey-2.0/javaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/jaxrs/v2_0/JerseyTracingUtil.java

@@ -0,0 +1,47 @@
+/*
+ * Copyright The OpenTelemetry Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+package io.opentelemetry.javaagent.instrumentation.jaxrs.v2_0;
+
+import static io.opentelemetry.javaagent.instrumentation.jaxrs.v2_0.JaxRsPathUtil.normalizePath;
+
+import io.opentelemetry.api.trace.Span;
+import io.opentelemetry.context.Context;
+import io.opentelemetry.instrumentation.api.servlet.ServerSpanNaming;
+import io.opentelemetry.instrumentation.api.servlet.ServletContextPath;
+import io.opentelemetry.instrumentation.api.tracer.ServerSpan;
+import io.opentelemetry.javaagent.instrumentation.api.jaxrs.JaxrsContextPath;
+import java.util.Optional;
+import javax.ws.rs.core.Request;
+import javax.ws.rs.core.UriInfo;
+import org.glassfish.jersey.server.ContainerRequest;
+import org.glassfish.jersey.server.ExtendedUriInfo;
+
+public class JerseyTracingUtil {
+
+  public static void updateServerSpanName(Request request) {
+    Context context = Context.current();
+    Span serverSpan = ServerSpan.fromContextOrNull(context);
+    if (serverSpan == null) {
+      return;
+    }
+
+    ContainerRequest containerRequest = (ContainerRequest) request;
+    UriInfo uriInfo = containerRequest.getUriInfo();
+    ExtendedUriInfo extendedUriInfo = (ExtendedUriInfo) uriInfo;
+    Optional<String> name =
+        extendedUriInfo.getMatchedTemplates().stream()
+            .map((uriTemplate) -> normalizePath(uriTemplate.getTemplate()))
+            .reduce((a, b) -> b + a);
+    if (!name.isPresent()) {
+      return;
+    }
+
+    serverSpan.updateName(
+        ServletContextPath.prepend(context, JaxrsContextPath.prepend(context, name.get())));
+    // mark span name as updated from controller to avoid JaxRsAnnotationsTracer updating it
+    ServerSpanNaming.updateSource(context, ServerSpanNaming.Source.CONTROLLER);
+  }
+}

instrumentation/jaxrs/jaxrs-2.0/jaxrs-2.0-jersey-2.0/javaagent/src/test/groovy/JerseyHttpServerTest.groovy

@@ -38,7 +38,8 @@ class JerseyHttpServerTest extends JaxRsHttpServerTest<Server> {
   }
 
   @Override
-  boolean hasFrameworkInstrumentation() {
+  boolean testInterfaceMethodWithPath() {
+    // disables a test that jersey deems invalid
     false
   }
 }