Fix Mongo stable DB span names

Author: trask

instrumentation-api-incubator/src/main/java/io/opentelemetry/instrumentation/api/incubator/semconv/db/DbClientAttributesExtractor.java

@@ -54,12 +54,13 @@ public final class DbClientAttributesExtractor<REQUEST, RESPONSE>
   private final DbClientAttributesGetter<REQUEST, RESPONSE> getter;
   private final InternalNetworkAttributesExtractor<REQUEST, RESPONSE> internalNetworkExtractor;
   private final ServerAttributesExtractor<REQUEST, RESPONSE> serverAttributesExtractor;
+  @Nullable private final AttributeKey<String> oldSemconvCollectionAttribute;
   private final boolean captureQueryParameters;
 
   /** Creates the database client attributes extractor with default configuration. */
   public static <REQUEST, RESPONSE> AttributesExtractor<REQUEST, RESPONSE> create(
       DbClientAttributesGetter<REQUEST, RESPONSE> getter) {
-    return new DbClientAttributesExtractor<>(getter, false);
+    return new DbClientAttributesExtractor<>(getter, null, false);
   }
 
   /**
@@ -72,8 +73,11 @@ public static <REQUEST, RESPONSE> DbClientAttributesExtractorBuilder<REQUEST, RE
   }
 
   DbClientAttributesExtractor(
-      DbClientAttributesGetter<REQUEST, RESPONSE> getter, boolean captureQueryParameters) {
+      DbClientAttributesGetter<REQUEST, RESPONSE> getter,
+      @Nullable AttributeKey<String> oldSemconvCollectionAttribute,
+      boolean captureQueryParameters) {
     this.getter = getter;
+    this.oldSemconvCollectionAttribute = oldSemconvCollectionAttribute;
     this.captureQueryParameters = captureQueryParameters;
     internalNetworkExtractor =
         new InternalNetworkAttributesExtractor<>(getter, emitOldDatabaseSemconv(), false);
@@ -84,6 +88,9 @@ public static <REQUEST, RESPONSE> DbClientAttributesExtractorBuilder<REQUEST, RE
   @Override
   public void onStart(AttributesBuilder attributes, Context parentContext, REQUEST request) {
     onStartCommon(attributes, getter, request, captureQueryParameters);
+    if (emitOldDatabaseSemconv() && oldSemconvCollectionAttribute != null) {
+      attributes.put(oldSemconvCollectionAttribute, getter.getDbCollectionName(request));
+    }
     serverAttributesExtractor.onStart(attributes, parentContext, request);
   }
 

instrumentation-api-incubator/src/main/java/io/opentelemetry/instrumentation/api/incubator/semconv/db/DbClientAttributesExtractorBuilder.java

@@ -6,18 +6,35 @@
 package io.opentelemetry.instrumentation.api.incubator.semconv.db;
 
 import com.google.errorprone.annotations.CanIgnoreReturnValue;
+import io.opentelemetry.api.common.AttributeKey;
 import io.opentelemetry.instrumentation.api.instrumenter.AttributesExtractor;
+import javax.annotation.Nullable;
 
 /** A builder of {@link DbClientAttributesExtractor}. */
 public final class DbClientAttributesExtractorBuilder<REQUEST, RESPONSE> {
 
   final DbClientAttributesGetter<REQUEST, RESPONSE> getter;
+  @Nullable AttributeKey<String> oldSemconvCollectionAttribute;
   boolean captureQueryParameters = false;
 
   DbClientAttributesExtractorBuilder(DbClientAttributesGetter<REQUEST, RESPONSE> getter) {
     this.getter = getter;
   }
 
+  /**
+   * Sets the attribute key for the old semconv collection attribute. Pass {@code null} to disable
+   * emitting any collection attribute under old semconv.
+   *
+   * @deprecated new semantic conventions always use db.collection.name
+   */
+  @CanIgnoreReturnValue
+  @Deprecated // to be removed in 3.0
+  public DbClientAttributesExtractorBuilder<REQUEST, RESPONSE> setOldSemconvCollectionAttribute(
+      @Nullable AttributeKey<String> oldSemconvCollectionAttribute) {
+    this.oldSemconvCollectionAttribute = oldSemconvCollectionAttribute;
+    return this;
+  }
+
   /**
    * Sets whether the query parameters should be captured as span attributes named {@code
    * db.query.parameter.<key>}. Disabled by default.
@@ -37,6 +54,7 @@ public DbClientAttributesExtractorBuilder<REQUEST, RESPONSE> setCaptureQueryPara
    * DbClientAttributesExtractorBuilder}.
    */
   public AttributesExtractor<REQUEST, RESPONSE> build() {
-    return new DbClientAttributesExtractor<>(getter, captureQueryParameters);
+    return new DbClientAttributesExtractor<>(
+        getter, oldSemconvCollectionAttribute, captureQueryParameters);
   }
 }

