Db client error type for JDBC (#13331)

Co-authored-by: Jay DeLuca <[email protected]>

Author: zeitlinger

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

@@ -23,23 +23,23 @@
  */
 public final class DbClientAttributesExtractor<REQUEST, RESPONSE>
     extends DbClientCommonAttributesExtractor<
-        REQUEST, RESPONSE, DbClientAttributesGetter<REQUEST>> {
+        REQUEST, RESPONSE, DbClientAttributesGetter<REQUEST, RESPONSE>> {
 
   // copied from DbIncubatingAttributes
   private static final AttributeKey<String> DB_STATEMENT = AttributeKey.stringKey("db.statement");
   private static final AttributeKey<String> DB_QUERY_TEXT = AttributeKey.stringKey("db.query.text");
   static final AttributeKey<String> DB_OPERATION = AttributeKey.stringKey("db.operation");
   static final AttributeKey<String> DB_OPERATION_NAME = AttributeKey.stringKey("db.operation.name");
-  static final AttributeKey<Long> DB_RESPONSE_STATUS_CODE =
-      AttributeKey.longKey("db.response.status_code");
+  static final AttributeKey<String> DB_RESPONSE_STATUS_CODE =
+      AttributeKey.stringKey("db.response.status_code");
 
   /** Creates the database client attributes extractor with default configuration. */
   public static <REQUEST, RESPONSE> AttributesExtractor<REQUEST, RESPONSE> create(
-      DbClientAttributesGetter<REQUEST> getter) {
+      DbClientAttributesGetter<REQUEST, RESPONSE> getter) {
     return new DbClientAttributesExtractor<>(getter);
   }
 
-  DbClientAttributesExtractor(DbClientAttributesGetter<REQUEST> getter) {
+  DbClientAttributesExtractor(DbClientAttributesGetter<REQUEST, RESPONSE> getter) {
     super(getter);
   }
 

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

@@ -18,7 +18,8 @@
  * from the attribute methods, but implement as many as possible for best compliance with the
  * OpenTelemetry specification.
  */
-public interface DbClientAttributesGetter<REQUEST> extends DbClientCommonAttributesGetter<REQUEST> {
+public interface DbClientAttributesGetter<REQUEST, RESPONSE>
+    extends DbClientCommonAttributesGetter<REQUEST, RESPONSE> {
 
   /**
    * @deprecated Use {@link #getDbQueryText(REQUEST)} instead.

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

@@ -6,6 +6,7 @@
 package io.opentelemetry.instrumentation.api.incubator.semconv.db;
 
 import static io.opentelemetry.instrumentation.api.internal.AttributesExtractorUtil.internalSet;
+import static io.opentelemetry.semconv.ErrorAttributes.ERROR_TYPE;
 
 import io.opentelemetry.api.common.AttributeKey;
 import io.opentelemetry.api.common.AttributesBuilder;
@@ -17,7 +18,7 @@
 import javax.annotation.Nullable;
 
 abstract class DbClientCommonAttributesExtractor<
-        REQUEST, RESPONSE, GETTER extends DbClientCommonAttributesGetter<REQUEST>>
+        REQUEST, RESPONSE, GETTER extends DbClientCommonAttributesGetter<REQUEST, RESPONSE>>
     implements AttributesExtractor<REQUEST, RESPONSE>, SpanKeyProvider {
 
   // copied from DbIncubatingAttributes
@@ -29,6 +30,8 @@ abstract class DbClientCommonAttributesExtractor<
   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_RESPONSE_STATUS_CODE =
+      AttributeKey.stringKey("db.response.status_code");
 
   final GETTER getter;
 
@@ -60,7 +63,16 @@ public final void onEnd(
       Context context,
       REQUEST request,
       @Nullable RESPONSE response,
-      @Nullable Throwable error) {}
+      @Nullable Throwable error) {
+    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

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

@@ -8,7 +8,7 @@
 import javax.annotation.Nullable;
 
 /** An interface for getting attributes common to database clients. */
-public interface DbClientCommonAttributesGetter<REQUEST> {
+public interface DbClientCommonAttributesGetter<REQUEST, RESPONSE> {
 
   @Deprecated
   @Nullable
@@ -44,4 +44,9 @@ default String getDbNamespace(REQUEST request) {
   @Deprecated
   @Nullable
   String getConnectionString(REQUEST request);
+
+  @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/DbClientMetricsAdvice.java

@@ -32,11 +32,7 @@ static void applyClientDurationAdvice(DoubleHistogramBuilder builder) {
                 SqlClientAttributesExtractor.DB_COLLECTION_NAME,
                 DbClientCommonAttributesExtractor.DB_NAMESPACE,
                 DbClientAttributesExtractor.DB_OPERATION_NAME,
-                // will be implemented in
-                // https://github.com/open-telemetry/opentelemetry-java-instrumentation/issues/12804
                 DbClientAttributesExtractor.DB_RESPONSE_STATUS_CODE,
-                // will be implemented in
-                // https://github.com/open-telemetry/opentelemetry-java-instrumentation/issues/12804
                 ErrorAttributes.ERROR_TYPE,
                 NetworkAttributes.NETWORK_PEER_ADDRESS,
                 NetworkAttributes.NETWORK_PEER_PORT,

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

@@ -20,7 +20,7 @@ public abstract class DbClientSpanNameExtractor<REQUEST> implements SpanNameExtr
    * @see DbClientAttributesGetter#getDbNamespace(Object) used to extract {@code <db.namespace>}.
    */
   public static <REQUEST> SpanNameExtractor<REQUEST> create(
-      DbClientAttributesGetter<REQUEST> getter) {
+      DbClientAttributesGetter<REQUEST, ?> getter) {
     return new GenericDbClientSpanNameExtractor<>(getter);
   }
 
@@ -34,7 +34,7 @@ public static <REQUEST> SpanNameExtractor<REQUEST> create(
    *     procedure name.
    */
   public static <REQUEST> SpanNameExtractor<REQUEST> create(
-      SqlClientAttributesGetter<REQUEST> getter) {
+      SqlClientAttributesGetter<REQUEST, ?> getter) {
     return new SqlClientSpanNameExtractor<>(getter);
   }
 
@@ -67,9 +67,9 @@ protected String computeSpanName(String dbName, String operation, String mainIde
   private static final class GenericDbClientSpanNameExtractor<REQUEST>
       extends DbClientSpanNameExtractor<REQUEST> {
 
-    private final DbClientAttributesGetter<REQUEST> getter;
+    private final DbClientAttributesGetter<REQUEST, ?> getter;
 
-    private GenericDbClientSpanNameExtractor(DbClientAttributesGetter<REQUEST> getter) {
+    private GenericDbClientSpanNameExtractor(DbClientAttributesGetter<REQUEST, ?> getter) {
       this.getter = getter;
     }
 
@@ -87,9 +87,9 @@ private static final class SqlClientSpanNameExtractor<REQUEST>
     // a dedicated sanitizer just for extracting the operation and identifier name
     private static final SqlStatementSanitizer sanitizer = SqlStatementSanitizer.create(true);
 
-    private final SqlClientAttributesGetter<REQUEST> getter;
+    private final SqlClientAttributesGetter<REQUEST, ?> getter;
 
-    private SqlClientSpanNameExtractor(SqlClientAttributesGetter<REQUEST> getter) {
+    private SqlClientSpanNameExtractor(SqlClientAttributesGetter<REQUEST, ?> getter) {
       this.getter = getter;
     }
 

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

@@ -26,7 +26,7 @@
  */
 public final class SqlClientAttributesExtractor<REQUEST, RESPONSE>
     extends DbClientCommonAttributesExtractor<
-        REQUEST, RESPONSE, SqlClientAttributesGetter<REQUEST>> {
+        REQUEST, RESPONSE, SqlClientAttributesGetter<REQUEST, RESPONSE>> {
 
   // copied from DbIncubatingAttributes
   private static final AttributeKey<String> DB_OPERATION = AttributeKey.stringKey("db.operation");
@@ -41,7 +41,7 @@ public final class SqlClientAttributesExtractor<REQUEST, RESPONSE>
 
   /** Creates the SQL client attributes extractor with default configuration. */
   public static <REQUEST, RESPONSE> AttributesExtractor<REQUEST, RESPONSE> create(
-      SqlClientAttributesGetter<REQUEST> getter) {
+      SqlClientAttributesGetter<REQUEST, RESPONSE> getter) {
     return SqlClientAttributesExtractor.<REQUEST, RESPONSE>builder(getter).build();
   }
 
@@ -50,7 +50,7 @@ public static <REQUEST, RESPONSE> AttributesExtractor<REQUEST, RESPONSE> create(
    * client attributes extractor.
    */
   public static <REQUEST, RESPONSE> SqlClientAttributesExtractorBuilder<REQUEST, RESPONSE> builder(
-      SqlClientAttributesGetter<REQUEST> getter) {
+      SqlClientAttributesGetter<REQUEST, RESPONSE> getter) {
     return new SqlClientAttributesExtractorBuilder<>(getter);
   }
 
@@ -62,7 +62,7 @@ public static <REQUEST, RESPONSE> SqlClientAttributesExtractorBuilder<REQUEST, R
   private final boolean statementSanitizationEnabled;
 
   SqlClientAttributesExtractor(
-      SqlClientAttributesGetter<REQUEST> getter,
+      SqlClientAttributesGetter<REQUEST, RESPONSE> getter,
       AttributeKey<String> oldSemconvTableAttribute,
       boolean statementSanitizationEnabled) {
     super(getter);

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

@@ -17,11 +17,11 @@ public final class SqlClientAttributesExtractorBuilder<REQUEST, RESPONSE> {
   // copied from DbIncubatingAttributes
   private static final AttributeKey<String> DB_SQL_TABLE = AttributeKey.stringKey("db.sql.table");
 
-  final SqlClientAttributesGetter<REQUEST> getter;
+  final SqlClientAttributesGetter<REQUEST, RESPONSE> getter;
   AttributeKey<String> oldSemconvTableAttribute = DB_SQL_TABLE;
   boolean statementSanitizationEnabled = true;
 
-  SqlClientAttributesExtractorBuilder(SqlClientAttributesGetter<REQUEST> getter) {
+  SqlClientAttributesExtractorBuilder(SqlClientAttributesGetter<REQUEST, RESPONSE> getter) {
     this.getter = getter;
   }
 

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

@@ -22,8 +22,8 @@
  * from the attribute methods, but implement as many as possible for best compliance with the
  * OpenTelemetry specification.
  */
-public interface SqlClientAttributesGetter<REQUEST>
-    extends DbClientCommonAttributesGetter<REQUEST> {
+public interface SqlClientAttributesGetter<REQUEST, RESPONSE>
+    extends DbClientCommonAttributesGetter<REQUEST, RESPONSE> {
 
   /**
    * Get the raw SQL statement. The value returned by this method is later sanitized by the {@link

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

@@ -21,7 +21,8 @@
 
 class DbClientAttributesExtractorTest {
 
-  static final class TestAttributesGetter implements DbClientAttributesGetter<Map<String, String>> {
+  static final class TestAttributesGetter
+      implements DbClientAttributesGetter<Map<String, String>, Void> {
     @Override
     public String getDbSystem(Map<String, String> map) {
       return map.get("db.system");