Address Couchbase instrumentation TODOs

Author: trask

instrumentation/couchbase/couchbase-2.0/javaagent/build.gradle.kts

@@ -26,7 +26,7 @@ dependencies {
 
   testImplementation(project(":instrumentation:couchbase:couchbase-common:testing"))
 
-  // TODO testInstrumentation(project(":instrumentation:couchbase:couchbase-2.6:javaagent"))
+  testInstrumentation(project(":instrumentation:couchbase:couchbase-2.6:javaagent"))
   testInstrumentation(project(":instrumentation:couchbase:couchbase-3.1:javaagent"))
   testInstrumentation(project(":instrumentation:couchbase:couchbase-3.1.6:javaagent"))
   testInstrumentation(project(":instrumentation:couchbase:couchbase-3.2:javaagent"))

instrumentation/couchbase/couchbase-2.0/javaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/couchbase/v2_0/CouchbaseInstrumentationModule.java

@@ -5,6 +5,7 @@
 
 package io.opentelemetry.javaagent.instrumentation.couchbase.v2_0;
 
+import static io.opentelemetry.javaagent.extension.matcher.AgentElementMatchers.hasClassesNamed;
 import static java.util.Arrays.asList;
 import static java.util.Collections.singletonList;
 
@@ -13,6 +14,7 @@
 import io.opentelemetry.javaagent.extension.instrumentation.TypeInstrumentation;
 import io.opentelemetry.javaagent.extension.instrumentation.internal.ExperimentalInstrumentationModule;
 import java.util.List;
+import net.bytebuddy.matcher.ElementMatcher;
 
 @AutoService(InstrumentationModule.class)
 public class CouchbaseInstrumentationModule extends InstrumentationModule
@@ -46,4 +48,10 @@ public List<String> injectedClassNames() {
   public boolean isIndyReady() {
     return true;
   }
+
+  @Override
+  public ElementMatcher.Junction<ClassLoader> classLoaderMatcher() {
+    // removed in 3.x
+    return hasClassesNamed("com.couchbase.client.java.CouchbaseAsyncBucket");
+  }
 }

instrumentation/couchbase/couchbase-2.6/javaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/couchbase/v2_6/CouchbaseInstrumentationModule.java

@@ -5,13 +5,15 @@
 
 package io.opentelemetry.javaagent.instrumentation.couchbase.v2_6;
 
+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 io.opentelemetry.javaagent.extension.instrumentation.internal.ExperimentalInstrumentationModule;
 import java.util.List;
+import net.bytebuddy.matcher.ElementMatcher;
 
 @AutoService(InstrumentationModule.class)
 public class CouchbaseInstrumentationModule extends InstrumentationModule
@@ -21,6 +23,12 @@ public CouchbaseInstrumentationModule() {
     super("couchbase", "couchbase-2.6");
   }
 
+  @Override
+  public ElementMatcher.Junction<ClassLoader> classLoaderMatcher() {
+    // introduced in java-client 2.6, removed in 3.x
+    return hasClassesNamed("com.couchbase.client.java.auth.CertAuthenticator");
+  }
+
   @Override
   public List<TypeInstrumentation> typeInstrumentations() {
     return asList(new CouchbaseCoreInstrumentation(), new CouchbaseNetworkInstrumentation());

instrumentation/couchbase/couchbase-3.1.6/javaagent/build.gradle.kts

@@ -35,7 +35,7 @@ dependencies {
 
   testInstrumentation(project(":instrumentation:couchbase:couchbase-2.0:javaagent"))
   testInstrumentation(project(":instrumentation:couchbase:couchbase-2.6:javaagent"))
-  // TODO testInstrumentation(project(":instrumentation:couchbase:couchbase-3.1:javaagent"))
+  testInstrumentation(project(":instrumentation:couchbase:couchbase-3.1:javaagent"))
   testInstrumentation(project(":instrumentation:couchbase:couchbase-3.2:javaagent"))
   testInstrumentation(project(":instrumentation:couchbase:couchbase-3.4:javaagent"))
   testImplementation("org.testcontainers:testcontainers-couchbase")

instrumentation/couchbase/couchbase-3.1.6/javaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/couchbase/v3_1_6/CouchbaseInstrumentationModule.java

@@ -25,11 +25,9 @@ public CouchbaseInstrumentationModule() {
 
   @Override
   public ElementMatcher.Junction<ClassLoader> classLoaderMatcher() {
-    // New class introduced in 3.1, the minimum version we support.
-    // NB: Couchbase does not provide any API guarantees on their core IO artifact so reconsider
-    // instrumenting it instead of each individual JVM artifact if this becomes unmaintainable.
-    return hasClassesNamed("com.couchbase.client.core.cnc.TracingIdentifiers")
-        // added in 3.2
+    // introduced in java-client 3.1.6 (core-io 2.1.6)
+    return hasClassesNamed("com.couchbase.client.core.endpoint.EventingEndpoint")
+        // introduced in java-client 3.2.0 (core-io 2.2.0)
         .and(not(hasClassesNamed("com.couchbase.client.core.cnc.RequestSpan$StatusCode")));
   }
 

instrumentation/couchbase/couchbase-3.1/javaagent/build.gradle.kts

@@ -36,7 +36,7 @@ dependencies {
 
   testInstrumentation(project(":instrumentation:couchbase:couchbase-2.0:javaagent"))
   testInstrumentation(project(":instrumentation:couchbase:couchbase-2.6:javaagent"))
-  // TODO testInstrumentation(project(":instrumentation:couchbase:couchbase-3.1.6:javaagent"))
+  testInstrumentation(project(":instrumentation:couchbase:couchbase-3.1.6:javaagent"))
   testInstrumentation(project(":instrumentation:couchbase:couchbase-3.2:javaagent"))
   testInstrumentation(project(":instrumentation:couchbase:couchbase-3.4:javaagent"))
   testImplementation("org.testcontainers:testcontainers-couchbase")

instrumentation/couchbase/couchbase-3.1/javaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/couchbase/v3_1/CouchbaseInstrumentationModule.java

@@ -25,12 +25,10 @@ public CouchbaseInstrumentationModule() {
 
   @Override
   public ElementMatcher.Junction<ClassLoader> classLoaderMatcher() {
-    // New class introduced in 3.1, the minimum version we support.
-    // NB: Couchbase does not provide any API guarantees on their core IO artifact so reconsider
-    // instrumenting it instead of each individual JVM artifact if this becomes unmaintainable.
+    // introduced in java-client 3.1.0 (core-io 2.1.0)
     return hasClassesNamed("com.couchbase.client.core.cnc.TracingIdentifiers")
-        // added in 3.2
-        .and(not(hasClassesNamed("com.couchbase.client.core.cnc.RequestSpan$StatusCode")));
+        // introduced in java-client 3.1.6 (core-io 2.1.6)
+        .and(not(hasClassesNamed("com.couchbase.client.core.endpoint.EventingEndpoint")));
   }
 
   @Override

instrumentation/couchbase/couchbase-3.2/javaagent/build.gradle.kts

@@ -38,7 +38,7 @@ dependencies {
   testInstrumentation(project(":instrumentation:couchbase:couchbase-2.0:javaagent"))
   testInstrumentation(project(":instrumentation:couchbase:couchbase-2.6:javaagent"))
   testInstrumentation(project(":instrumentation:couchbase:couchbase-3.1:javaagent"))
-  // TODO testInstrumentation(project(":instrumentation:couchbase:couchbase-3.1.6:javaagent"))
+  testInstrumentation(project(":instrumentation:couchbase:couchbase-3.1.6:javaagent"))
   testInstrumentation(project(":instrumentation:couchbase:couchbase-3.4:javaagent"))
 
   latestDepTestLibrary("com.couchbase.client:java-client:3.3.+") // see couchbase-3.4 module

instrumentation/couchbase/couchbase-3.2/javaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/couchbase/v3_2/CouchbaseInstrumentationModule.java

@@ -25,9 +25,9 @@ public CouchbaseInstrumentationModule() {
 
   @Override
   public ElementMatcher.Junction<ClassLoader> classLoaderMatcher() {
-    // New class introduced in 3.2.
-    // CoreTransactionRequest was introduced in 3.4.0.
+    // introduced in java-client 3.2.0 (core-io 2.2.0)
     return hasClassesNamed("com.couchbase.client.core.cnc.RequestSpan$StatusCode")
+        // introduced in java-client 3.4.0 (core-io 2.4.0)
         .and(
             not(
                 hasClassesNamed(

instrumentation/couchbase/couchbase-3.4/javaagent/build.gradle.kts

@@ -38,7 +38,7 @@ dependencies {
   testInstrumentation(project(":instrumentation:couchbase:couchbase-2.0:javaagent"))
   testInstrumentation(project(":instrumentation:couchbase:couchbase-2.6:javaagent"))
   testInstrumentation(project(":instrumentation:couchbase:couchbase-3.1:javaagent"))
-  // TODO testInstrumentation(project(":instrumentation:couchbase:couchbase-3.1.6:javaagent"))
+  testInstrumentation(project(":instrumentation:couchbase:couchbase-3.1.6:javaagent"))
   testInstrumentation(project(":instrumentation:couchbase:couchbase-3.2:javaagent"))
 }