Add full APM/DBM mode for Oracle (#8090)

* Full APM/DBM mode for Oracle

* enabled injection in tests

* tests

* oracle container

* fixing oracle image

* fixed containers

* fixed first tests

* more oracle tests

* finished tests

* fixed tests

* Update dd-java-agent/instrumentation/jdbc/src/main/java/datadog/trace/instrumentation/jdbc/JDBCDecorator.java

Co-authored-by: Raphaël Vandon <[email protected]>

* DD_INSTRUMENTATION_PREFIX

* compute isOracle

---------

Co-authored-by: Raphaël Vandon <[email protected]>

Author: nenadnoveljic

dd-java-agent/agent-bootstrap/src/main/java/datadog/trace/bootstrap/instrumentation/jdbc/DBInfo.java

@@ -91,9 +91,6 @@ public static class Builder {
 
     public Builder type(String type) {
       this.type = type;
-      // Those DBs use the full text of the query including the comments as a cache key,
-      // so we disable full propagation support for them to avoid destroying the cache.
-      if (type.equals("oracle")) this.fullPropagationSupport = false;
       return this;
     }
 

dd-java-agent/instrumentation/jdbc/build.gradle

@@ -37,10 +37,12 @@ dependencies {
   testImplementation group: 'mysql', name: 'mysql-connector-java', version: '8.0.23'
   testImplementation group: 'org.postgresql', name: 'postgresql', version: '[9.4,42.2.18]'
   testImplementation group: 'com.microsoft.sqlserver', name: 'mssql-jdbc', version: '10.2.0.jre8'
+  testImplementation group: 'com.oracle.database.jdbc', name: 'ojdbc8', version: '19.19.0.0'
 
   testImplementation group: 'org.testcontainers', name:'mysql', version: libs.versions.testcontainers.get()
   testImplementation group: 'org.testcontainers', name:'postgresql', version: libs.versions.testcontainers.get()
   testImplementation group: 'org.testcontainers', name:'mssqlserver', version: libs.versions.testcontainers.get()
+  testImplementation group: 'org.testcontainers', name:'oracle-xe', version: '1.20.4'
 
   testRuntimeOnly project(':dd-java-agent:instrumentation:iast-instrumenter')
 

dd-java-agent/instrumentation/jdbc/src/main/java/datadog/trace/instrumentation/jdbc/AbstractPreparedStatementInstrumentation.java

@@ -91,6 +91,9 @@ public static AgentScope onEnter(@Advice.This final Statement statement) {
           } else if (DECORATE.isPostgres(dbInfo) && DBM_TRACE_PREPARED_STATEMENTS) {
             span = startSpan(DATABASE_QUERY);
             DECORATE.setApplicationName(span, connection);
+          } else if (DECORATE.isOracle(dbInfo)) {
+            span = startSpan(DATABASE_QUERY);
+            DECORATE.setAction(span, connection);
           } else {
             span = startSpan(DATABASE_QUERY);
           }

dd-java-agent/instrumentation/jdbc/src/main/java/datadog/trace/instrumentation/jdbc/JDBCDecorator.java

@@ -49,6 +49,8 @@ public class JDBCDecorator extends DatabaseClientDecorator<DBInfo> {
   public static final String DBM_PROPAGATION_MODE_STATIC = "service";
   public static final String DBM_PROPAGATION_MODE_FULL = "full";
 
+  public static final String DD_INSTRUMENTATION_PREFIX = "_DD_";
+
   public static final String DBM_PROPAGATION_MODE = Config.get().getDBMPropagationMode();
   public static final boolean INJECT_COMMENT =
       DBM_PROPAGATION_MODE.equals(DBM_PROPAGATION_MODE_FULL)
@@ -252,6 +254,10 @@ public String traceParent(AgentSpan span, int samplingPriority) {
     return sb.toString();
   }
 
+  public boolean isOracle(final DBInfo dbInfo) {
+    return "oracle".equals(dbInfo.getType());
+  }
+
   public boolean isPostgres(final DBInfo dbInfo) {
     return dbInfo.getType().startsWith("postgres");
   }
@@ -260,6 +266,38 @@ public boolean isSqlServer(final DBInfo dbInfo) {
     return "sqlserver".equals(dbInfo.getType());
   }
 
+  /**
+   * Executes `connection.setClientInfo("OCSID.ACTION", traceContext)` statement on the Oracle DB to
+   * set the trace parent in `v$session.action`. This is used because it isn't possible to propagate
+   * trace parent with the comment.
+   *
+   * @param span The span of the instrumented statement
+   * @param connection The same connection as the one that will be used for the actual statement
+   */
+  public void setAction(AgentSpan span, Connection connection) {
+    try {
+
+      Integer priority = span.forceSamplingDecision();
+      if (priority == null) {
+        return;
+      }
+      final String traceContext = DD_INSTRUMENTATION_PREFIX + DECORATE.traceParent(span, priority);
+
+      connection.setClientInfo("OCSID.ACTION", traceContext);
+
+    } catch (Throwable e) {
+      log.debug(
+          "Failed to set extra DBM data in application_name for trace {}. "
+              + "To disable this behavior, set trace_prepared_statements to 'false'. "
+              + "See https://docs.datadoghq.com/database_monitoring/connect_dbm_and_apm/ for more info. {}",
+          span.getTraceId().toHexString(),
+          e);
+      DECORATE.onError(span, e);
+    } finally {
+      span.setTag("_dd.dbm_trace_injected", true);
+    }
+  }
+
   /**
    * Executes a `SET CONTEXT_INFO` statement on the DB with the active trace ID and the given span
    * ID. This context will be "attached" to future queries on the same connection. See <a

dd-java-agent/instrumentation/jdbc/src/main/java/datadog/trace/instrumentation/jdbc/StatementInstrumentation.java

@@ -87,12 +87,20 @@ public static AgentScope onEnter(
         boolean injectTraceContext = DECORATE.shouldInjectTraceContext(dbInfo);
         final AgentSpan span;
         final boolean isSqlServer = DECORATE.isSqlServer(dbInfo);
+        final boolean isOracle = DECORATE.isOracle(dbInfo);
 
-        if (isSqlServer && INJECT_COMMENT && injectTraceContext) {
-          // The span ID is pre-determined so that we can reference it when setting the context
-          final long spanID = DECORATE.setContextInfo(connection, dbInfo);
-          // we then force that pre-determined span ID for the span covering the actual query
-          span = AgentTracer.get().buildSpan(DATABASE_QUERY).withSpanId(spanID).start();
+        if (INJECT_COMMENT && injectTraceContext) {
+          if (isSqlServer) {
+            // The span ID is pre-determined so that we can reference it when setting the context
+            final long spanID = DECORATE.setContextInfo(connection, dbInfo);
+            // we then force that pre-determined span ID for the span covering the actual query
+            span = AgentTracer.get().buildSpan(DATABASE_QUERY).withSpanId(spanID).start();
+          } else if (isOracle) {
+            span = startSpan(DATABASE_QUERY);
+            DECORATE.setAction(span, connection);
+          } else {
+            span = startSpan(DATABASE_QUERY);
+          }
         } else {
           span = startSpan(DATABASE_QUERY);
         }

dd-java-agent/instrumentation/jdbc/src/test/groovy/JDBCDecoratorTest.groovy

@@ -20,7 +20,7 @@ abstract class JDBCDecoratorTest extends AgentTestRunner {
 
     where:
     dbType       | expectedByType
-    "oracle"     | false
+    "oracle"     | true
     "sqlserver"  | true
     "mysql"      | true
     "postgresql" | true