feat(telemetry): Adding support for reporting remote config id (#7012)

Author: stanistan

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

@@ -125,6 +125,8 @@ public final class TraceInstrumentationConfig {
   public static final String SPRING_DATA_REPOSITORY_INTERFACE_RESOURCE_NAME =
       "spring-data.repository.interface.resource-name";
 
+  public static final String INSTRUMENTATION_CONFIG_ID = "instrumentation_config_id";
+
   public static final String RESOLVER_CACHE_CONFIG = "resolver.cache.config";
   public static final String RESOLVER_CACHE_DIR = "resolver.cache.dir";
   public static final String RESOLVER_SIMPLE_METHOD_GRAPH = "resolver.simple.method.graph";

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

@@ -32,6 +32,7 @@
 import static datadog.trace.api.config.TraceInstrumentationConfig.AXIS_TRANSPORT_CLASS_NAME;
 import static datadog.trace.api.config.TraceInstrumentationConfig.EXPERIMENTAL_DEFER_INTEGRATIONS_UNTIL;
 import static datadog.trace.api.config.TraceInstrumentationConfig.HTTP_URL_CONNECTION_CLASS_NAME;
+import static datadog.trace.api.config.TraceInstrumentationConfig.INSTRUMENTATION_CONFIG_ID;
 import static datadog.trace.api.config.TraceInstrumentationConfig.INTEGRATIONS_ENABLED;
 import static datadog.trace.api.config.TraceInstrumentationConfig.JAX_RS_ADDITIONAL_ANNOTATIONS;
 import static datadog.trace.api.config.TraceInstrumentationConfig.JDBC_CONNECTION_CLASS_NAME;
@@ -117,6 +118,8 @@ public class InstrumenterConfig {
 
   private final boolean directAllocationProfilingEnabled;
 
+  private final String instrumentationConfigId;
+
   private final List<String> excludedClasses;
   private final String excludedClassesFile;
   private final Set<String> excludedClassLoaders;
@@ -236,6 +239,8 @@ private InstrumenterConfig() {
         configProvider.getBoolean(
             SERIALVERSIONUID_FIELD_INJECTION, DEFAULT_SERIALVERSIONUID_FIELD_INJECTION);
 
+    instrumentationConfigId = configProvider.getString(INSTRUMENTATION_CONFIG_ID, "");
+
     traceAnnotations = configProvider.getString(TRACE_ANNOTATIONS, DEFAULT_TRACE_ANNOTATIONS);
     traceAnnotationAsync =
         configProvider.getBoolean(TRACE_ANNOTATION_ASYNC, DEFAULT_TRACE_ANNOTATION_ASYNC);
@@ -394,6 +399,10 @@ public String getResolverCacheDir() {
     return resolverCacheDir;
   }
 
+  public String getInstrumentationConfigId() {
+    return instrumentationConfigId;
+  }
+
   public boolean isResolverNamesAreUnique() {
     return resolverNamesAreUnique;
   }

telemetry/src/test/groovy/datadog/telemetry/TelemetryServiceSpecification.groovy

@@ -412,6 +412,25 @@ class TelemetryServiceSpecification extends DDSpecification {
     ]
   }
 
+  def 'app can propagate configuration id'() {
+    setup:
+    String instrKey = 'instrumentation_config_id'
+    TestTelemetryRouter testHttpClient = new TestTelemetryRouter()
+    TelemetryService telemetryService = new TelemetryService(testHttpClient, 10000, false)
+    telemetryService.addConfiguration(['${instrKey}': ConfigSetting.of(instrKey, id, ConfigOrigin.ENV)])
+
+    when: 'first iteration'
+    testHttpClient.expectRequest(TelemetryClient.Result.SUCCESS)
+    telemetryService.sendAppStartedEvent()
+
+    then: 'app-started'
+    testHttpClient.assertRequestBody(RequestType.APP_STARTED).assertPayload().instrumentationConfigId(id)
+    testHttpClient.assertNoMoreRequests()
+
+    where:
+    id << ["foo", null, ""]
+  }
+
   def 'app started must have install signature'() {
     setup:
     injectEnvConfig("INSTRUMENTATION_INSTALL_ID", installId)

telemetry/src/test/groovy/datadog/telemetry/TestTelemetryRouter.groovy

@@ -242,6 +242,22 @@ class TestTelemetryRouter extends TelemetryRouter {
       return this
     }
 
+    PayloadAssertions instrumentationConfigId(String id) {
+      boolean checked = false
+      this.payload['configuration'].each { v ->
+        if (v['name'] == 'instrumentation_config_id') {
+          assert v['value'] == id
+          checked = true
+        }
+      }
+
+      if (!checked) {
+        assert id == null
+      }
+
+      return this
+    }
+
     PayloadAssertions products(boolean appsecEnabled = true, boolean profilerEnabled = false, boolean dynamicInstrumentationEnabled = false) {
       def expected = [
         appsec: [enabled: appsecEnabled],