feat(pekko): add tapir path matching instrumentation

Author: masonedmison

instrumentation/pekko/pekko-http-1.0/javaagent/build.gradle.kts

@@ -10,28 +10,57 @@ muzzle {
     versions.set("[1.0,)")
     assertInverse.set(true)
     extraDependency("org.apache.pekko:pekko-stream_2.12:1.0.1")
+    extraDependency("com.softwaremill.sttp.tapir:tapir-server_2.12:1.7.0")
+    extraDependency("com.softwaremill.sttp.tapir:tapir-core_2.12:1.7.0")
   }
   pass {
     group.set("org.apache.pekko")
     module.set("pekko-http_2.13")
     versions.set("[1.0,)")
     assertInverse.set(true)
     extraDependency("org.apache.pekko:pekko-stream_2.13:1.0.1")
+    extraDependency("com.softwaremill.sttp.tapir:tapir-server_2.12:1.7.0")
+    extraDependency("com.softwaremill.sttp.tapir:tapir-core_2.12:1.7.0")
   }
   pass {
     group.set("org.apache.pekko")
     module.set("pekko-http_3")
     versions.set("[1.0,)")
     assertInverse.set(true)
     extraDependency("org.apache.pekko:pekko-stream_3:1.0.1")
+    extraDependency("com.softwaremill.sttp.tapir:tapir-server_2.12:1.7.0")
+    extraDependency("com.softwaremill.sttp.tapir:tapir-core_2.12:1.7.0")
+  }
+  pass {
+    group.set("sttp.tapir_2.12")
+    module.set("tapir-pekko-http-server")
+    versions.set("[1.7,)")
+    assertInverse.set(true)
+    extraDependency("com.softwaremill.sttp.tapir:tapir-server_2.12:1.7.0")
+    extraDependency("com.softwaremill.sttp.tapir:tapir-core_2.12:1.7.0")
+  }
+  pass {
+    group.set("sttp.tapir_2.13")
+    module.set("tapir-pekko-http-server")
+    versions.set("[1.7,)")
+    assertInverse.set(true)
+    extraDependency("com.softwaremill.sttp.tapir:tapir-server_2.13:1.7.0")
+    extraDependency("com.softwaremill.sttp.tapir:tapir-core_2.13:1.7.0")
+  }
+  pass {
+    group.set("sttp.tapir_3")
+    module.set("tapir-pekko-http-server")
+    versions.set("[1.7,)")
+    assertInverse.set(true)
+    extraDependency("com.softwaremill.sttp.tapir:tapir-server_3:1.7.0")
+    extraDependency("com.softwaremill.sttp.tapir:tapir-core_3:1.7.0")
   }
 }
 
 dependencies {
   library("org.apache.pekko:pekko-http_2.12:1.0.0")
   library("org.apache.pekko:pekko-stream_2.12:1.0.1")
-
-  testImplementation("com.softwaremill.sttp.tapir:tapir-pekko-http-server_2.12:1.7.0")
+  library("com.softwaremill.sttp.tapir:tapir-pekko-http-server_2.12:1.7.0")
 
   testInstrumentation(project(":instrumentation:pekko:pekko-actor-1.0:javaagent"))
   testInstrumentation(project(":instrumentation:executors:javaagent"))

instrumentation/pekko/pekko-http-1.0/javaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/pekkohttp/v1_0/server/route/PekkoHttpServerRouteInstrumentationModule.java

@@ -32,6 +32,7 @@ public String getModuleGroup() {
   @Override
   public List<TypeInstrumentation> typeInstrumentations() {
     return asList(
+        new TapirPathInstrumentation(),
         new PathMatcherInstrumentation(),
         new PathMatcherStaticInstrumentation(),
         new RouteConcatenationInstrumentation(),

instrumentation/pekko/pekko-http-1.0/javaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/pekkohttp/v1_0/server/route/TapirPathInstrumentation.java

@@ -0,0 +1,100 @@
+/*
+ * Copyright The OpenTelemetry Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+package io.opentelemetry.javaagent.instrumentation.pekkohttp.v1_0.server.route;
+
+import static net.bytebuddy.matcher.ElementMatchers.named;
+import static net.bytebuddy.matcher.ElementMatchers.takesArgument;
+
+import io.opentelemetry.javaagent.extension.instrumentation.TypeInstrumentation;
+import io.opentelemetry.javaagent.extension.instrumentation.TypeTransformer;
+import net.bytebuddy.asm.Advice;
+import net.bytebuddy.description.type.TypeDescription;
+import net.bytebuddy.matcher.ElementMatcher;
+import org.apache.pekko.http.scaladsl.server.RequestContext;
+import org.apache.pekko.http.scaladsl.server.RouteResult;
+import scala.Function1;
+import scala.Function2;
+import scala.Option;
+import scala.PartialFunction;
+import scala.Unit;
+import scala.concurrent.Future;
+import scala.util.Try;
+import sttp.tapir.EndpointInput;
+import sttp.tapir.server.ServerEndpoint;
+
+public class TapirPathInstrumentation implements TypeInstrumentation {
+
+  @Override
+  public ElementMatcher<TypeDescription> typeMatcher() {
+    return named("sttp.tapir.server.pekkohttp.PekkoHttpServerInterpreter");
+  }
+
+  @Override
+  public void transform(TypeTransformer transformer) {
+    transformer.applyAdviceToMethod(
+        named("toRoute").and(takesArgument(0, named("sttp.tapir.server.ServerEndpoint"))),
+        this.getClass().getName() + "$ApplyAdvice");
+  }
+
+  public static class RouteWrapper implements Function1<RequestContext, Future<RouteResult>> {
+    private final Function1<RequestContext, Future<RouteResult>> route;
+    private final ServerEndpoint<?, ?> serverEndpoint;
+
+    public RouteWrapper(
+        ServerEndpoint<?, ?> serverEndpoint, Function1<RequestContext, Future<RouteResult>> route) {
+      this.route = route;
+      this.serverEndpoint = serverEndpoint;
+    }
+
+    public class Finalizer implements PartialFunction<Try<RouteResult>, Unit> {
+      @Override
+      public boolean isDefinedAt(Try<RouteResult> x) {
+        return true;
+      }
+
+      @Override
+      public Unit apply(Try<RouteResult> tryResult) {
+        if (tryResult.isSuccess()) {
+          RouteResult result = tryResult.get();
+          if (result.getClass() == RouteResult.Complete.class) {
+            String path =
+                serverEndpoint.showPathTemplate(
+                    (index, pc) ->
+                        pc.name().isDefined()
+                            ? "{" + pc.name().get() + "}"
+                            : "{param" + index + "}",
+                    Option.apply(
+                        (Function2<Object, EndpointInput.Query<?>, String>)
+                            (index, q) -> q.name() + "={" + q.name() + "}"),
+                    false,
+                    "*",
+                    Option.apply("*"),
+                    Option.apply("*"));
+
+            PekkoRouteHolder.push(path);
+            PekkoRouteHolder.endMatched();
+          }
+        }
+        return null;
+      }
+    }
+
+    @Override
+    public Future<RouteResult> apply(RequestContext ctx) {
+      return route.apply(ctx).andThen(new Finalizer(), ctx.executionContext());
+    }
+  }
+
+  @SuppressWarnings("unused")
+  public static class ApplyAdvice {
+    @Advice.OnMethodExit(onThrowable = Throwable.class, suppress = Throwable.class)
+    public static void onExit(
+        @Advice.Argument(0) ServerEndpoint<?, ?> endpoint,
+        @Advice.Return(readOnly = false) Function1<RequestContext, Future<RouteResult>> route) {
+      route = new RouteWrapper(endpoint, route);
+    }
+  }
+}

instrumentation/pekko/pekko-http-1.0/javaagent/src/test/scala/io/opentelemetry/javaagent/instrumentation/pekkohttp/v1_0/PekkoHttpServerRouteTest.scala

@@ -96,7 +96,7 @@ class PekkoHttpServerRouteTest {
       concat(makeRoute("test" / "3"), makeRoute("test" / "4"))
     )
 
-    test(routes, "/test/4", "GET")
+    test(routes, "/test/4", "GET /test/4")
   }
 
   def test(route: Route, path: String, spanName: String): Unit = {