Instrumentation for redisson 3.17.2

instrumentation/redisson-3.0/javaagent/build.gradle.kts → instrumentation/redisson/redisson-3.0/javaagent/build.gradle.kts

@@ -6,18 +6,23 @@ muzzle {
   pass {
     group.set("org.redisson")
     module.set("redisson")
-    versions.set("[3.0.0,3.17.2)")
+    versions.set("[3.0.0,3.17.0)")
   }
 }
 
 dependencies {
   library("org.redisson:redisson:3.0.0")
 
-  // TODO (trask) split out instrumentation into two modules and support 3.17.2+
-  latestDepTestLibrary("org.redisson:redisson:3.17.1")
+  implementation(project(":instrumentation:redisson:redisson-common:javaagent"))
 
   compileOnly("com.google.auto.value:auto-value-annotations")
   annotationProcessor("com.google.auto.value:auto-value")
+
+  testInstrumentation(project(":instrumentation:redisson:redisson-3.17:javaagent"))
+
+  testImplementation(project(":instrumentation:redisson:redisson-common:testing"))
+
+  latestDepTestLibrary("org.redisson:redisson:3.16.8")
 }
 
 tasks.test {

instrumentation/redisson-3.0/javaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/redisson/RedisCommandDataInstrumentation.java → instrumentation/redisson/redisson-3.0/javaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/redisson/v3_0/RedisCommandDataInstrumentation.java

@@ -3,7 +3,7 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
-package io.opentelemetry.javaagent.instrumentation.redisson;
+package io.opentelemetry.javaagent.instrumentation.redisson.v3_0;
 
 import static net.bytebuddy.matcher.ElementMatchers.isConstructor;
 import static net.bytebuddy.matcher.ElementMatchers.named;
@@ -12,6 +12,7 @@
 
 import io.opentelemetry.javaagent.extension.instrumentation.TypeInstrumentation;
 import io.opentelemetry.javaagent.extension.instrumentation.TypeTransformer;
+import io.opentelemetry.javaagent.instrumentation.redisson.CompletableFutureWrapper;
 import java.util.concurrent.CompletableFuture;
 import net.bytebuddy.asm.Advice;
 import net.bytebuddy.description.type.TypeDescription;

instrumentation/redisson-3.0/javaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/redisson/RedisConnectionInstrumentation.java → instrumentation/redisson/redisson-3.0/javaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/redisson/v3_0/RedisConnectionInstrumentation.java

@@ -3,17 +3,20 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
-package io.opentelemetry.javaagent.instrumentation.redisson;
+package io.opentelemetry.javaagent.instrumentation.redisson.v3_0;
 
 import static io.opentelemetry.javaagent.bootstrap.Java8BytecodeBridge.currentContext;
-import static io.opentelemetry.javaagent.instrumentation.redisson.RedissonSingletons.instrumenter;
+import static io.opentelemetry.javaagent.instrumentation.redisson.v3_0.RedissonSingletons.instrumenter;
 import static net.bytebuddy.matcher.ElementMatchers.isMethod;
 import static net.bytebuddy.matcher.ElementMatchers.named;
 
 import io.opentelemetry.context.Context;
 import io.opentelemetry.context.Scope;
 import io.opentelemetry.javaagent.extension.instrumentation.TypeInstrumentation;
 import io.opentelemetry.javaagent.extension.instrumentation.TypeTransformer;
+import io.opentelemetry.javaagent.instrumentation.redisson.EndOperationListener;
+import io.opentelemetry.javaagent.instrumentation.redisson.PromiseWrapper;
+import io.opentelemetry.javaagent.instrumentation.redisson.RedissonRequest;
 import java.net.InetSocketAddress;
 import net.bytebuddy.asm.Advice;
 import net.bytebuddy.description.type.TypeDescription;
@@ -57,7 +60,7 @@ public static void onEnter(
       context = instrumenter().start(parentContext, request);
       scope = context.makeCurrent();
 
-      promise.setEndOperationListener(new EndOperationListener<>(context, request));
+      promise.setEndOperationListener(new EndOperationListener<>(instrumenter(), context, request));
     }
 
     @Advice.OnMethodExit(onThrowable = Throwable.class, suppress = Throwable.class)

instrumentation/redisson-3.0/javaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/redisson/RedissonInstrumentationModule.java → instrumentation/redisson/redisson-3.0/javaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/redisson/v3_0/RedissonInstrumentationModule.java

@@ -3,14 +3,17 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
-package io.opentelemetry.javaagent.instrumentation.redisson;
+package io.opentelemetry.javaagent.instrumentation.redisson.v3_0;
 
+import static io.opentelemetry.javaagent.extension.matcher.AgentElementMatchers.hasClassesNamed;
 import static java.util.Arrays.asList;
+import static net.bytebuddy.matcher.ElementMatchers.not;
 
 import com.google.auto.service.AutoService;
 import io.opentelemetry.javaagent.extension.instrumentation.InstrumentationModule;
 import io.opentelemetry.javaagent.extension.instrumentation.TypeInstrumentation;
 import java.util.List;
+import net.bytebuddy.matcher.ElementMatcher;
 
 @AutoService(InstrumentationModule.class)
 public class RedissonInstrumentationModule extends InstrumentationModule {
@@ -19,6 +22,11 @@ public RedissonInstrumentationModule() {
     super("redisson", "redisson-3.0");
   }
 
+  @Override
+  public ElementMatcher.Junction<ClassLoader> classLoaderMatcher() {
+    return not(hasClassesNamed("org.redisson.api.RFunction"));
+  }
+
   @Override
   public List<TypeInstrumentation> typeInstrumentations() {
     return asList(new RedisConnectionInstrumentation(), new RedisCommandDataInstrumentation());

instrumentation/redisson-3.0/javaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/redisson/RedissonPromiseWrapper.java → instrumentation/redisson/redisson-3.0/javaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/redisson/v3_0/RedissonPromiseWrapper.java

@@ -3,10 +3,12 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
-package io.opentelemetry.javaagent.instrumentation.redisson;
+package io.opentelemetry.javaagent.instrumentation.redisson.v3_0;
 
 import io.opentelemetry.context.Context;
 import io.opentelemetry.context.Scope;
+import io.opentelemetry.javaagent.instrumentation.redisson.EndOperationListener;
+import io.opentelemetry.javaagent.instrumentation.redisson.PromiseWrapper;
 import org.redisson.misc.RPromise;
 import org.redisson.misc.RedissonPromise;
 

instrumentation/redisson/redisson-3.0/javaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/redisson/v3_0/RedissonSingletons.java

@@ -0,0 +1,23 @@
+/*
+ * Copyright The OpenTelemetry Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+package io.opentelemetry.javaagent.instrumentation.redisson.v3_0;
+
+import io.opentelemetry.instrumentation.api.instrumenter.Instrumenter;
+import io.opentelemetry.javaagent.instrumentation.redisson.RedissonInstrumenterFactory;
+import io.opentelemetry.javaagent.instrumentation.redisson.RedissonRequest;
+
+public final class RedissonSingletons {
+  private static final String INSTRUMENTATION_NAME = "io.opentelemetry.redisson-3.0";
+
+  private static final Instrumenter<RedissonRequest, Void> INSTRUMENTER =
+      RedissonInstrumenterFactory.createInstrumenter(INSTRUMENTATION_NAME);
+
+  public static Instrumenter<RedissonRequest, Void> instrumenter() {
+    return INSTRUMENTER;
+  }
+
+  private RedissonSingletons() {}
+}

instrumentation/redisson/redisson-3.0/javaagent/src/test/groovy/RedissonAsyncClientTest.groovy

@@ -0,0 +1,7 @@
+/*
+ * Copyright The OpenTelemetry Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+class RedissonAsyncClientTest extends AbstractRedissonAsyncClientTest {
+}

instrumentation/redisson/redisson-3.0/javaagent/src/test/groovy/RedissonClientTest.groovy

@@ -0,0 +1,7 @@
+/*
+ * Copyright The OpenTelemetry Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+class RedissonClientTest extends AbstractRedissonClientTest {
+}

instrumentation/redisson/redisson-3.17/javaagent/build.gradle.kts

@@ -0,0 +1,30 @@
+plugins {
+  id("otel.javaagent-instrumentation")
+}
+
+muzzle {
+  pass {
+    group.set("org.redisson")
+    module.set("redisson")
+    versions.set("[3.17.0,)")
+    assertInverse.set(true)
+  }
+}
+
+dependencies {
+  library("org.redisson:redisson:3.17.0")
+
+  implementation(project(":instrumentation:redisson:redisson-common:javaagent"))
+
+  compileOnly("com.google.auto.value:auto-value-annotations")
+  annotationProcessor("com.google.auto.value:auto-value")
+
+  testInstrumentation(project(":instrumentation:redisson:redisson-3.0:javaagent"))
+
+  testImplementation(project(":instrumentation:redisson:redisson-common:testing"))
+}
+
+tasks.test {
+  systemProperty("testLatestDeps", findProperty("testLatestDeps") as Boolean)
+  usesService(gradle.sharedServices.registrations["testcontainersBuildService"].getService())
+}

instrumentation/redisson/redisson-3.17/javaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/redisson/v3_17/RedisCommandDataInstrumentation.java

@@ -0,0 +1,45 @@
+/*
+ * Copyright The OpenTelemetry Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+package io.opentelemetry.javaagent.instrumentation.redisson.v3_17;
+
+import static net.bytebuddy.matcher.ElementMatchers.isConstructor;
+import static net.bytebuddy.matcher.ElementMatchers.namedOneOf;
+import static net.bytebuddy.matcher.ElementMatchers.takesArgument;
+
+import io.opentelemetry.javaagent.extension.instrumentation.TypeInstrumentation;
+import io.opentelemetry.javaagent.extension.instrumentation.TypeTransformer;
+import io.opentelemetry.javaagent.instrumentation.redisson.CompletableFutureWrapper;
+import java.util.concurrent.CompletableFuture;
+import net.bytebuddy.asm.Advice;
+import net.bytebuddy.description.type.TypeDescription;
+import net.bytebuddy.matcher.ElementMatcher;
+
+public class RedisCommandDataInstrumentation implements TypeInstrumentation {
+
+  @Override
+  public ElementMatcher<TypeDescription> typeMatcher() {
+    return namedOneOf(
+        "org.redisson.client.protocol.CommandData", "org.redisson.client.protocol.CommandsData");
+  }
+
+  @Override
+  public void transform(TypeTransformer transformer) {
+    // since 3.16.8
+    transformer.applyAdviceToMethod(
+        isConstructor().and(takesArgument(0, CompletableFuture.class)),
+        this.getClass().getName() + "$WrapCompletableFutureAdvice");
+  }
+
+  @SuppressWarnings("unused")
+  public static class WrapCompletableFutureAdvice {
+
+    @Advice.OnMethodEnter(suppress = Throwable.class)
+    public static void onEnter(
+        @Advice.Argument(value = 0, readOnly = false) CompletableFuture<?> completableFuture) {
+      completableFuture = CompletableFutureWrapper.wrap(completableFuture);
+    }
+  }
+}

instrumentation/redisson/redisson-3.17/javaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/redisson/v3_17/RedisConnectionInstrumentation.java

@@ -0,0 +1,84 @@
+/*
+ * Copyright The OpenTelemetry Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+package io.opentelemetry.javaagent.instrumentation.redisson.v3_17;
+
+import static io.opentelemetry.javaagent.bootstrap.Java8BytecodeBridge.currentContext;
+import static io.opentelemetry.javaagent.instrumentation.redisson.v3_17.RedissonSingletons.instrumenter;
+import static net.bytebuddy.matcher.ElementMatchers.isMethod;
+import static net.bytebuddy.matcher.ElementMatchers.named;
+
+import io.opentelemetry.context.Context;
+import io.opentelemetry.context.Scope;
+import io.opentelemetry.javaagent.extension.instrumentation.TypeInstrumentation;
+import io.opentelemetry.javaagent.extension.instrumentation.TypeTransformer;
+import io.opentelemetry.javaagent.instrumentation.redisson.EndOperationListener;
+import io.opentelemetry.javaagent.instrumentation.redisson.PromiseWrapper;
+import io.opentelemetry.javaagent.instrumentation.redisson.RedissonRequest;
+import java.net.InetSocketAddress;
+import net.bytebuddy.asm.Advice;
+import net.bytebuddy.description.type.TypeDescription;
+import net.bytebuddy.matcher.ElementMatcher;
+import org.redisson.client.RedisConnection;
+
+public class RedisConnectionInstrumentation implements TypeInstrumentation {
+  @Override
+  public ElementMatcher<TypeDescription> typeMatcher() {
+    return named("org.redisson.client.RedisConnection");
+  }
+
+  @Override
+  public void transform(TypeTransformer transformer) {
+    transformer.applyAdviceToMethod(
+        isMethod().and(named("send")), this.getClass().getName() + "$SendAdvice");
+  }
+
+  @SuppressWarnings("unused")
+  public static class SendAdvice {
+
+    @Advice.OnMethodEnter(suppress = Throwable.class)
+    public static void onEnter(
+        @Advice.This RedisConnection connection,
+        @Advice.Argument(0) Object arg,
+        @Advice.Local("otelRequest") RedissonRequest request,
+        @Advice.Local("otelContext") Context context,
+        @Advice.Local("otelScope") Scope scope) {
+
+      Context parentContext = currentContext();
+      InetSocketAddress remoteAddress = (InetSocketAddress) connection.getChannel().remoteAddress();
+      request = RedissonRequest.create(remoteAddress, arg);
+      PromiseWrapper<?> promise = request.getPromiseWrapper();
+      if (promise == null) {
+        return;
+      }
+      if (!instrumenter().shouldStart(parentContext, request)) {
+        return;
+      }
+
+      context = instrumenter().start(parentContext, request);
+      scope = context.makeCurrent();
+
+      promise.setEndOperationListener(new EndOperationListener<>(instrumenter(), context, request));
+    }
+
+    @Advice.OnMethodExit(onThrowable = Throwable.class, suppress = Throwable.class)
+    public static void stopSpan(
+        @Advice.Thrown Throwable throwable,
+        @Advice.Local("otelRequest") RedissonRequest request,
+        @Advice.Local("otelContext") Context context,
+        @Advice.Local("otelScope") Scope scope) {
+
+      if (scope == null) {
+        return;
+      }
+      scope.close();
+
+      if (throwable != null) {
+        instrumenter().end(context, request, null, throwable);
+      }
+      // span ended in EndOperationListener
+    }
+  }
+}

instrumentation/redisson/redisson-3.17/javaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/redisson/v3_17/RedissonInstrumentationModule.java

@@ -0,0 +1,33 @@
+/*
+ * Copyright The OpenTelemetry Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+package io.opentelemetry.javaagent.instrumentation.redisson.v3_17;
+
+import static io.opentelemetry.javaagent.extension.matcher.AgentElementMatchers.hasClassesNamed;
+import static java.util.Arrays.asList;
+
+import com.google.auto.service.AutoService;
+import io.opentelemetry.javaagent.extension.instrumentation.InstrumentationModule;
+import io.opentelemetry.javaagent.extension.instrumentation.TypeInstrumentation;
+import java.util.List;
+import net.bytebuddy.matcher.ElementMatcher;
+
+@AutoService(InstrumentationModule.class)
+public class RedissonInstrumentationModule extends InstrumentationModule {
+
+  public RedissonInstrumentationModule() {
+    super("redisson", "redisson-3.17");
+  }
+
+  @Override
+  public ElementMatcher.Junction<ClassLoader> classLoaderMatcher() {
+    return hasClassesNamed("org.redisson.api.RFunction");
+  }
+
+  @Override
+  public List<TypeInstrumentation> typeInstrumentations() {
+    return asList(new RedisConnectionInstrumentation(), new RedisCommandDataInstrumentation());
+  }
+}