instrumentation-api-incubator/src/test/java/io/opentelemetry/instrumentation/api/incubator/semconv/db/DbClientAttributesExtractorTest.java

@@ -23,6 +23,7 @@
 import static java.util.Collections.emptyMap;
 import static org.assertj.core.api.Assertions.entry;
 
+import io.opentelemetry.api.common.AttributeKey;
 import io.opentelemetry.api.common.Attributes;
 import io.opentelemetry.api.common.AttributesBuilder;
 import io.opentelemetry.context.Context;
@@ -34,6 +35,9 @@
 
 class DbClientAttributesExtractorTest {
 
+  private static final AttributeKey<String> DB_OLD_COLLECTION =
+      AttributeKey.stringKey("db.old.collection");
+
   static class TestAttributesGetter implements DbClientAttributesGetter<Map<String, String>, Void> {
     @Override
     public String getDbSystemName(Map<String, String> map) {
@@ -85,6 +89,33 @@ public String getDbOperation(Map<String, String> map) {
     }
   }
 
+  @SuppressWarnings("deprecation") // until old db semconv are dropped
+  @Test
+  void shouldExtractConfiguredOldCollectionAttribute() {
+    // given
+    Map<String, String> request = new HashMap<>();
+    request.put("db.collection.name", "potato");
+
+    AttributesExtractor<Map<String, String>, Void> underTest =
+        DbClientAttributesExtractor.builder(new TestAttributesGetter())
+            .setOldSemconvCollectionAttribute(DB_OLD_COLLECTION)
+            .build();
+
+    // when
+    AttributesBuilder attributes = Attributes.builder();
+    underTest.onStart(attributes, Context.root(), request);
+
+    // then
+    if (emitStableDatabaseSemconv() && emitOldDatabaseSemconv()) {
+      assertThat(attributes.build())
+          .containsOnly(entry(DB_OLD_COLLECTION, "potato"), entry(DB_COLLECTION_NAME, "potato"));
+    } else if (emitOldDatabaseSemconv()) {
+      assertThat(attributes.build()).containsOnly(entry(DB_OLD_COLLECTION, "potato"));
+    } else if (emitStableDatabaseSemconv()) {
+      assertThat(attributes.build()).containsOnly(entry(DB_COLLECTION_NAME, "potato"));
+    }
+  }
+
   @SuppressWarnings("deprecation") // TODO DB_CONNECTION_STRING deprecation
   @Test
   void shouldExtractAllAvailableAttributes() {

instrumentation/mongo/mongo-3.1/library/src/main/java/io/opentelemetry/instrumentation/mongo/v3_1/internal/MongoAttributesExtractor.java

@@ -5,6 +5,8 @@
 
 package io.opentelemetry.instrumentation.mongo.v3_1.internal;
 
+import static java.util.Arrays.asList;
+
 import com.mongodb.MongoException;
 import com.mongodb.ServerAddress;
 import com.mongodb.connection.ConnectionDescription;
@@ -13,8 +15,10 @@
 import java.lang.reflect.InvocationTargetException;
 import java.lang.reflect.Method;
 import java.util.Arrays;
+import java.util.HashSet;
 import java.util.Map;
 import java.util.Optional;
+import java.util.Set;
 import javax.annotation.Nullable;
 import org.bson.BsonArray;
 import org.bson.BsonDocument;
@@ -29,8 +33,27 @@ class MongoDbAttributesGetter implements DbClientAttributesGetter<CommandStarted
   // copied from DbIncubatingAttributes.DbSystemNameIncubatingValues
   private static final String MONGODB = "mongodb";
 
-  @Nullable private static final Method IS_TRUNCATED_METHOD;
   private static final String HIDDEN_CHAR = "?";
+  private static final Set<String> COMMANDS_WITH_COLLECTION_NAME_AS_VALUE =
+      new HashSet<>(
+          asList(
+              "aggregate",
+              "count",
+              "distinct",
+              "mapReduce",
+              "geoSearch",
+              "delete",
+              "find",
+              "killCursors",
+              "findAndModify",
+              "insert",
+              "update",
+              "create",
+              "drop",
+              "createIndexes",
+              "listIndexes"));
+
+  @Nullable private static final Method IS_TRUNCATED_METHOD;
 
   static {
     IS_TRUNCATED_METHOD =
@@ -61,6 +84,25 @@ public String getDbNamespace(CommandStartedEvent event) {
     return event.getDatabaseName();
   }
 
+  @Override
+  @Nullable
+  public String getDbCollectionName(CommandStartedEvent event) {
+    if (event.getCommandName().equals("getMore")) {
+      BsonValue collectionValue = event.getCommand().get("collection");
+      if (collectionValue != null) {
+        if (collectionValue.isString()) {
+          return collectionValue.asString().getValue();
+        }
+      }
+    } else if (COMMANDS_WITH_COLLECTION_NAME_AS_VALUE.contains(event.getCommandName())) {
+      BsonValue commandValue = event.getCommand().get(event.getCommandName());
+      if (commandValue != null && commandValue.isString()) {
+        return commandValue.asString().getValue();
+      }
+    }
+    return null;
+  }
+
   @Deprecated // to be removed in 3.0
   @Override
   @Nullable

instrumentation/mongo/mongo-3.1/library/src/main/java/io/opentelemetry/instrumentation/mongo/v3_1/internal/MongoDbAttributesGetter.java

@@ -9,6 +9,7 @@
 
 import com.mongodb.event.CommandStartedEvent;
 import io.opentelemetry.api.OpenTelemetry;
+import io.opentelemetry.api.common.AttributeKey;
 import io.opentelemetry.instrumentation.api.incubator.semconv.db.DbClientAttributesExtractor;
 import io.opentelemetry.instrumentation.api.incubator.semconv.db.DbClientMetrics;
 import io.opentelemetry.instrumentation.api.instrumenter.Instrumenter;
@@ -22,6 +23,10 @@
  */
 public final class MongoInstrumenterFactory {
 
+  // copied from DbIncubatingAttributes
+  private static final AttributeKey<String> DB_MONGODB_COLLECTION =
+      AttributeKey.stringKey("db.mongodb.collection");
+
   static final int DEFAULT_MAX_NORMALIZED_QUERY_LENGTH = 32 * 1024;
 
   public static Instrumenter<CommandStartedEvent, Void> createInstrumenter(
@@ -33,23 +38,25 @@ public static Instrumenter<CommandStartedEvent, Void> createInstrumenter(
         DEFAULT_MAX_NORMALIZED_QUERY_LENGTH);
   }
 
+  @SuppressWarnings("deprecation") // to support old database semantic conventions
   public static Instrumenter<CommandStartedEvent, Void> createInstrumenter(
       OpenTelemetry openTelemetry,
       String instrumentationName,
       boolean querySanitizationEnabled,
       int maxNormalizedQueryLength) {
 
-    MongoAttributesExtractor attributesExtractor = new MongoAttributesExtractor();
     MongoDbAttributesGetter dbAttributesGetter =
         new MongoDbAttributesGetter(querySanitizationEnabled, maxNormalizedQueryLength);
     SpanNameExtractor<CommandStartedEvent> spanNameExtractor =
-        new MongoSpanNameExtractor(dbAttributesGetter, attributesExtractor);
+        new MongoSpanNameExtractor(dbAttributesGetter);
 
     InstrumenterBuilder<CommandStartedEvent, Void> builder =
         Instrumenter.<CommandStartedEvent, Void>builder(
                 openTelemetry, instrumentationName, spanNameExtractor)
-            .addAttributesExtractor(DbClientAttributesExtractor.create(dbAttributesGetter))
-            .addAttributesExtractor(attributesExtractor)
+            .addAttributesExtractor(
+                DbClientAttributesExtractor.builder(dbAttributesGetter)
+                    .setOldSemconvCollectionAttribute(DB_MONGODB_COLLECTION)
+                    .build())
             .addOperationMetrics(DbClientMetrics.get());
     setDbClientExceptionEventExtractor(builder);
     return builder.buildInstrumenter(SpanKindExtractor.alwaysClient());