Split db.namespace into separate attributes: service name, instance ID, and PDB && update the driver version to 23.26.0.0.0

Author: MouhsinElmajdouby

ojdbc-provider-observability/README.md

@@ -38,11 +38,13 @@ When `OTEL_SEMCONV_STABILITY_OPT_IN=database` or `database/dup`:
 
 * **Required/Recommended Attributes**
     * `db.system.name` - Always set to `"oracle.db"`
-    * `db.namespace` - Format: `{instance_name}|{database_name}|{service_name}`
+    * `db.namespace` - Service name (or TNS alias if used)
     * `db.operation.name` - Database operation being executed
     * `db.query.summary` - Low cardinality query summary (SQL type)
     * `server.address` - Database server hostname
     * `server.port` - Database server port (if non-default, i.e., not 1521)
+    * `oracle.db.instance.id` - Oracle database instance identifier
+    * `oracle.db.pdb` - Oracle PDB name
     * `oracle.db.query.sql.id` - Oracle SQL_ID
     * `oracle.db.session.id` - Oracle session ID
     * `oracle.db.server.pid` - Oracle server process ID

ojdbc-provider-observability/pom.xml

@@ -24,6 +24,7 @@
     <dependency>
       <groupId>com.oracle.database.jdbc</groupId>
       <artifactId>ojdbc11</artifactId>
+      <version>23.26.0.0.0</version>
     </dependency>
     <dependency>
       <groupId>io.opentelemetry</groupId>

ojdbc-provider-observability/src/main/java/oracle/jdbc/provider/observability/tracers/otel/OTelTracer.java

@@ -329,9 +329,16 @@ private Span initAndGetSpan(TraceContext traceContext, String spanName) {
     if (emitStable) {
       spanBuilder.setAttribute(DB_SYSTEM_ATTRIBUTE, DB_SYSTEM_VALUE_ORACLE);
 
-      String namespace = buildDbNamespace(traceContext);
-      if (namespace != null && !namespace.isEmpty()) {
-        spanBuilder.setAttribute(DB_NAMESPACE_ATTRIBUTE, namespace);
+      if (traceContext.getServiceName() != null && !traceContext.getServiceName().isEmpty()) {
+        spanBuilder.setAttribute(DB_NAMESPACE_ATTRIBUTE, traceContext.getServiceName());
+      }
+
+      if (traceContext.getInstanceName() != null && !traceContext.getInstanceName().isEmpty()) {
+        spanBuilder.setAttribute(ORACLE_INSTANCE_ID_ATTRIBUTE, traceContext.getInstanceName());
+      }
+
+      if (traceContext.getDatabaseName() != null && !traceContext.getDatabaseName().isEmpty()) {
+        spanBuilder.setAttribute(ORACLE_PDB_ATTRIBUTE, traceContext.getDatabaseName());
       }
 
       if (traceContext.getServerAddress() != null && !traceContext.getServerAddress().isEmpty()) {
@@ -458,32 +465,6 @@ private String initAndGetTraceState(Span span) {
     return String.format(TRACE_STATE_FORMAT, stringBuilder);
   }
 
-  /**
-   * Builds the db.namespace attribute according to Oracle Database
-   * semantic conventions.
-   * Format: {instance_name}|{database_name}|{service_name}
-   * Missing components and their separators are omitted.
-   */
-  private String buildDbNamespace(TraceContext traceContext) {
-    StringBuilder ns = new StringBuilder();
-
-    if (traceContext.getInstanceName() != null && !traceContext.getInstanceName().isEmpty()) {
-      ns.append(traceContext.getInstanceName());
-    }
-
-    if (traceContext.getDatabaseName() != null && !traceContext.getDatabaseName().isEmpty()) {
-      if (ns.length() > 0) ns.append('|');
-      ns.append(traceContext.getDatabaseName());
-    }
-
-    if (traceContext.getServiceName() != null && !traceContext.getServiceName().isEmpty()) {
-      if (ns.length() > 0) ns.append('|');
-      ns.append(traceContext.getServiceName());
-    }
-
-    return ns.length() > 0 ? ns.toString() : null;
-  }
-
   /**
    * Returns true if stable database semantic conventions should be emitted.
    * This checks if OTEL_SEMCONV_STABILITY_OPT_IN contains "database" or "database/dup"

ojdbc-provider-observability/src/main/java/oracle/jdbc/provider/observability/tracers/otel/OtelSemanticConventions.java

@@ -148,6 +148,16 @@ private OtelSemanticConventions() {
    */
   static final String ORACLE_SERVER_PID_ATTRIBUTE = "oracle.db.server.pid";
 
+  /**
+   * Attribute key for Oracle database instance identifier.
+   */
+  static final String ORACLE_INSTANCE_ID_ATTRIBUTE = "oracle.db.instance.id";
+
+  /**
+   * Attribute key for Oracle PDB name.
+   */
+  static final String ORACLE_PDB_ATTRIBUTE = "oracle.db.pdb";
+
   /**
    * Attribute key for Oracle shard name.
    */

ojdbc-provider-observability/src/test/java/oracle/jdbc/provider/observability/ObservabilityTraceEventListenerTest.java

@@ -50,6 +50,7 @@
 import java.sql.DriverManager;
 import java.sql.ResultSet;
 import java.sql.Statement;
+import java.time.Instant;
 
 import org.junit.jupiter.params.ParameterizedTest;
 import org.junit.jupiter.params.provider.ValueSource;
@@ -204,15 +205,15 @@ public void OTELTraceTest(boolean sensitiveDataEnabled) throws Exception {
     Mockito.verify(spanBuilder, Mockito.times(1)).setAttribute("Database Operation", DatabaseFunction.EXECUTE_QUERY.getDescription());
     Mockito.verify(spanBuilder, Mockito.times(1)).setAttribute("Database Operation", DatabaseFunction.LOGOFF.getDescription());
     if (sensitiveDataEnabled) {
-      Mockito.verify(spanBuilder, Mockito.times(4)).setAttribute("Database User", userName);
+      Mockito.verify(spanBuilder, Mockito.times(4)).setAttribute("Database User", userName.toUpperCase());
       Mockito.verify(spanBuilder, Mockito.times(1)).setAttribute("Original SQL Text", "SELECT 'OK' FROM DUAL");
       Mockito.verify(spanBuilder, Mockito.times(1)).setAttribute("Actual SQL Text", "SELECT 'OK' FROM DUAL");
     } else {
-      Mockito.verify(spanBuilder, Mockito.times(0)).setAttribute("Database User", userName);
+      Mockito.verify(spanBuilder, Mockito.times(0)).setAttribute("Database User", userName.toUpperCase());
       Mockito.verify(spanBuilder, Mockito.times(0)).setAttribute("Original SQL Text", "SELECT 'OK' FROM DUAL");
       Mockito.verify(spanBuilder, Mockito.times(0)).setAttribute("Actual SQL Text", "SELECT 'OK' FROM DUAL");
     }
-    Mockito.verify(span, atLeast(4)).end();
+    Mockito.verify(span, atLeast(4)).end(Mockito.any(Instant.class));
 
   }