Add Jedis pipeline span batch support

.fossa.yml

@@ -595,6 +595,9 @@ targets:
     - type: gradle
       path: ./
       target: ':instrumentation:jedis:jedis-1.4:javaagent'
+    - type: gradle
+      path: ./
+      target: ':instrumentation:jedis:jedis-2.0:javaagent'
     - type: gradle
       path: ./
       target: ':instrumentation:jedis:jedis-3.0:javaagent'

.github/config/latest-dep-versions.json

@@ -555,6 +555,7 @@
     "org.vibur:vibur-dbcp#+": "26.0",
     "org.xerial:sqlite-jdbc#+": "3.53.2.0",
     "redis.clients:jedis#+": "7.5.2",
+    "redis.clients:jedis#1.+": "1.5.2",
     "redis.clients:jedis#2.+": "2.10.2",
     "redis.clients:jedis#3.+": "3.10.0",
     "software.amazon.awssdk.crt:aws-crt#+": "0.47.1",

.github/scripts/instrumentations.sh

@@ -155,6 +155,8 @@ readonly INSTRUMENTATIONS=(
   "jdbc:javaagent:testStableSemconv"
   "jedis:jedis-1.4:javaagent:test"
   "jedis:jedis-1.4:javaagent:testStableSemconv"
+  "jedis:jedis-2.0:javaagent:test"
+  "jedis:jedis-2.0:javaagent:testStableSemconv"
   "jedis:jedis-3.0:javaagent:test"
   "jedis:jedis-3.0:javaagent:testStableSemconv"
   "jedis:jedis-4.0:javaagent:test"

docs/supported-libraries.md

@@ -99,7 +99,7 @@ These are the supported libraries and frameworks:
 | [JAX-WS](https://jakarta.ee/specifications/xml-web-services/2.3/apidocs/javax/xml/ws/package-summary.html)                                  | 2.0+ (not including 3.0+ yet)      | N/A                                                                                                                                                                                                                                                                                                                                                                                     | Provides `http.route` [2], Controller Spans [3]                                                                                                   |
 | [JBoss Log Manager](https://github.com/jboss-logging/jboss-logmanager)                                                                      | 1.1+                               | N/A                                                                                                                                                                                                                                                                                                                                                                                     | none                                                                                                                                              |
 | [JDBC](https://docs.oracle.com/javase/8/docs/api/java/sql/package-summary.html)                                                             | Java 8+                            | [opentelemetry-jdbc](../instrumentation/jdbc/library)                                                                                                                                                                                                                                                                                                                                   | [Database Client Spans], [Database Client Metrics] [6]                                                                                       |
-| [Jedis](https://github.com/xetorthio/jedis)                                                                                                 | 1.4+                               | N/A                                                                                                                                                                                                                                                                                                                                                                                     | [Database Client Spans], [Database Client Metrics] [6]                                                                                       |
+| [Jedis](https://github.com/xetorthio/jedis)                                                                                                 | 1.4+ [7]                           | N/A                                                                                                                                                                                                                                                                                                                                                                                     | [Database Client Spans], [Database Client Metrics] [6]                                                                                       |
 | [JFinal](https://github.com/jfinal/jfinal)                                                                                                  | 3.2+                               | N/A                                                                                                                                                                                                                                                                                                                                                                                     | Provides `http.route` [2], Controller Spans [3]                                                                                                   |
 | [JMS](https://javaee.github.io/javaee-spec/javadocs/javax/jms/package-summary.html)                                                         | 1.1+                               | N/A                                                                                                                                                                                                                                                                                                                                                                                     | [Messaging Spans]                                                                                                                                 |
 | [Jodd Http](https://http.jodd.org/)                                                                                                         | 4.2+                               | N/A                                                                                                                                                                                                                                                                                                                                                                                     | [HTTP Client Spans], [HTTP Client Metrics]                                                                                                        |
@@ -187,6 +187,8 @@ These are the supported libraries and frameworks:
 
 **[6]** Database Client Metrics are available for those who opt-in to [semantic convention stability](https://opentelemetry.io/docs/specs/semconv/non-normative/db-migration/).
 
+**[7]** When `otel.instrumentation.common.v3-preview` is enabled, Jedis instrumentation supports 2.0+.
+
 [Elasticsearch Client Spans]: https://github.com/open-telemetry/semantic-conventions/blob/main/docs/db/elasticsearch.md
 [HTTP Server Spans]: https://github.com/open-telemetry/semantic-conventions/blob/main/docs/http/http-spans.md#http-server
 [HTTP Client Spans]: https://github.com/open-telemetry/semantic-conventions/blob/main/docs/http/http-spans.md#http-client-span

instrumentation/jedis/jedis-1.4/javaagent/build.gradle.kts

@@ -6,7 +6,7 @@ muzzle {
   pass {
     group.set("redis.clients")
     module.set("jedis")
-    versions.set("[1.4.0,3.0.0)")
+    versions.set("[1.4.0,2.0.0)")
     assertInverse.set(true)
   }
 }
@@ -19,23 +19,14 @@ dependencies {
 
   implementation(project(":instrumentation:jedis:jedis-common-1.4:javaagent"))
 
-  testImplementation(project(":instrumentation:jedis:jedis-1.4:testing"))
+  testImplementation("io.opentelemetry.javaagent:opentelemetry-testing-common")
+  testImplementation("org.testcontainers:testcontainers")
 
+  testInstrumentation(project(":instrumentation:jedis:jedis-2.0:javaagent"))
   testInstrumentation(project(":instrumentation:jedis:jedis-3.0:javaagent"))
   testInstrumentation(project(":instrumentation:jedis:jedis-4.0:javaagent"))
 
-  latestDepTestLibrary("redis.clients:jedis:2.+") // see jedis-3.0 module
-}
-
-testing {
-  suites {
-    val version272 by registering(JvmTestSuite::class) {
-      dependencies {
-        implementation("redis.clients:jedis:2.7.2")
-        implementation(project(":instrumentation:jedis:jedis-1.4:testing"))
-      }
-    }
-  }
+  latestDepTestLibrary("redis.clients:jedis:1.+") // see jedis-2.0 module
 }
 
 tasks {
@@ -53,6 +44,6 @@ tasks {
   }
 
   check {
-    dependsOn(testing.suites, testStableSemconv)
+    dependsOn(testStableSemconv)
   }
 }

instrumentation/jedis/jedis-1.4/javaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/jedis/v1_4/JedisInstrumentationModule.java

@@ -10,22 +10,30 @@
 import static net.bytebuddy.matcher.ElementMatchers.not;
 
 import com.google.auto.service.AutoService;
+import io.opentelemetry.javaagent.bootstrap.internal.AgentCommonConfig;
 import io.opentelemetry.javaagent.extension.instrumentation.InstrumentationModule;
 import io.opentelemetry.javaagent.extension.instrumentation.TypeInstrumentation;
 import java.util.List;
 import net.bytebuddy.matcher.ElementMatcher;
 
+@Deprecated // disabled under v3-preview; to be removed in 3.0
 @AutoService(InstrumentationModule.class)
 public class JedisInstrumentationModule extends InstrumentationModule {
 
   public JedisInstrumentationModule() {
     super("jedis", "jedis-1.4");
   }
 
+  @Override
+  public boolean defaultEnabled() {
+    // disabled under v3-preview, where jedis 1.x is no longer supported
+    return super.defaultEnabled() && !AgentCommonConfig.get().isV3Preview();
+  }
+
   @Override
   public ElementMatcher.Junction<ClassLoader> classLoaderMatcher() {
-    // added in 3.0
-    return not(hasClassesNamed("redis.clients.jedis.commands.ProtocolCommand"));
+    // added in 2.0
+    return not(hasClassesNamed("redis.clients.jedis.Response"));
   }
 
   @Override

instrumentation/jedis/jedis-1.4/javaagent/src/test/java/io/opentelemetry/javaagent/instrumentation/jedis/v1_4/JedisClientTest.java

@@ -5,6 +5,161 @@
 
 package io.opentelemetry.javaagent.instrumentation.jedis.v1_4;
 
-import io.opentelemetry.javaagent.instrumentation.jedis.AbstractJedisTest;
+import static io.opentelemetry.instrumentation.api.internal.SemconvStability.emitStableDatabaseSemconv;
+import static io.opentelemetry.instrumentation.testing.junit.db.DbClientMetricsTestUtil.assertDurationMetric;
+import static io.opentelemetry.instrumentation.testing.junit.db.SemconvStabilityUtil.maybeStable;
+import static io.opentelemetry.instrumentation.testing.junit.service.SemconvServiceStabilityUtil.maybeStablePeerService;
+import static io.opentelemetry.sdk.testing.assertj.OpenTelemetryAssertions.equalTo;
+import static io.opentelemetry.semconv.ServerAttributes.SERVER_ADDRESS;
+import static io.opentelemetry.semconv.ServerAttributes.SERVER_PORT;
+import static io.opentelemetry.semconv.incubating.DbIncubatingAttributes.DB_OPERATION;
+import static io.opentelemetry.semconv.incubating.DbIncubatingAttributes.DB_OPERATION_NAME;
+import static io.opentelemetry.semconv.incubating.DbIncubatingAttributes.DB_STATEMENT;
+import static io.opentelemetry.semconv.incubating.DbIncubatingAttributes.DB_SYSTEM;
+import static io.opentelemetry.semconv.incubating.DbIncubatingAttributes.DB_SYSTEM_NAME;
+import static io.opentelemetry.semconv.incubating.DbIncubatingAttributes.DbSystemNameIncubatingValues.REDIS;
+import static org.assertj.core.api.Assertions.assertThat;
 
-class JedisClientTest extends AbstractJedisTest {}
+import io.opentelemetry.api.trace.SpanKind;
+import io.opentelemetry.instrumentation.testing.internal.AutoCleanupExtension;
+import io.opentelemetry.instrumentation.testing.junit.AgentInstrumentationExtension;
+import io.opentelemetry.instrumentation.testing.junit.InstrumentationExtension;
+import org.junit.jupiter.api.BeforeAll;
+import org.junit.jupiter.api.BeforeEach;
+import org.junit.jupiter.api.Test;
+import org.junit.jupiter.api.extension.RegisterExtension;
+import org.testcontainers.containers.GenericContainer;
+import redis.clients.jedis.Jedis;
+
+@SuppressWarnings("deprecation") // using deprecated semconv
+class JedisClientTest {
+  @RegisterExtension
+  private static final InstrumentationExtension testing = AgentInstrumentationExtension.create();
+
+  @RegisterExtension
+  private static final AutoCleanupExtension cleanup = AutoCleanupExtension.create();
+
+  private static final GenericContainer<?> redisServer =
+      new GenericContainer<>("redis:6.2.3-alpine").withExposedPorts(6379);
+
+  private static String host;
+
+  private static int port;
+
+  private static Jedis jedis;
+
+  @BeforeAll
+  static void setup() {
+    redisServer.start();
+    cleanup.deferAfterAll(redisServer::stop);
+    host = redisServer.getHost();
+    port = redisServer.getMappedPort(6379);
+    jedis = new Jedis(host, port);
+    cleanup.deferAfterAll(jedis::disconnect);
+  }
+
+  @BeforeEach
+  void reset() {
+    jedis.select(0);
+    jedis.flushAll();
+    testing.clearData();
+  }
+
+  @Test
+  void setCommand() {
+    jedis.set("foo", "bar");
+
+    testing.waitAndAssertTraces(
+        trace ->
+            trace.hasSpansSatisfyingExactly(
+                span ->
+                    span.hasName(emitStableDatabaseSemconv() ? "SET " + host + ":" + port : "SET")
+                        .hasKind(SpanKind.CLIENT)
+                        .hasAttributesSatisfyingExactly(
+                            equalTo(maybeStable(DB_SYSTEM), REDIS),
+                            equalTo(maybeStable(DB_STATEMENT), "SET foo ?"),
+                            equalTo(maybeStable(DB_OPERATION), "SET"),
+                            equalTo(maybeStablePeerService(), "test-peer-service"),
+                            equalTo(SERVER_ADDRESS, host),
+                            equalTo(SERVER_PORT, port))));
+
+    assertDurationMetric(
+        testing,
+        "io.opentelemetry.jedis-1.4",
+        DB_SYSTEM_NAME,
+        DB_OPERATION_NAME,
+        SERVER_ADDRESS,
+        SERVER_PORT);
+  }
+
+  @Test
+  void getCommand() {
+    jedis.set("foo", "bar");
+    String value = jedis.get("foo");
+
+    assertThat(value).isEqualTo("bar");
+
+    testing.waitAndAssertTraces(
+        trace ->
+            trace.hasSpansSatisfyingExactly(
+                span ->
+                    span.hasName(emitStableDatabaseSemconv() ? "SET " + host + ":" + port : "SET")
+                        .hasKind(SpanKind.CLIENT)
+                        .hasAttributesSatisfyingExactly(
+                            equalTo(maybeStable(DB_SYSTEM), REDIS),
+                            equalTo(maybeStable(DB_STATEMENT), "SET foo ?"),
+                            equalTo(maybeStable(DB_OPERATION), "SET"),
+                            equalTo(maybeStablePeerService(), "test-peer-service"),
+                            equalTo(SERVER_ADDRESS, host),
+                            equalTo(SERVER_PORT, port))),
+        trace ->
+            trace.hasSpansSatisfyingExactly(
+                span ->
+                    span.hasName(emitStableDatabaseSemconv() ? "GET " + host + ":" + port : "GET")
+                        .hasKind(SpanKind.CLIENT)
+                        .hasAttributesSatisfyingExactly(
+                            equalTo(maybeStable(DB_SYSTEM), REDIS),
+                            equalTo(maybeStable(DB_STATEMENT), "GET foo"),
+                            equalTo(maybeStable(DB_OPERATION), "GET"),
+                            equalTo(maybeStablePeerService(), "test-peer-service"),
+                            equalTo(SERVER_ADDRESS, host),
+                            equalTo(SERVER_PORT, port))));
+  }
+
+  @Test
+  void commandWithNoArguments() {
+    jedis.set("foo", "bar");
+    String value = jedis.randomKey();
+
+    assertThat(value).isEqualTo("foo");
+
+    testing.waitAndAssertTraces(
+        trace ->
+            trace.hasSpansSatisfyingExactly(
+                span ->
+                    span.hasName(emitStableDatabaseSemconv() ? "SET " + host + ":" + port : "SET")
+                        .hasKind(SpanKind.CLIENT)
+                        .hasAttributesSatisfyingExactly(
+                            equalTo(maybeStable(DB_SYSTEM), REDIS),
+                            equalTo(maybeStable(DB_STATEMENT), "SET foo ?"),
+                            equalTo(maybeStable(DB_OPERATION), "SET"),
+                            equalTo(maybeStablePeerService(), "test-peer-service"),
+                            equalTo(SERVER_ADDRESS, host),
+                            equalTo(SERVER_PORT, port))),
+        trace ->
+            trace.hasSpansSatisfyingExactly(
+                span ->
+                    span.hasName(
+                            emitStableDatabaseSemconv()
+                                ? "RANDOMKEY " + host + ":" + port
+                                : "RANDOMKEY")
+                        .hasKind(SpanKind.CLIENT)
+                        .hasAttributesSatisfyingExactly(
+                            equalTo(maybeStable(DB_SYSTEM), REDIS),
+                            equalTo(maybeStable(DB_STATEMENT), "RANDOMKEY"),
+                            equalTo(maybeStable(DB_OPERATION), "RANDOMKEY"),
+                            equalTo(maybeStablePeerService(), "test-peer-service"),
+                            equalTo(SERVER_ADDRESS, host),
+                            equalTo(SERVER_PORT, port))));
+  }
+}