ApmTracingConfig id and ConfigurationProvider

iunanua · iunanua · commit 874bb37f8da2 · 2025-09-23T10:36:55.000+02:00
diff --git a/datadog-opentelemetry/tests/integration_tests/opentelemetry_api.rs b/datadog-opentelemetry/tests/integration_tests/opentelemetry_api.rs
@@ -191,6 +191,7 @@ async fn test_remote_config_sampling_rates() {
             r##"{
             "path": "datadog/2/APM_TRACING/1234/config",
             "msg": {
+                "id": "42",
                 "lib_config": {
                     "tracing_sampling_rules": [
                         {
diff --git a/dd-trace/src/configuration/configuration.rs b/dd-trace/src/configuration/configuration.rs
@@ -191,6 +191,24 @@ impl<T: ConfigurationValueProvider> ConfigurationValueProvider for ConfigItemRef
     }
 }
 
+/// A trait for providing configuration data for telemetry reporting.
+///
+/// This trait standardizes how configuration items expose their current state
+/// as `ddtelemetry::data::Configuration` payloads for telemetry collection.
+/// It enables the configuration system to report configuration values, their
+/// origins, and associated metadata to Datadog.
+pub trait ConfigurationProvider {
+    /// Returns a telemetry configuration object representing the current state of this configuration item.
+    ///
+    /// # Parameters
+    ///
+    /// - `config_id`: Optional identifier for remote configuration scenarios.
+    ///   When provided, this ID is included in the returned `Configuration` to
+    ///   track which remote configuration is responsible for the current value.
+    ///
+    fn get_configuration(&self, config_id: Option<String>) -> Configuration;
+}
+
 /// A trait for converting configuration values to their string representation for telemetry.
 ///
 /// This trait is used to serialize configuration values into strings that can be sent
@@ -288,14 +306,16 @@ impl<T: Clone + ConfigurationValueProvider> ConfigItem<T> {
             ConfigSourceOrigin::Default
         }
     }
+}
 
+impl<T: Clone + ConfigurationValueProvider> ConfigurationProvider for ConfigItem<T> {
     /// Gets a Configuration object used as telemetry payload
-    fn get_configuration(&self) -> Configuration {
+    fn get_configuration(&self, config_id: Option<String>) -> Configuration {
         Configuration {
             name: self.name.to_string(),
             value: self.value().get_configuration_value(),
             origin: self.source().into(),
-            config_id: None,
+            config_id,
         }
     }
 }
@@ -387,14 +407,18 @@ impl<T: ConfigurationValueProvider + Clone + Deref> ConfigItemWithOverride<T> {
             ConfigItemRef::Ref(self.config_item.value())
         }
     }
+}
 
