Module cleanup (run 25289183017) (#18538)

Co-authored-by: otelbot <197425009+otelbot@users.noreply.github.com>
Co-authored-by: Trask Stalnaker <trask.stalnaker@gmail.com>

Author: otelbot[bot]

.github/agents/knowledge/gradle-conventions.md

@@ -266,20 +266,27 @@ These system properties support the metadata collection pipeline. They are not r
 test correctness and are being added as a separate migration — **do not add them during
 review**. Only verify correctness when they are already present.
 
+Do not add `collectMetadata` or `metadataConfig` to `javaagent-unit-tests` projects. These are
+unit tests, and metadata collection should not run there.
+
 | Property | Type | Value |
 | --- | --- | --- |
 | `collectMetadata` | System property | Pass-through of `otelProps.collectMetadata`; defaults to `false` |
 | `metadataConfig` | System property | A single `key=value` string describing the non-default configuration active during this test run |
 
 When already present, verify:
 
+- `metadataConfig` is only used in files that also configure `collectMetadata`. A lone
+  `metadataConfig` does not enable collection and should be removed, not added as a partial
+  metadata migration.
 - `collectMetadata` is in `tasks.test` for single-test-task modules, or in
   `withType<Test>().configureEach` for modules that explicitly register additional `Test`
   tasks via `by registering(Test::class)` (`latestDepTest` does not count) — never on
   individual tasks. Do not use
   `withType<Test>().configureEach { ... }` in single-test-task modules.
-- `metadataConfig` is on each non-default task. It may also appear on the default `test`
-  task when that task itself runs with non-default `jvmArgs` (e.g., an experimental flag
-  enabled module-wide via `withType<Test>().configureEach { jvmArgs(...) }`); in that case
-  the `metadataConfig` value should describe those non-default jvmArgs.
+- `metadataConfig` is on each non-default task that participates in metadata collection. It may
+  also appear on the default `test` task when that task participates in metadata collection and
+  itself runs with non-default `jvmArgs` (e.g., an experimental flag enabled module-wide via
+  `withType<Test>().configureEach { jvmArgs(...) }`); in that case the `metadataConfig` value
+  should describe those non-default jvmArgs.
 - The `metadataConfig` value matches at least one of the jvmArgs configured in the task

instrumentation/cassandra/cassandra-4.0/javaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/cassandra/v4_0/CompletionStageFunction.java

@@ -7,11 +7,13 @@
 
 import com.datastax.oss.driver.api.core.CqlSession;
 import java.util.function.Function;
+import javax.annotation.Nullable;
 
 public class CompletionStageFunction implements Function<Object, Object> {
 
   @Override
-  public Object apply(Object session) {
+  @Nullable
+  public Object apply(@Nullable Object session) {
     if (session == null) {
       return null;
     }

instrumentation/cassandra/cassandra-4.0/javaagent/src/test/java/io/opentelemetry/javaagent/instrumentation/cassandra/v4_0/CassandraTest.java

@@ -12,14 +12,14 @@
 
 class CassandraTest extends AbstractCassandraTest {
 
+  @RegisterExtension
+  static final InstrumentationExtension testing = AgentInstrumentationExtension.create();
+
   @Override
   protected String getInstrumentationName() {
     return "io.opentelemetry.cassandra-4.0";
   }
 
-  @RegisterExtension
-  static final InstrumentationExtension testing = AgentInstrumentationExtension.create();
-
   @Override
   protected InstrumentationExtension testing() {
     return testing;

instrumentation/cassandra/cassandra-4.4/library/build.gradle.kts

@@ -18,6 +18,7 @@ dependencies {
 tasks {
   withType<Test>().configureEach {
     usesService(gradle.sharedServices.registrations["testcontainersBuildService"].service)
+    systemProperty("collectMetadata", otelProps.collectMetadata)
   }
 
   val testStableSemconv by registering(Test::class) {

instrumentation/cassandra/cassandra-4.4/library/src/main/java/io/opentelemetry/instrumentation/cassandra/v4_4/CassandraAttributesExtractor.java

@@ -62,7 +62,7 @@ final class CassandraAttributesExtractor
   private static final AttributeKey<Long> CASSANDRA_SPECULATIVE_EXECUTION_COUNT =
       AttributeKey.longKey("cassandra.speculative_execution.count");
 
-  private static final Field proxyAddressField = getProxyAddressField();
+  private static final Field PROXY_ADDRESS_FIELD = getProxyAddressField();
 
   @Override
   public void onStart(
@@ -161,11 +161,11 @@ private static void updateServerAddressAndPort(AttributesBuilder attributes, Nod
       InetSocketAddress address = ((DefaultEndPoint) endPoint).resolve();
       attributes.put(SERVER_ADDRESS, address.getHostString());
       attributes.put(SERVER_PORT, address.getPort());
-    } else if (endPoint instanceof SniEndPoint && proxyAddressField != null) {
+    } else if (endPoint instanceof SniEndPoint && PROXY_ADDRESS_FIELD != null) {
       SniEndPoint sniEndPoint = (SniEndPoint) endPoint;
       Object object = null;
       try {
-        object = proxyAddressField.get(sniEndPoint);
+        object = PROXY_ADDRESS_FIELD.get(sniEndPoint);
       } catch (Exception e) {
         logger.log(
             FINE,

instrumentation/cassandra/cassandra-4.4/library/src/main/java/io/opentelemetry/instrumentation/cassandra/v4_4/CassandraTelemetry.java

@@ -5,13 +5,15 @@
 
 package io.opentelemetry.instrumentation.cassandra.v4_4;
 
+import static java.util.Objects.requireNonNull;
+
 import com.datastax.oss.driver.api.core.CqlSession;
 import com.datastax.oss.driver.api.core.cql.ExecutionInfo;
 import io.opentelemetry.api.OpenTelemetry;
 import io.opentelemetry.instrumentation.api.instrumenter.Instrumenter;
 
 /** Entrypoint for instrumenting cassandra sessions. */
-public class CassandraTelemetry {
+public final class CassandraTelemetry {
   private final TracingCqlSession tracingCqlSession;
 
   /** Returns a new {@link CassandraTelemetry} configured with the given {@link OpenTelemetry}. */
@@ -27,7 +29,7 @@ public static CassandraTelemetryBuilder builder(OpenTelemetry openTelemetry) {
     return new CassandraTelemetryBuilder(openTelemetry);
   }
 
-  protected CassandraTelemetry(Instrumenter<CassandraRequest, ExecutionInfo> instrumenter) {
+  CassandraTelemetry(Instrumenter<CassandraRequest, ExecutionInfo> instrumenter) {
     this.tracingCqlSession = new TracingCqlSession(instrumenter);
   }
 
@@ -38,6 +40,6 @@ protected CassandraTelemetry(Instrumenter<CassandraRequest, ExecutionInfo> instr
    * @return a {@link TracingCqlSession}.
    */
   public CqlSession wrap(CqlSession session) {
-    return tracingCqlSession.wrapSession(session);
+    return tracingCqlSession.wrapSession(requireNonNull(session, "session"));
   }
 }

instrumentation/cassandra/cassandra-4.4/library/src/main/java/io/opentelemetry/instrumentation/cassandra/v4_4/CassandraTelemetryBuilder.java

@@ -16,7 +16,7 @@
 import io.opentelemetry.instrumentation.api.instrumenter.SpanKindExtractor;
 
 /** A builder of {@link CassandraTelemetry}. */
-public class CassandraTelemetryBuilder {
+public final class CassandraTelemetryBuilder {
 
   private static final String INSTRUMENTATION_NAME = "io.opentelemetry.cassandra-4.4";
   // copied from DbIncubatingAttributes
@@ -27,7 +27,7 @@ public class CassandraTelemetryBuilder {
 
   private boolean querySanitizationEnabled = true;
 
-  protected CassandraTelemetryBuilder(OpenTelemetry openTelemetry) {
+  CassandraTelemetryBuilder(OpenTelemetry openTelemetry) {
     this.openTelemetry = openTelemetry;
   }
 
@@ -52,7 +52,7 @@ public CassandraTelemetry build() {
   }
 
   @SuppressWarnings("deprecation") // to support old database semantic conventions
-  protected Instrumenter<CassandraRequest, ExecutionInfo> createInstrumenter(
+  private static Instrumenter<CassandraRequest, ExecutionInfo> createInstrumenter(
       OpenTelemetry openTelemetry, boolean querySanitizationEnabled) {
     CassandraSqlAttributesGetter attributesGetter = new CassandraSqlAttributesGetter();
 

instrumentation/cassandra/cassandra-4.4/library/src/main/java/io/opentelemetry/instrumentation/cassandra/v4_4/TracingCqlSession.java

@@ -36,10 +36,6 @@ final class TracingCqlSession {
   }
 
   CqlSession wrapSession(CqlSession session) {
-    if (session == null) {
-      return null;
-    }
-
     List<Class<?>> interfaces = new ArrayList<>();
     Class<?> clazz = session.getClass();
     while (clazz != Object.class) {

instrumentation/cassandra/cassandra-4.4/library/src/test/java/io/opentelemetry/instrumentation/cassandra/v4_4/CassandraTest.java

@@ -13,14 +13,14 @@
 
 class CassandraTest extends AbstractCassandra44Test {
 
+  @RegisterExtension
+  static final InstrumentationExtension testing = LibraryInstrumentationExtension.create();
+
   @Override
   protected String getInstrumentationName() {
     return "io.opentelemetry.cassandra-4.4";
   }
 
-  @RegisterExtension
-  static final InstrumentationExtension testing = LibraryInstrumentationExtension.create();
-
   @Override
   protected InstrumentationExtension testing() {
     return testing;

instrumentation/cassandra/cassandra-4.4/metadata.yaml

@@ -7,6 +7,13 @@ semantic_conventions:
   - DATABASE_CLIENT_METRICS
 library_link: https://github.com/apache/cassandra-java-driver
 configurations:
+  - name: otel.instrumentation.cassandra.query-sanitization.enabled
+    declarative_name: java.cassandra.query_sanitization.enabled
+    description: >
+      Enables query sanitization for Cassandra queries. Takes precedence over
+      otel.instrumentation.common.db.query-sanitization.enabled.
+    type: boolean
+    default: true
   - name: otel.instrumentation.common.db.query-sanitization.enabled
     declarative_name: java.common.db.query_sanitization.enabled
     description: Enables query sanitization for database queries.