Consolidate network attribute extraction into DbClientAttributesGetter

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

@@ -6,15 +6,24 @@
 package io.opentelemetry.instrumentation.api.incubator.semconv.db;
 
 import static io.opentelemetry.instrumentation.api.internal.AttributesExtractorUtil.internalSet;
+import static io.opentelemetry.semconv.DbAttributes.DB_NAMESPACE;
 import static io.opentelemetry.semconv.DbAttributes.DB_OPERATION_NAME;
 import static io.opentelemetry.semconv.DbAttributes.DB_QUERY_SUMMARY;
 import static io.opentelemetry.semconv.DbAttributes.DB_QUERY_TEXT;
+import static io.opentelemetry.semconv.DbAttributes.DB_RESPONSE_STATUS_CODE;
+import static io.opentelemetry.semconv.DbAttributes.DB_SYSTEM_NAME;
+import static io.opentelemetry.semconv.ErrorAttributes.ERROR_TYPE;
 
 import io.opentelemetry.api.common.AttributeKey;
 import io.opentelemetry.api.common.AttributesBuilder;
 import io.opentelemetry.context.Context;
 import io.opentelemetry.instrumentation.api.instrumenter.AttributesExtractor;
 import io.opentelemetry.instrumentation.api.internal.SemconvStability;
+import io.opentelemetry.instrumentation.api.internal.SpanKey;
+import io.opentelemetry.instrumentation.api.internal.SpanKeyProvider;
+import io.opentelemetry.instrumentation.api.semconv.network.ServerAttributesExtractor;
+import io.opentelemetry.instrumentation.api.semconv.network.internal.InternalNetworkAttributesExtractor;
+import javax.annotation.Nullable;
 
 /**
  * Extractor of <a
@@ -25,12 +34,20 @@
  * attribute extraction from request/response objects.
  */
 public final class DbClientAttributesExtractor<REQUEST, RESPONSE>