+impl<T: Clone + ConfigurationValueProvider + Deref> ConfigurationProvider
+    for ConfigItemWithOverride<T>
+{
     /// Gets a Configuration object used as telemetry payload
-    fn get_configuration(&self) -> Configuration {
+    fn get_configuration(&self, config_id: Option<String>) -> Configuration {
         Configuration {
             name: self.config_item.name.to_string(),
             value: self.value().get_configuration_value(),
             origin: self.source().into(),
-            config_id: None,
+            config_id,
         }
     }
 }
@@ -970,33 +994,33 @@ impl Config {
         Self::builder_with_sources(&CompositeSource::default_sources())
     }
 
-    pub fn get_telemetry_configuration(&self) -> Vec<Configuration> {
+    pub fn get_telemetry_configuration(&self) -> Vec<&dyn ConfigurationProvider> {
         vec![
-            self.service.get_configuration(),
-            self.env.get_configuration(),
-            self.version.get_configuration(),
-            self.global_tags.get_configuration(),
-            self.agent_host.get_configuration(),
-            self.trace_agent_port.get_configuration(),
-            self.trace_agent_url.get_configuration(),
-            self.dogstatsd_agent_host.get_configuration(),
-            self.dogstatsd_agent_port.get_configuration(),
-            self.dogstatsd_agent_url.get_configuration(),
-            self.trace_sampling_rules.get_configuration(),
-            self.trace_rate_limit.get_configuration(),
-            self.enabled.get_configuration(),
-            self.log_level_filter.get_configuration(),
-            self.trace_stats_computation_enabled.get_configuration(),
-            self.telemetry_enabled.get_configuration(),
-            self.telemetry_log_collection_enabled.get_configuration(),
-            self.telemetry_heartbeat_interval.get_configuration(),
-            self.trace_propagation_style.get_configuration(),
-            self.trace_propagation_style_extract.get_configuration(),
-            self.trace_propagation_style_inject.get_configuration(),
-            self.trace_propagation_extract_first.get_configuration(),
-            self.remote_config_enabled.get_configuration(),
-            self.remote_config_poll_interval.get_configuration(),
-            self.datadog_tags_max_length.get_configuration(),
+            &self.service,
+            &self.env,
+            &self.version,
+            &self.global_tags,
+            &self.agent_host,
+            &self.trace_agent_port,
+            &self.trace_agent_url,
+            &self.dogstatsd_agent_host,
+            &self.dogstatsd_agent_port,
+            &self.dogstatsd_agent_url,
+            &self.trace_sampling_rules,
+            &self.trace_rate_limit,
+            &self.enabled,
+            &self.log_level_filter,
+            &self.trace_stats_computation_enabled,
+            &self.telemetry_enabled,
+            &self.telemetry_log_collection_enabled,
+            &self.telemetry_heartbeat_interval,
+            &self.trace_propagation_style,
+            &self.trace_propagation_style_extract,
+            &self.trace_propagation_style_inject,
+            &self.trace_propagation_extract_first,
+            &self.remote_config_enabled,
+            &self.remote_config_poll_interval,
+            &self.datadog_tags_max_length,
         ]
     }
 
@@ -1118,14 +1142,18 @@ impl Config {
         *self.trace_propagation_extract_first.value()
     }
 
-    pub fn update_sampling_rules_from_remote(&self, rules_json: &str) -> Result<(), String> {
+    pub fn update_sampling_rules_from_remote(
+        &self,
+        rules_json: &str,
+        config_id: Option<String>,
+    ) -> Result<(), String> {
         // Parse the JSON into SamplingRuleConfig objects
         let rules: Vec<SamplingRuleConfig> = serde_json::from_str(rules_json)
             .map_err(|e| format!("Failed to parse sampling rules JSON: {e}"))?;
 
         // If remote config sends empty rules, clear remote config to fall back to local rules
         if rules.is_empty() {
-            self.clear_remote_sampling_rules();
+            self.clear_remote_sampling_rules(config_id);
         } else {
             self.trace_sampling_rules.set_override_value(
                 ParsedSamplingRules { rules },
@@ -1137,7 +1165,7 @@ impl Config {
                 &RemoteConfigUpdate::SamplingRules(self.trace_sampling_rules().to_vec()),
             );
 
-            telemetry::notify_update_configuration(self.trace_sampling_rules.get_configuration());
+            telemetry::notify_configuration_update(&self.trace_sampling_rules, config_id);
         }
 
         Ok(())
@@ -1152,14 +1180,14 @@ impl Config {
         }
     }
 
-    pub fn clear_remote_sampling_rules(&self) {
+    pub fn clear_remote_sampling_rules(&self, config_id: Option<String>) {
         self.trace_sampling_rules.unset_override_value();
 
         self.remote_config_callbacks.lock().unwrap().notify_update(
             &RemoteConfigUpdate::SamplingRules(self.trace_sampling_rules().to_vec()),
         );
 
-        telemetry::notify_update_configuration(self.trace_sampling_rules.get_configuration());
+        telemetry::notify_configuration_update(&self.trace_sampling_rules, config_id);
     }
 
     /// Add a callback to be called when sampling rules are updated via remote configuration
@@ -1984,7 +2012,7 @@ mod tests {
 
         let rules_json = serde_json::to_string(&new_rules).unwrap();
         config
-            .update_sampling_rules_from_remote(&rules_json)
+            .update_sampling_rules_from_remote(&rules_json, None)
             .unwrap();
 
         // Callback should be called with the new rules
@@ -1995,7 +2023,7 @@ mod tests {
         *callback_called.lock().unwrap() = false;
         callback_rules.lock().unwrap().clear();
 
-        config.clear_remote_sampling_rules();
+        config.clear_remote_sampling_rules(None);
 
         // Callback should be called with fallback rules (empty in this case since no env/code rules
         // set)
@@ -2118,7 +2146,7 @@ mod tests {
         let remote_rules_json =
             r#"[{"sample_rate": 0.8, "service": "remote-service", "provenance": "remote"}]"#;
         config
-            .update_sampling_rules_from_remote(remote_rules_json)
+            .update_sampling_rules_from_remote(remote_rules_json, None)
             .unwrap();
 
         // Verify remote rules override local rules
@@ -2132,7 +2160,7 @@ mod tests {
         // 3. Remote config sends empty array []
         let empty_remote_rules_json = "[]";
         config
-            .update_sampling_rules_from_remote(empty_remote_rules_json)
+            .update_sampling_rules_from_remote(empty_remote_rules_json, None)
             .unwrap();
 
         // Empty remote rules automatically fall back to local rules
@@ -2145,7 +2173,7 @@ mod tests {
 
         // 4. Verify explicit clearing still works (for completeness)
         // Since we're already on local rules, clear should keep us on local rules
-        config.clear_remote_sampling_rules();
+        config.clear_remote_sampling_rules(None);
 
         // Should remain on local rules
         assert_eq!(config.trace_sampling_rules().len(), 1);
@@ -2398,7 +2426,7 @@ mod tests {
             r#"[{"sample_rate":0.5,"service":"web-api","name":null,"resource":null,"tags":{},"provenance":"customer"}]"#
         ).unwrap();
 
-        let configuration = &config.trace_sampling_rules.get_configuration();
+        let configuration = &config.trace_sampling_rules.get_configuration(None);
         assert_eq!(configuration.origin, ConfigurationOrigin::EnvVar);
 
         // Converting configuration value to json helps with comparison as serialized properties may
@@ -2414,7 +2442,7 @@ mod tests {
             .trace_sampling_rules
             .set_override_value(expected_rc.clone(), ConfigSourceOrigin::RemoteConfig);
 
-        let configuration_after_rc = &config.trace_sampling_rules.get_configuration();
+        let configuration_after_rc = &config.trace_sampling_rules.get_configuration(None);
         assert_eq!(
             configuration_after_rc.origin,
             ConfigurationOrigin::RemoteConfig
@@ -2427,7 +2455,7 @@ mod tests {
         // Reset ConfigItemRc RC previous value
         config.trace_sampling_rules.unset_override_value();
 
-        let configuration = &config.trace_sampling_rules.get_configuration();
+        let configuration = &config.trace_sampling_rules.get_configuration(None);
         assert_eq!(configuration.origin, ConfigurationOrigin::EnvVar);
         assert_eq!(
             ParsedSamplingRules::from_str(&configuration.value).unwrap(),
diff --git a/dd-trace/src/configuration/mod.rs b/dd-trace/src/configuration/mod.rs
@@ -7,5 +7,6 @@ pub mod remote_config;
 mod sources;
 
 pub use configuration::{
-    Config, ConfigBuilder, RemoteConfigUpdate, SamplingRuleConfig, TracePropagationStyle,
+    Config, ConfigBuilder, ConfigurationProvider, RemoteConfigUpdate, SamplingRuleConfig,
+    TracePropagationStyle,
 };
diff --git a/dd-trace/src/configuration/remote_config.rs b/dd-trace/src/configuration/remote_config.rs
@@ -190,6 +190,7 @@ where
 /// See: https://github.com/DataDog/dd-go/blob/prod/remote-config/apps/rc-schema-validation/schemas/apm-tracing.json
 #[derive(Debug, Clone, Deserialize)]
 struct ApmTracingConfig {
+    id: String,
     lib_config: LibConfig, // lib_config is a required property
 }
 
@@ -845,7 +846,8 @@ impl ProductHandler for ApmTracingHandler {
                 let rules_json = serde_json::to_string(&rules_value)
                     .map_err(|e| anyhow::anyhow!("Failed to serialize sampling rules: {}", e))?;
 
-                match config.update_sampling_rules_from_remote(&rules_json) {
+                match config.update_sampling_rules_from_remote(&rules_json, Some(tracing_config.id))
+                {
                     Ok(()) => {
                         crate::dd_debug!(
                             "RemoteConfigClient: Applied sampling rules from remote config"
@@ -862,7 +864,7 @@ impl ProductHandler for ApmTracingHandler {
                 crate::dd_debug!(
                     "RemoteConfigClient: APM tracing config received but tracing_sampling_rules is null"
                 );
-                config.clear_remote_sampling_rules();
+                config.clear_remote_sampling_rules(Some(tracing_config.id));
             }
         } else {
             crate::dd_debug!(
@@ -1088,6 +1090,7 @@ mod tests {
     #[test]
     fn test_apm_tracing_config_parsing() {
         let json = r#"{
+            "id": "42",
             "lib_config": {
                 "tracing_sampling_rules": [
                     {
@@ -1115,6 +1118,7 @@ mod tests {
     fn test_apm_tracing_config_full_schema() {
         // Test parsing a more complete configuration
         let json = r#"{
+            "id": "42",
             "lib_config": {
                 "tracing_sampling_rules": [
                     {
@@ -1303,7 +1307,7 @@ mod tests {
             target_files: Some(vec![
                 TargetFile {
                     path: "datadog/2/APM_TRACING/apm-tracing-sampling/config".to_string(),
-                    raw: "eyJsaWJfY29uZmlnIjogeyJ0cmFjaW5nX3NhbXBsaW5nX3J1bGVzIjogW3sic2FtcGxlX3JhdGUiOiAwLjUsICJzZXJ2aWNlIjogInRlc3Qtc2VydmljZSJ9XX19".to_string(), // base64 encoded APM config
+                    raw: "eyJpZCI6ICI0MiIsICJsaWJfY29uZmlnIjogeyJ0cmFjaW5nX3NhbXBsaW5nX3J1bGVzIjogW3sic2FtcGxlX3JhdGUiOiAwLjUsICJzZXJ2aWNlIjogInRlc3Qtc2VydmljZSJ9XX19".to_string(), // base64 encoded APM config
                 },
             ]),
             client_configs: Some(vec![
@@ -1343,7 +1347,7 @@ mod tests {
             cached_files[0].path,
             "datadog/2/APM_TRACING/apm-tracing-sampling/config"
         );
-        assert_eq!(cached_files[0].length, 124);
+        assert_eq!(cached_files[0].length, 140);
         assert_eq!(cached_files[0].hashes.len(), 1);
         assert_eq!(cached_files[0].hashes[0].algorithm, "sha256");
 
@@ -1419,7 +1423,7 @@ mod tests {
             target_files: Some(vec![
                 TargetFile {
                     path: "datadog/2/APM_TRACING/test-config/config".to_string(),
-                    raw: "eyJsaWJfY29uZmlnIjogeyJ0cmFjaW5nX3NhbXBsaW5nX3J1bGVzIjogW3sic2FtcGxlX3JhdGUiOiAwLjUsICJzZXJ2aWNlIjogInRlc3Qtc2VydmljZSJ9XX19".to_string(),
+                    raw: "eyJpZCI6ICI0MiIsICJsaWJfY29uZmlnIjogeyJ0cmFjaW5nX3NhbXBsaW5nX3J1bGVzIjogW3sic2FtcGxlX3JhdGUiOiAwLjUsICJzZXJ2aWNlIjogInRlc3Qtc2VydmljZSJ9XX19".to_string(),
                 },
             ]),
             client_configs: Some(vec![
@@ -1648,7 +1652,7 @@ mod tests {
 
         // Test processing config - this should not panic for valid JSON
         let config = Arc::new(Config::builder().build());
-        let config_json = r#"{"lib_config": {"tracing_sampling_rules": [{"sample_rate": 0.5, "service": "test"}]}}"#;
+        let config_json = r#"{"id": "42", "lib_config": {"tracing_sampling_rules": [{"sample_rate": 0.5, "service": "test"}]}}"#;
 
         // This should succeed
         let result = handler.process_config(config_json, &config);
@@ -1673,7 +1677,7 @@ mod tests {
             target_files: Some(vec![
                 TargetFile {
                     path: "datadog/2/APM_TRACING/config1/config".to_string(),
-                    raw: "eyJsaWJfY29uZmlnIjogeyJ0cmFjaW5nX3NhbXBsaW5nX3J1bGVzIjogW3sic2FtcGxlX3JhdGUiOiAwLjUsICJzZXJ2aWNlIjogInRlc3Qtc2VydmljZS0xIn1dfX0=".to_string(),
+                    raw: "eyJpZCI6ICI0MiIsICJsaWJfY29uZmlnIjogeyJ0cmFjaW5nX3NhbXBsaW5nX3J1bGVzIjogW3sic2FtcGxlX3JhdGUiOiAwLjUsICJzZXJ2aWNlIjogInRlc3Qtc2VydmljZS0xIn1dfX0=".to_string(),
                 },
             ]),
             client_configs: Some(vec![
@@ -1700,11 +1704,11 @@ mod tests {
             target_files: Some(vec![
                 TargetFile {
                     path: "datadog/2/APM_TRACING/config2/config".to_string(),
-                    raw: "eyJsaWJfY29uZmlnIjogeyJ0cmFjaW5nX3NhbXBsaW5nX3J1bGVzIjogW3sic2FtcGxlX3JhdGUiOiAwLjc1LCAic2VydmljZSI6ICJ0ZXN0LXNlcnZpY2UtMiJ9XX19".to_string(),
+                    raw: "eyJpZCI6ICI0MiIsICJsaWJfY29uZmlnIjogeyJpZCI6IjQyIiwgInRyYWNpbmdfc2FtcGxpbmdfcnVsZXMiOiBbeyJzYW1wbGVfcmF0ZSI6IDAuNzUsICJzZXJ2aWNlIjogInRlc3Qtc2VydmljZS0yIn1dfX0=".to_string(),
                 },
                 TargetFile {
                     path: "datadog/2/APM_TRACING/config3/config".to_string(),
-                    raw: "eyJsaWJfY29uZmlnIjogeyJ0cmFjaW5nX3NhbXBsaW5nX3J1bGVzIjogW3sic2FtcGxlX3JhdGUiOiAwLjI1LCAic2VydmljZSI6ICJ0ZXN0LXNlcnZpY2UtMiJ9XX19".to_string(),
+                    raw: "eyJpZCI6ICI0MiIsICJsaWJfY29uZmlnIjogeyJpZCI6IjQyIiwgInRyYWNpbmdfc2FtcGxpbmdfcnVsZXMiOiBbeyJzYW1wbGVfcmF0ZSI6IDAuMjUsICJzZXJ2aWNlIjogInRlc3Qtc2VydmljZS0yIn1dfX0=".to_string(),
                 },
             ]),
             client_configs: Some(vec![
@@ -1776,7 +1780,7 @@ mod tests {
             target_files: Some(vec![
                 TargetFile {
                     path: "datadog/2/APM_TRACING/good_config/config".to_string(),
-                    raw: "eyJsaWJfY29uZmlnIjogeyJ0cmFjaW5nX3NhbXBsaW5nX3J1bGVzIjogW3sic2FtcGxlX3JhdGUiOiAwLjUsICJzZXJ2aWNlIjogInRlc3Qtc2VydmljZSJ9XX19".to_string(),
+                    raw: "eyJpZCI6ICI0MiIsICJsaWJfY29uZmlnIjogeyJ0cmFjaW5nX3NhbXBsaW5nX3J1bGVzIjogW3sic2FtcGxlX3JhdGUiOiAwLjUsICJzZXJ2aWNlIjogInRlc3Qtc2VydmljZSJ9XX19".to_string(),
                 },
             ]),
             client_configs: Some(vec![
@@ -1878,7 +1882,7 @@ mod tests {
             target_files: Some(vec![
                 TargetFile {
                     path: "datadog/2/APM_TRACING/test-sampling/config".to_string(),
-                    raw: "eyJsaWJfY29uZmlnIjogeyJ0cmFjaW5nX3NhbXBsaW5nX3J1bGVzIjogW3sic2FtcGxlX3JhdGUiOiAwLjc1LCAic2VydmljZSI6ICJ0ZXN0LWFwcC1zZXJ2aWNlIn1dfX0=".to_string(), // base64 encoded sampling rules
+                    raw: "eyJpZCI6ICI0MiIsICJsaWJfY29uZmlnIjogeyJ0cmFjaW5nX3NhbXBsaW5nX3J1bGVzIjogW3sic2FtcGxlX3JhdGUiOiAwLjc1LCAic2VydmljZSI6ICJ0ZXN0LWFwcC1zZXJ2aWNlIn1dfX0=".to_string(), // base64 encoded sampling rules
                 },
             ]),
             client_configs: Some(vec![
@@ -1918,7 +1922,7 @@ mod tests {
 
     #[test]
     fn test_deserialize_tracing_sampling_rules_null() {
-        let config_json = r#"{"lib_config": {"tracing_sampling_rules": null}}"#;
+        let config_json = r#"{"id": "42", "lib_config": {"tracing_sampling_rules": null}}"#;
         let tracing_config: ApmTracingConfig =
             serde_json::from_str(config_json).expect("Json should be parsed");
 
@@ -1932,7 +1936,7 @@ mod tests {
 
     #[test]
     fn test_deserialize_tracing_sampling_rules_missing() {
-        let config_json = r#"{"lib_config": {}}"#;
+        let config_json = r#"{"id": "42", "lib_config": {}}"#;
         let tracing_config: ApmTracingConfig =
             serde_json::from_str(config_json).expect("Json should be parsed");
 
diff --git a/dd-trace/src/telemetry.rs b/dd-trace/src/telemetry.rs

Original file line number	Diff line number	Diff line change
`@@ -191,6 +191,7 @@ async fn test_remote_config_sampling_rates() {`
`191`	`191`	`r##"{`
`192`	`192`	`"path": "datadog/2/APM_TRACING/1234/config",`
`193`	`193`	`"msg": {`
	`194`	`+ "id": "42",`
`194`	`195`	`"lib_config": {`
`195`	`196`	`"tracing_sampling_rules": [`
`196`	`197`	`{`