Bring in newer upstream Couchbase instrumentation to fix span kind (#14995)

trask · otelbot[bot] · web-flow · commit 69843c2f4c76 · 2025-10-21T10:39:54.000-07:00
Co-authored-by: otelbot &lt;197425009+otelbot@users.noreply.github.com&gt;
diff --git a/.fossa.yml b/.fossa.yml
@@ -427,6 +427,9 @@ targets:
     - type: gradle
       path: ./
       target: ':instrumentation:couchbase:couchbase-3.2:javaagent'
+    - type: gradle
+      path: ./
+      target: ':instrumentation:couchbase:couchbase-3.4:javaagent'
     - type: gradle
       path: ./
       target: ':instrumentation:dropwizard:dropwizard-metrics-4.0:javaagent'
diff --git a/instrumentation/couchbase/couchbase-2.0/javaagent/build.gradle.kts b/instrumentation/couchbase/couchbase-2.0/javaagent/build.gradle.kts
@@ -26,6 +26,12 @@ dependencies {
 
   testImplementation(project(":instrumentation:couchbase:couchbase-common:testing"))
 
+  // TODO 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"))
+  testInstrumentation(project(":instrumentation:couchbase:couchbase-3.4:javaagent"))
+
   latestDepTestLibrary("org.springframework.data:spring-data-couchbase:2.+") // see couchbase-2.6 module
   latestDepTestLibrary("com.couchbase.client:java-client:2.5.+") // see couchbase-2.6 module
 }
diff --git a/instrumentation/couchbase/couchbase-2.6/javaagent/build.gradle.kts b/instrumentation/couchbase/couchbase-2.6/javaagent/build.gradle.kts
@@ -23,12 +23,17 @@ dependencies {
 
   library("com.couchbase.client:java-client:2.6.0")
 
-  testInstrumentation(project(":instrumentation:couchbase:couchbase-2.0:javaagent"))
   testImplementation(project(":instrumentation:couchbase:couchbase-common:testing"))
 
   testLibrary("org.springframework.data:spring-data-couchbase:3.1.0.RELEASE")
   testLibrary("com.couchbase.client:encryption:1.0.0")
 
+  testInstrumentation(project(":instrumentation:couchbase:couchbase-2.0: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"))
+  testInstrumentation(project(":instrumentation:couchbase:couchbase-3.4:javaagent"))
+
   latestDepTestLibrary("org.springframework.data:spring-data-couchbase:3.1.+") // see couchbase-3.1 module
   latestDepTestLibrary("com.couchbase.client:java-client:2.+") // see couchbase-3.1 module
 }
diff --git a/instrumentation/couchbase/couchbase-3.1.6/javaagent/build.gradle.kts b/instrumentation/couchbase/couchbase-3.1.6/javaagent/build.gradle.kts
@@ -33,6 +33,11 @@ dependencies {
 
   library("com.couchbase.client:java-client:3.1.6")
 
+  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.2:javaagent"))
+  testInstrumentation(project(":instrumentation:couchbase:couchbase-3.4:javaagent"))
   testImplementation("org.testcontainers:testcontainers-couchbase")
 
   latestDepTestLibrary("com.couchbase.client:java-client:3.1.+") // see couchbase-3.2 module
diff --git a/instrumentation/couchbase/couchbase-3.1.6/javaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/couchbase/v3_1_6/CouchbaseInstrumentationModule.java b/instrumentation/couchbase/couchbase-3.1.6/javaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/couchbase/v3_1_6/CouchbaseInstrumentationModule.java
@@ -6,6 +6,7 @@
 package io.opentelemetry.javaagent.instrumentation.couchbase.v3_1_6;
 
 import static io.opentelemetry.javaagent.extension.matcher.AgentElementMatchers.hasClassesNamed;
+import static net.bytebuddy.matcher.ElementMatchers.not;
 
 import com.google.auto.service.AutoService;
 import io.opentelemetry.javaagent.extension.instrumentation.InstrumentationModule;
@@ -27,7 +28,9 @@ 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");
+    return hasClassesNamed("com.couchbase.client.core.cnc.TracingIdentifiers")
+        // added in 3.2
+        .and(not(hasClassesNamed("com.couchbase.client.core.cnc.RequestSpan$StatusCode")));
   }
 
   @Override
diff --git a/instrumentation/couchbase/couchbase-3.1.6/javaagent/src/test/java/io/opentelemetry/javaagent/instrumentation/couchbase/v3_1_6/CouchbaseClient316Test.java b/instrumentation/couchbase/couchbase-3.1.6/javaagent/src/test/java/io/opentelemetry/javaagent/instrumentation/couchbase/v3_1_6/CouchbaseClient316Test.java
@@ -5,6 +5,8 @@
 
 package io.opentelemetry.javaagent.instrumentation.couchbase.v3_1_6;
 
+import static io.opentelemetry.api.trace.SpanKind.INTERNAL;
+
 import com.couchbase.client.core.env.TimeoutConfig;
 import com.couchbase.client.core.error.DocumentNotFoundException;
 import com.couchbase.client.java.Bucket;
@@ -14,6 +16,7 @@
 import com.couchbase.client.java.env.ClusterEnvironment;
 import io.opentelemetry.instrumentation.testing.junit.AgentInstrumentationExtension;
 import io.opentelemetry.instrumentation.testing.junit.InstrumentationExtension;
+import io.opentelemetry.sdk.trace.data.StatusData;
 import java.time.Duration;
 import org.junit.jupiter.api.AfterAll;
 import org.junit.jupiter.api.BeforeAll;
@@ -86,6 +89,12 @@ void testEmitsSpans() {
     testing.waitAndAssertTracesWithoutScopeVersionVerification(
         trace ->
             trace.hasSpansSatisfyingExactly(
-                span -> span.hasName("get"), span -> span.hasName("dispatch_to_server")));
+                span -> {
+                  span.hasKind(INTERNAL) // later version of couchbase gives correct behavior
+                      .hasName("get")
+                      .hasStatus(
+                          StatusData.unset()); // later version of couchbase gives correct behavior
+                },
+                span -> span.hasName("dispatch_to_server")));
   }
 }
