Couchbase 3.1.6
ADD
instrumentation/couchbase/couchbase-3.1.6/javaagent/couchbase-3.1.6-javaagent.gradle
+apply from: "$rootDir/gradle/instrumentation.gradle"
+
+muzzle {
+ pass {
+ group = "com.couchbase.client"
+ module = "java-client"
+ versions = "[3.1.6,)"
+ // these versions were released as ".bundle" instead of ".jar"
+ skip('2.7.5', '2.7.8')
+ assertInverse = true
+ }
+}
+
+dependencies {
+ implementation("com.couchbase.client:tracing-opentelemetry:0.3.6") {
+ exclude(group: "com.couchbase.client", module: "core-io")
+ }
+
+ library "com.couchbase.client:core-io:2.1.6"
+
+ testLibrary "com.couchbase.client:java-client:3.1.6"
+
+ testImplementation group: "org.testcontainers", name: "couchbase", version: versions["org.testcontainers"]
+}
\ No newline at end of file

ADD
instrumentation/couchbase/couchbase-3.1.6/javaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/couchbase/v3_1_6/CouchbaseEnvironmentInstrumentation.java
+/*
+ * Copyright The OpenTelemetry Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+package io.opentelemetry.javaagent.instrumentation.couchbase.v3_1_6;
+
+import static net.bytebuddy.matcher.ElementMatchers.isConstructor;
+import static net.bytebuddy.matcher.ElementMatchers.named;
+
+import com.couchbase.client.core.env.CoreEnvironment;
+import com.couchbase.client.tracing.opentelemetry.OpenTelemetryRequestTracer;
+import io.opentelemetry.api.GlobalOpenTelemetry;
+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;
+
+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");
+ }
+
+ public static class ConstructorAdvice {
+ @Advice.OnMethodExit(suppress = Throwable.class)
+ public static void onExit(@Advice.This CoreEnvironment.Builder<?> builder) {
+ builder.requestTracer(OpenTelemetryRequestTracer.wrap(GlobalOpenTelemetry.get()));
+ }
+ }
+}

ADD
instrumentation/couchbase/couchbase-3.1.6/javaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/couchbase/v3_1_6/CouchbaseInstrumentationModule.java
+/*
+ * Copyright The OpenTelemetry Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+package io.opentelemetry.javaagent.instrumentation.couchbase.v3_1_6;
+
+import static io.opentelemetry.javaagent.extension.matcher.ClassLoaderMatcher.hasClassesNamed;
+
+import com.google.auto.service.AutoService;
+import io.opentelemetry.javaagent.extension.instrumentation.InstrumentationModule;
+import io.opentelemetry.javaagent.extension.instrumentation.TypeInstrumentation;
+import java.util.Collections;
+import java.util.List;
+import net.bytebuddy.matcher.ElementMatcher;
+
+@AutoService(InstrumentationModule.class)
+public class CouchbaseInstrumentationModule extends InstrumentationModule {
+ public CouchbaseInstrumentationModule() {
+ super("couchbase", "couchbase-3.1.6");
+ }
+
+ @Override
+ public boolean isHelperClass(String className) {
+ return className.startsWith("com.couchbase.client.tracing.opentelemetry");
+ }
+
+ @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");
+ }
+
+ @Override
+ public List<TypeInstrumentation> typeInstrumentations() {
+ return Collections.singletonList(new CouchbaseEnvironmentInstrumentation());
+ }
+}

ADD
instrumentation/couchbase/couchbase-3.1.6/javaagent/src/test/groovy/CouchbaseClient316Test.groovy
+/*
+ * Copyright The OpenTelemetry Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+import com.couchbase.client.core.error.DocumentNotFoundException
+import com.couchbase.client.java.Cluster
+import com.couchbase.client.java.Collection
+import io.opentelemetry.instrumentation.test.AgentInstrumentationSpecification
+import java.time.Duration
+import org.slf4j.Logger
+import org.slf4j.LoggerFactory
+import org.testcontainers.containers.output.Slf4jLogConsumer
+import org.testcontainers.couchbase.BucketDefinition
+import org.testcontainers.couchbase.CouchbaseContainer
+import org.testcontainers.couchbase.CouchbaseService
+import spock.lang.Shared
+
+// Couchbase instrumentation is owned upstream so we don't assert on the contents of the spans, only
+// that the instrumentation is properly registered by the agent, meaning some spans were generated.
+class CouchbaseClient316Test extends AgentInstrumentationSpecification {
+ private static final Logger log = LoggerFactory.getLogger("couchbase-container")
+
+ @Shared
+ CouchbaseContainer couchbase
+ @Shared
+ Cluster cluster
+ @Shared
+ Collection collection
+
+ def setupSpec() {
+ couchbase = new CouchbaseContainer()
+ .withExposedPorts(8091)
+ .withEnabledServices(CouchbaseService.KV)
+ .withBucket(new BucketDefinition("test"))
+ .withLogConsumer(new Slf4jLogConsumer(log))
+ .withStartupTimeout(Duration.ofSeconds(120))
+ couchbase.start()
+
+ cluster = Cluster.connect(couchbase.connectionString, couchbase.username, couchbase.password)
+ def bucket = cluster.bucket("test")
+ collection = bucket.defaultCollection()
+ bucket.waitUntilReady(Duration.ofSeconds(10))
+ }
+
+ def cleanupSpec() {
+ couchbase.stop()
+ }
+
+ def "emits spans"() {
+ when:
+ try {
+ collection.get("id")
+ } catch (DocumentNotFoundException e) {
+ // Expected
+ }
+
+ then:
+ assertTraces(1) {
+ trace(0, 2) {
+ span(0) {
+ name(~/.*get/)
+ }
+ span(1) {
+ name(~/.*dispatch_to_server/)
+ }
+ }
+ }
+
+ cleanup:
+ cluster.disconnect()
+ }
+}

MODIFY
instrumentation/couchbase/couchbase-3.1/javaagent/couchbase-3.1-javaagent.gradle
instrumentation/couchbase/couchbase-3.1/javaagent/couchbase-3.1-javaagent.gradle
@@ -4,7 +4,7 @@ muzzle {
pass {
group = "com.couchbase.client"
module = "java-client"
- versions = "[3.1,)"
+ versions = "[3.1,3.1.6)"
// these versions were released as ".bundle" instead of ".jar"
skip('2.7.5', '2.7.8')
assertInverse = true
@@ -21,4 +21,6 @@ dependencies {
testLibrary "com.couchbase.client:java-client:3.1.0"
testImplementation group: "org.testcontainers", name: "couchbase", version: versions["org.testcontainers"]
+
+ latestDepTestLibrary "com.couchbase.client:java-client:3.1.5"
}
\ No newline at end of file

MODIFY
settings.gradle
settings.gradle
@@ -120,6 +120,7 @@ include ':instrumentation:couchbase:couchbase-2.0:javaagent'
include ':instrumentation:couchbase:couchbase-2.0:javaagent-unit-tests'
include ':instrumentation:couchbase:couchbase-2.6:javaagent'
include ':instrumentation:couchbase:couchbase-3.1:javaagent'
+include ':instrumentation:couchbase:couchbase-3.1.6:javaagent'
include ':instrumentation:couchbase:couchbase-testing'
include ':instrumentation:dropwizard-views-0.7:javaagent'
include ':instrumentation:dropwizard-testing'

Couchbase 3.1.6 (#3194)