Add option to not include couchbase internal spans

Author: brentm5

dd-java-agent/instrumentation/couchbase/couchbase-3.1/src/main/java/datadog/trace/instrumentation/couchbase_31/client/DatadogRequestTracer.java

@@ -2,6 +2,7 @@
 
 import static datadog.trace.instrumentation.couchbase_31.client.CouchbaseClientDecorator.COUCHBASE_CLIENT;
 
+import datadog.trace.api.Config;
 import com.couchbase.client.core.Core;
 import com.couchbase.client.core.cnc.RequestSpan;
 import com.couchbase.client.core.cnc.RequestTracer;
@@ -33,11 +34,15 @@ public RequestSpan requestSpan(String requestName, RequestSpan requestParent) {
     boolean measured = true;
     Object seedNodes = null;
 
+    final Config config = Config.get();
     AgentSpan parent = DatadogRequestSpan.unwrap(requestParent);
     if (null == parent) {
       parent = tracer.activeSpan();
     }
     if (null != parent && COUCHBASE_CLIENT.equals(parent.getTag(Tags.COMPONENT))) {
+      if (!config.isCouchbaseInternalEnabled()) {
+        return requestParent;
+      }
       spanName = COUCHBASE_INTERNAL;
       measured = false;
       seedNodes = parent.getTag(InstrumentationTags.COUCHBASE_SEED_NODES);

dd-java-agent/instrumentation/couchbase/couchbase-3.2/src/main/java/datadog/trace/instrumentation/couchbase_32/client/DatadogRequestTracer.java

@@ -3,6 +3,7 @@
 import static datadog.trace.instrumentation.couchbase_32.client.CouchbaseClientDecorator.COUCHBASE_CLIENT;
 import static datadog.trace.instrumentation.couchbase_32.client.CouchbaseClientDecorator.OPERATION_NAME;
 
+import datadog.trace.api.Config;
 import com.couchbase.client.core.Core;
 import com.couchbase.client.core.cnc.RequestSpan;
 import com.couchbase.client.core.cnc.RequestTracer;
@@ -35,11 +36,15 @@ public RequestSpan requestSpan(String requestName, RequestSpan requestParent) {
     boolean measured = true;
     Object seedNodes = null;
 
+    final Config config = Config.get();
     AgentSpan parent = DatadogRequestSpan.unwrap(requestParent);
     if (null == parent) {
       parent = tracer.activeSpan();
     }
     if (null != parent && COUCHBASE_CLIENT.equals(parent.getTag(Tags.COMPONENT))) {
+      if (!config.isCouchbaseInternalEnabled()) {
+        return requestParent;
+      }
       spanName = COUCHBASE_INTERNAL;
       measured = false;
       seedNodes = parent.getTag(InstrumentationTags.COUCHBASE_SEED_NODES);

dd-trace-api/src/main/java/datadog/trace/api/ConfigDefaults.java

@@ -214,6 +214,7 @@ public final class ConfigDefaults {
 
   static final float DEFAULT_TRACE_FLUSH_INTERVAL = 1;
 
+  static final boolean DEFAULT_COUCHBASE_INTERNAL_ENABLED = true;
   static final boolean DEFAULT_ELASTICSEARCH_BODY_ENABLED = false;
   static final boolean DEFAULT_ELASTICSEARCH_PARAMS_ENABLED = true;
   static final boolean DEFAULT_ELASTICSEARCH_BODY_AND_PARAMS_ENABLED = false;

dd-trace-api/src/main/java/datadog/trace/api/config/TraceInstrumentationConfig.java

@@ -125,6 +125,8 @@ public final class TraceInstrumentationConfig {
   public static final String RESOLVER_RESET_INTERVAL = "resolver.reset.interval";
   public static final String RESOLVER_NAMES_ARE_UNIQUE = "resolver.names.are.unique";
 
+  public static final String COUCHBASE_INTERNAL_ENABLED = "trace.couchbase.internal.enabled";
+
   public static final String ELASTICSEARCH_BODY_ENABLED = "trace.elasticsearch.body.enabled";
   public static final String ELASTICSEARCH_PARAMS_ENABLED = "trace.elasticsearch.params.enabled";
   public static final String ELASTICSEARCH_BODY_AND_PARAMS_ENABLED =

internal-api/src/main/java/datadog/trace/api/Config.java

@@ -55,6 +55,7 @@
 import static datadog.trace.api.ConfigDefaults.DEFAULT_DEBUGGER_UPLOAD_TIMEOUT;
 import static datadog.trace.api.ConfigDefaults.DEFAULT_DEBUGGER_VERIFY_BYTECODE;
 import static datadog.trace.api.ConfigDefaults.DEFAULT_DOGSTATSD_START_DELAY;
+import static datadog.trace.api.ConfigDefaults.DEFAULT_COUCHBASE_INTERNAL_ENABLED;
 import static datadog.trace.api.ConfigDefaults.DEFAULT_ELASTICSEARCH_BODY_AND_PARAMS_ENABLED;
 import static datadog.trace.api.ConfigDefaults.DEFAULT_ELASTICSEARCH_BODY_ENABLED;
 import static datadog.trace.api.ConfigDefaults.DEFAULT_ELASTICSEARCH_PARAMS_ENABLED;
@@ -332,6 +333,7 @@
 import static datadog.trace.api.config.TraceInstrumentationConfig.DB_CLIENT_HOST_SPLIT_BY_INSTANCE;
 import static datadog.trace.api.config.TraceInstrumentationConfig.DB_CLIENT_HOST_SPLIT_BY_INSTANCE_TYPE_SUFFIX;
 import static datadog.trace.api.config.TraceInstrumentationConfig.DB_DBM_PROPAGATION_MODE_MODE;
+import static datadog.trace.api.config.TraceInstrumentationConfig.COUCHBASE_INTERNAL_ENABLED;
 import static datadog.trace.api.config.TraceInstrumentationConfig.ELASTICSEARCH_BODY_AND_PARAMS_ENABLED;
 import static datadog.trace.api.config.TraceInstrumentationConfig.ELASTICSEARCH_BODY_ENABLED;
 import static datadog.trace.api.config.TraceInstrumentationConfig.ELASTICSEARCH_PARAMS_ENABLED;
@@ -894,6 +896,7 @@ static class HostNameHolder {
   private final boolean longRunningTraceEnabled;
   private final long longRunningTraceInitialFlushInterval;
   private final long longRunningTraceFlushInterval;
+  private final boolean couchbaseInternalEnabled;
   private final boolean elasticsearchBodyEnabled;
   private final boolean elasticsearchParamsEnabled;
   private final boolean elasticsearchBodyAndParamsEnabled;
@@ -981,6 +984,8 @@ private Config(final ConfigProvider configProvider, final InstrumenterConfig ins
     } else {
       secureRandom = configProvider.getBoolean(SECURE_RANDOM, DEFAULT_SECURE_RANDOM);
     }
+    couchbaseInternalEnabled =
+            configProvider.getBoolean(COUCHBASE_INTERNAL_ENABLED, DEFAULT_COUCHBASE_INTERNAL_ENABLED);
     elasticsearchBodyEnabled =
         configProvider.getBoolean(ELASTICSEARCH_BODY_ENABLED, DEFAULT_ELASTICSEARCH_BODY_ENABLED);
     elasticsearchParamsEnabled =
@@ -3287,6 +3292,10 @@ public BitSet getGrpcClientErrorStatuses() {
     return grpcClientErrorStatuses;
   }
 
+  public boolean isCouchbaseInternalEnabled() {
+    return couchbaseInternalEnabled;
+  }
+
   public boolean isElasticsearchBodyEnabled() {
     return elasticsearchBodyEnabled;
   }
@@ -4361,6 +4370,8 @@ public String toString() {
         + longRunningTraceInitialFlushInterval
         + ", longRunningTraceFlushInterval="
         + longRunningTraceFlushInterval
+        + ", couchbaseInternalEnabled="
+        + couchbaseInternalEnabled
         + ", elasticsearchBodyEnabled="
         + elasticsearchBodyEnabled
         + ", elasticsearchParamsEnabled="