diff --git a/instrumentation/couchbase/couchbase-3.1/javaagent/build.gradle.kts b/instrumentation/couchbase/couchbase-3.1/javaagent/build.gradle.kts
@@ -34,6 +34,11 @@ dependencies {
   // 3.1.4 (instead of 3.1.0) needed for test stability and for compatibility with server versions that run on M1 processors
   library("com.couchbase.client:java-client:3.1.4")
 
+  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.2:javaagent"))
+  testInstrumentation(project(":instrumentation:couchbase:couchbase-3.4:javaagent"))
   testImplementation("org.testcontainers:testcontainers-couchbase")
 
   latestDepTestLibrary("com.couchbase.client:java-client:3.1.5") // see couchbase-3.1.6 module
diff --git a/instrumentation/couchbase/couchbase-3.1/javaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/couchbase/v3_1/CouchbaseInstrumentationModule.java b/instrumentation/couchbase/couchbase-3.1/javaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/couchbase/v3_1/CouchbaseInstrumentationModule.java
@@ -6,6 +6,7 @@
 package io.opentelemetry.javaagent.instrumentation.couchbase.v3_1;
 
 import static io.opentelemetry.javaagent.extension.matcher.AgentElementMatchers.hasClassesNamed;
+import static net.bytebuddy.matcher.ElementMatchers.not;
 
 import com.google.auto.service.AutoService;
 import io.opentelemetry.javaagent.extension.instrumentation.InstrumentationModule;
@@ -27,7 +28,9 @@ 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");
+    return hasClassesNamed("com.couchbase.client.core.cnc.TracingIdentifiers")
+        // added in 3.2
+        .and(not(hasClassesNamed("com.couchbase.client.core.cnc.RequestSpan$StatusCode")));
   }
 
   @Override