-    extends DbClientCommonAttributesExtractor<
-        REQUEST, RESPONSE, DbClientAttributesGetter<REQUEST, RESPONSE>> {
+    implements AttributesExtractor<REQUEST, RESPONSE>, SpanKeyProvider {
 
   // copied from DbIncubatingAttributes
+  private static final AttributeKey<String> DB_NAME = AttributeKey.stringKey("db.name");
+  private static final AttributeKey<String> DB_SYSTEM = AttributeKey.stringKey("db.system");
+  private static final AttributeKey<String> DB_USER = AttributeKey.stringKey("db.user");
+  private static final AttributeKey<String> DB_CONNECTION_STRING =
+      AttributeKey.stringKey("db.connection_string");
   private static final AttributeKey<String> DB_STATEMENT = AttributeKey.stringKey("db.statement");
-  static final AttributeKey<String> DB_OPERATION = AttributeKey.stringKey("db.operation");
+  private static final AttributeKey<String> DB_OPERATION = AttributeKey.stringKey("db.operation");
+
+  private final DbClientAttributesGetter<REQUEST, RESPONSE> getter;
+  private final InternalNetworkAttributesExtractor<REQUEST, RESPONSE> internalNetworkExtractor;
+  private final ServerAttributesExtractor<REQUEST, RESPONSE> serverAttributesExtractor;
 
   /** Creates the database client attributes extractor with default configuration. */
   public static <REQUEST, RESPONSE> AttributesExtractor<REQUEST, RESPONSE> create(
@@ -39,21 +56,59 @@ public static <REQUEST, RESPONSE> AttributesExtractor<REQUEST, RESPONSE> create(
   }
 
   DbClientAttributesExtractor(DbClientAttributesGetter<REQUEST, RESPONSE> getter) {
-    super(getter);
+    this.getter = getter;
+    internalNetworkExtractor = new InternalNetworkAttributesExtractor<>(getter, true, false);
+    serverAttributesExtractor = ServerAttributesExtractor.create(getter);
   }
 
+  @SuppressWarnings("deprecation") // until old db semconv are dropped
   @Override
   public void onStart(AttributesBuilder attributes, Context parentContext, REQUEST request) {
-    super.onStart(attributes, parentContext, request);
-
     if (SemconvStability.emitStableDatabaseSemconv()) {
+      String dbSystem = getter.getDbSystem(request);
+      if (dbSystem != null) {
+        internalSet(attributes, DB_SYSTEM_NAME, SemconvStability.stableDbSystemName(dbSystem));
+      }
+      internalSet(attributes, DB_NAMESPACE, getter.getDbNamespace(request));
       internalSet(attributes, DB_QUERY_TEXT, getter.getDbQueryText(request));
       internalSet(attributes, DB_OPERATION_NAME, getter.getDbOperationName(request));
       internalSet(attributes, DB_QUERY_SUMMARY, getter.getDbQuerySummary(request));
     }
     if (SemconvStability.emitOldDatabaseSemconv()) {
+      internalSet(attributes, DB_SYSTEM, getter.getDbSystem(request));
+      internalSet(attributes, DB_USER, getter.getUser(request));
+      internalSet(attributes, DB_NAME, getter.getDbNamespace(request));
+      internalSet(attributes, DB_CONNECTION_STRING, getter.getConnectionString(request));
       internalSet(attributes, DB_STATEMENT, getter.getDbQueryText(request));
       internalSet(attributes, DB_OPERATION, getter.getDbOperationName(request));
     }
+    serverAttributesExtractor.onStart(attributes, parentContext, request);
+  }
+
+  @Override
+  public void onEnd(
+      AttributesBuilder attributes,
+      Context context,
+      REQUEST request,
+      @Nullable RESPONSE response,
+      @Nullable Throwable error) {
+    internalNetworkExtractor.onEnd(attributes, request, response);
+    if (SemconvStability.emitStableDatabaseSemconv()) {
+      if (error != null) {
+        internalSet(attributes, ERROR_TYPE, error.getClass().getName());
+      }
+      if (error != null || response != null) {
+        internalSet(attributes, DB_RESPONSE_STATUS_CODE, getter.getResponseStatus(response, error));
+      }
+    }
+  }
+
+  /**
+   * This method is internal and is hence not for public use. Its API is unstable and can change at
+   * any time.
+   */
+  @Override
+  public SpanKey internalGetSpanKey() {
+    return SpanKey.DB_CLIENT;
   }
 }

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

@@ -5,6 +5,8 @@
 
 package io.opentelemetry.instrumentation.api.incubator.semconv.db;
 
+import io.opentelemetry.instrumentation.api.semconv.network.NetworkAttributesGetter;
+import io.opentelemetry.instrumentation.api.semconv.network.ServerAttributesGetter;
 import javax.annotation.Nullable;
 
 /**
@@ -19,29 +21,62 @@
  * OpenTelemetry specification.
  */
 public interface DbClientAttributesGetter<REQUEST, RESPONSE>
-    extends DbClientCommonAttributesGetter<REQUEST, RESPONSE> {
+    extends NetworkAttributesGetter<REQUEST, RESPONSE>, ServerAttributesGetter<REQUEST> {
+
+  @Deprecated
+  @Nullable
+  default String getSystem(REQUEST request) {
+    return null;
+  }
+
+  // TODO: make this required to implement
+  @Nullable
+  default String getDbSystem(REQUEST request) {
+    return getSystem(request);
+  }
+
+  @Deprecated
+  @Nullable
+  default String getUser(REQUEST request) {
+    return null;
+  }
 
   /**
-   * @deprecated Use {@link #getDbQueryText(REQUEST)} instead.
+   * @deprecated Use {@link #getDbNamespace(Object)} instead.
    */
   @Deprecated
   @Nullable
-  default String getStatement(REQUEST request) {
+  default String getName(REQUEST request) {
     return null;
   }
 
   // TODO: make this required to implement
   @Nullable
-  default String getDbQueryText(REQUEST request) {
-    return getStatement(request);
+  default String getDbNamespace(REQUEST request) {
+    return getName(request);
   }
 
-  // TODO: make this required to implement
+  @Deprecated
   @Nullable
-  default String getDbQuerySummary(REQUEST request) {
+  default String getConnectionString(REQUEST request) {
     return null;
   }
 
+  /**
+   * @deprecated Use {@link #getDbQueryText(REQUEST)} instead.
+   */
+  @Deprecated
+  @Nullable
+  default String getStatement(REQUEST request) {
+    return null;
+  }
+
+  // TODO: make this required to implement
+  @Nullable
+  default String getDbQueryText(REQUEST request) {
+    return getStatement(request);
+  }
+
   /**
    * @deprecated Use {@link #getDbOperationName(REQUEST)} instead.
    */
@@ -56,4 +91,14 @@ default String getOperation(REQUEST request) {
   default String getDbOperationName(REQUEST request) {
     return getOperation(request);
   }
+
+  @Nullable
+  default String getDbQuerySummary(REQUEST request) {
+    return null;
+  }
+
+  @Nullable
+  default String getResponseStatus(@Nullable RESPONSE response, @Nullable Throwable error) {
+    return null;
+  }
 }

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

@@ -7,7 +7,12 @@
 
 import javax.annotation.Nullable;
 
-/** An interface for getting attributes common to database clients. */
+/**
+ * An interface for getting attributes common to database clients.
+ *
+ * @deprecated Use {@link DbClientAttributesGetter} instead.
+ */
+@Deprecated
 public interface DbClientCommonAttributesGetter<REQUEST, RESPONSE> {
 
   String getDbSystem(REQUEST request);