diff --git a/instrumentation/couchbase/couchbase-3.1/javaagent/src/test/java/io/opentelemetry/javaagent/instrumentation/couchbase/v3_1/CouchbaseClient31Test.java b/instrumentation/couchbase/couchbase-3.1/javaagent/src/test/java/io/opentelemetry/javaagent/instrumentation/couchbase/v3_1/CouchbaseClient31Test.java
@@ -5,6 +5,8 @@
 
 package io.opentelemetry.javaagent.instrumentation.couchbase.v3_1;
 
+import static io.opentelemetry.api.trace.SpanKind.INTERNAL;
+
 import com.couchbase.client.core.env.TimeoutConfig;
 import com.couchbase.client.core.error.DocumentNotFoundException;
 import com.couchbase.client.java.Bucket;
@@ -14,6 +16,7 @@
 import com.couchbase.client.java.env.ClusterEnvironment;
 import io.opentelemetry.instrumentation.testing.junit.AgentInstrumentationExtension;
 import io.opentelemetry.instrumentation.testing.junit.InstrumentationExtension;
+import io.opentelemetry.sdk.trace.data.StatusData;
 import java.time.Duration;
 import org.junit.jupiter.api.AfterAll;
 import org.junit.jupiter.api.BeforeAll;
@@ -86,6 +89,12 @@ void testEmitsSpans() {
     testing.waitAndAssertTracesWithoutScopeVersionVerification(
         trace ->
             trace.hasSpansSatisfyingExactly(
-                span -> span.hasName("get"), span -> span.hasName("dispatch_to_server")));
+                span -> {
+                  span.hasKind(INTERNAL) // later version of couchbase gives correct behavior
+                      .hasName("get")
+                      .hasStatus(
+                          StatusData.unset()); // later version of couchbase gives correct behavior
+                },
+                span -> span.hasName("dispatch_to_server")));
   }
 }
diff --git a/instrumentation/couchbase/couchbase-3.2/javaagent/build.gradle.kts b/instrumentation/couchbase/couchbase-3.2/javaagent/build.gradle.kts
@@ -6,7 +6,7 @@ muzzle {
   pass {
     group.set("com.couchbase.client")
     module.set("java-client")
-    versions.set("[3.2.0,)")
+    versions.set("[3.2.0,3.4.0)")
     // these versions were released as ".bundle" instead of ".jar"
     skip("2.7.5", "2.7.8")
     assertInverse.set(true)
@@ -34,6 +34,14 @@ dependencies {
   library("com.couchbase.client:java-client:3.2.0")
 
   testImplementation("org.testcontainers:testcontainers-couchbase")
+
+  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.4:javaagent"))
+
+  latestDepTestLibrary("com.couchbase.client:java-client:3.3.+") // see couchbase-3.4 module
 }
 
 tasks {
diff --git a/instrumentation/couchbase/couchbase-3.2/javaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/couchbase/v3_2/CouchbaseInstrumentationModule.java b/instrumentation/couchbase/couchbase-3.2/javaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/couchbase/v3_2/CouchbaseInstrumentationModule.java
@@ -6,6 +6,7 @@
 package io.opentelemetry.javaagent.instrumentation.couchbase.v3_2;
 
 import static io.opentelemetry.javaagent.extension.matcher.AgentElementMatchers.hasClassesNamed;
+import static net.bytebuddy.matcher.ElementMatchers.not;
 
 import com.google.auto.service.AutoService;
 import io.opentelemetry.javaagent.extension.instrumentation.InstrumentationModule;
@@ -25,7 +26,12 @@ public CouchbaseInstrumentationModule() {
   @Override
   public ElementMatcher.Junction<ClassLoader> classLoaderMatcher() {
     // New class introduced in 3.2.
-    return hasClassesNamed("com.couchbase.client.core.cnc.RequestSpan$StatusCode");
+    // CoreTransactionRequest was introduced in 3.4.0.
+    return hasClassesNamed("com.couchbase.client.core.cnc.RequestSpan$StatusCode")
+        .and(
+            not(
+                hasClassesNamed(
+                    "com.couchbase.client.core.transaction.components.CoreTransactionRequest")));
   }
 
   @Override
diff --git a/instrumentation/couchbase/couchbase-3.2/javaagent/src/test/java/io/opentelemetry/javaagent/instrumentation/couchbase/v3_2/CouchbaseClient32Test.java b/instrumentation/couchbase/couchbase-3.2/javaagent/src/test/java/io/opentelemetry/javaagent/instrumentation/couchbase/v3_2/CouchbaseClient32Test.java
@@ -5,6 +5,8 @@
 
 package io.opentelemetry.javaagent.instrumentation.couchbase.v3_2;
 
+import static io.opentelemetry.api.trace.SpanKind.INTERNAL;
+
 import com.couchbase.client.core.error.DocumentNotFoundException;
 import com.couchbase.client.java.Bucket;
 import com.couchbase.client.java.Cluster;
@@ -73,7 +75,8 @@ void testEmitsSpans() {
         trace ->
             trace.hasSpansSatisfyingExactly(
                 span -> {
-                  span.hasName("get");
+                  span.hasKind(INTERNAL) // later version of couchbase gives correct behavior
+                      .hasName("get");
                   if (Boolean.getBoolean("testLatestDeps")) {
                     span.hasStatus(StatusData.error());
                   }
diff --git a/instrumentation/couchbase/couchbase-3.4/javaagent/build.gradle.kts b/instrumentation/couchbase/couchbase-3.4/javaagent/build.gradle.kts
@@ -0,0 +1,61 @@
+plugins {
+  id("otel.javaagent-instrumentation")
+}
+
+muzzle {
+  pass {
+    group.set("com.couchbase.client")
+    module.set("java-client")
+    versions.set("[3.4.0,)")
+    // these versions were released as ".bundle" instead of ".jar"
+    skip("2.7.5", "2.7.8")
+    assertInverse.set(true)
+  }
+}
+
+sourceSets {
+  main {
+    val shadedDep = project(":instrumentation:couchbase:couchbase-3.4:tracing-opentelemetry-shaded")
+    output.dir(
+      shadedDep.file("build/extracted/shadow"),
+      "builtBy" to ":instrumentation:couchbase:couchbase-3.4:tracing-opentelemetry-shaded:extractShadowJar",
+    )
+  }
+}
+
+dependencies {
+  compileOnly(
+    project(
+      path = ":instrumentation:couchbase:couchbase-3.4:tracing-opentelemetry-shaded",
+      configuration = "shadow",
+    ),
+  )
+
+  library("com.couchbase.client:java-client:3.4.0")
+
+  testImplementation("org.testcontainers:testcontainers-couchbase")
+
+  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.2:javaagent"))
+}
+
+tasks {
+  withType<Test>().configureEach {
+    systemProperty("testLatestDeps", findProperty("testLatestDeps") as Boolean)
+    usesService(gradle.sharedServices.registrations["testcontainersBuildService"].service)
+  }
+
+  val testStableSemconv by registering(Test::class) {
+    testClassesDirs = sourceSets.test.get().output.classesDirs
+    classpath = sourceSets.test.get().runtimeClasspath
+
+    jvmArgs("-Dotel.semconv-stability.opt-in=database")
+  }
+
+  check {
+    dependsOn(testStableSemconv)
+  }
+}
diff --git a/instrumentation/couchbase/couchbase-3.4/javaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/couchbase/v3_4/CouchbaseEnvironmentInstrumentation.java b/instrumentation/couchbase/couchbase-3.4/javaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/couchbase/v3_4/CouchbaseEnvironmentInstrumentation.java
@@ -0,0 +1,42 @@
+/*
+ * Copyright The OpenTelemetry Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+package io.opentelemetry.javaagent.instrumentation.couchbase.v3_4;
+
+import static net.bytebuddy.matcher.ElementMatchers.isConstructor;
+import static net.bytebuddy.matcher.ElementMatchers.named;
+
+import com.couchbase.client.core.env.CoreEnvironment;
+import io.opentelemetry.api.GlobalOpenTelemetry;
+import io.opentelemetry.javaagent.extension.instrumentation.TypeInstrumentation;
+import io.opentelemetry.javaagent.extension.instrumentation.TypeTransformer;
+import io.opentelemetry.javaagent.instrumentation.couchbase.v3_4.shaded.com.couchbase.client.tracing.opentelemetry.OpenTelemetryRequestTracer;
+import net.bytebuddy.asm.Advice;
+import net.bytebuddy.description.type.TypeDescription;
+import net.bytebuddy.matcher.ElementMatcher;
+
+public class CouchbaseEnvironmentInstrumentation implements TypeInstrumentation {
+
+  @Override
+  public ElementMatcher<TypeDescription> typeMatcher() {
+    return named("com.couchbase.client.core.env.CoreEnvironment$Builder");
+  }
+
+  @Override
+  public void transform(TypeTransformer transformer) {
+    transformer.applyAdviceToMethod(
+        isConstructor(),
+        CouchbaseEnvironmentInstrumentation.class.getName() + "$ConstructorAdvice");
+  }
+
+  @SuppressWarnings("unused")
+  public static class ConstructorAdvice {
+
+    @Advice.OnMethodExit(suppress = Throwable.class)
+    public static void onExit(@Advice.This CoreEnvironment.Builder<?> builder) {
+      builder.requestTracer(OpenTelemetryRequestTracer.wrap(GlobalOpenTelemetry.get()));
+    }
+  }
+}
diff --git a/instrumentation/couchbase/couchbase-3.4/javaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/couchbase/v3_4/CouchbaseInstrumentationModule.java b/instrumentation/couchbase/couchbase-3.4/javaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/couchbase/v3_4/CouchbaseInstrumentationModule.java
@@ -0,0 +1,41 @@
+/*
+ * Copyright The OpenTelemetry Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+package io.opentelemetry.javaagent.instrumentation.couchbase.v3_4;
+
+import static io.opentelemetry.javaagent.extension.matcher.AgentElementMatchers.hasClassesNamed;
+
+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.Collections;
+import java.util.List;
+import net.bytebuddy.matcher.ElementMatcher;
+
+@AutoService(InstrumentationModule.class)
+public class CouchbaseInstrumentationModule extends InstrumentationModule
+    implements ExperimentalInstrumentationModule {
+  public CouchbaseInstrumentationModule() {
+    super("couchbase", "couchbase-3.4");
+  }
+
+  @Override
+  public ElementMatcher.Junction<ClassLoader> classLoaderMatcher() {
+    // CoreTransactionRequest was introduced in 3.4.0 with integrated transactions support.
+    return hasClassesNamed(
+        "com.couchbase.client.core.transaction.components.CoreTransactionRequest");
+  }
+
+  @Override
+  public List<TypeInstrumentation> typeInstrumentations() {
+    return Collections.singletonList(new CouchbaseEnvironmentInstrumentation());
+  }
+
+  @Override
+  public boolean isIndyReady() {
+    return true;
+  }
+}
diff --git a/instrumentation/couchbase/couchbase-3.4/javaagent/src/test/java/io/opentelemetry/javaagent/instrumentation/couchbase/v3_4/CouchbaseClient34Test.java b/instrumentation/couchbase/couchbase-3.4/javaagent/src/test/java/io/opentelemetry/javaagent/instrumentation/couchbase/v3_4/CouchbaseClient34Test.java
diff --git a/instrumentation/couchbase/couchbase-3.4/metadata.yaml b/instrumentation/couchbase/couchbase-3.4/metadata.yaml
diff --git a/instrumentation/couchbase/couchbase-3.4/tracing-opentelemetry-shaded/build.gradle.kts b/instrumentation/couchbase/couchbase-3.4/tracing-opentelemetry-shaded/build.gradle.kts
diff --git a/settings.gradle.kts b/settings.gradle.kts
