feat: support split remote config on agents (NR-490636) (#1902)

gsanchezgavier · web-flow · commit 97736fd863bb · 2025-12-02T12:39:27.000+01:00
* feat: support split remote config on agents

* review

* improve doc

* nits
diff --git a/agent-control/src/agent_control.rs b/agent-control/src/agent_control.rs
@@ -598,9 +598,7 @@ mod tests {
     use crate::opamp::client_builder::tests::MockStartedOpAMPClient;
     use crate::opamp::remote_config::hash::{ConfigState, Hash};
     use crate::opamp::remote_config::validators::tests::TestRemoteConfigValidator;
-    use crate::opamp::remote_config::{
-        ConfigurationMap, DEFAULT_AGENT_CONFIG_IDENTIFIER, OpampRemoteConfig,
-    };
+    use crate::opamp::remote_config::{AGENT_CONFIG_PREFIX, ConfigurationMap, OpampRemoteConfig};
     use crate::sub_agent::collection::StartedSubAgents;
     use crate::sub_agent::error::SubAgentBuilderError;
     use crate::sub_agent::identity::AgentIdentity;
@@ -725,7 +723,7 @@ agents:
                 hash,
                 ConfigState::Applying,
                 ConfigurationMap::new(HashMap::from([(
-                    DEFAULT_AGENT_CONFIG_IDENTIFIER.to_string(),
+                    AGENT_CONFIG_PREFIX.to_string(),
                     s.to_string(),
                 )])),
             )
diff --git a/agent-control/src/opamp/callbacks.rs b/agent-control/src/opamp/callbacks.rs
@@ -264,9 +264,7 @@ pub(crate) mod tests {
     use crate::opamp::remote_config::signature::{
         ED25519, SIGNATURE_CUSTOM_CAPABILITY, SIGNATURE_CUSTOM_MESSAGE_TYPE,
     };
-    use crate::opamp::remote_config::{
-        ConfigurationMap, DEFAULT_AGENT_CONFIG_IDENTIFIER, OpampRemoteConfig,
-    };
+    use crate::opamp::remote_config::{AGENT_CONFIG_PREFIX, ConfigurationMap, OpampRemoteConfig};
     use opamp_client::opamp::proto::{AgentConfigFile, AgentConfigMap, AgentRemoteConfig};
     use std::collections::HashMap;
     use std::time::Duration;
@@ -340,15 +338,15 @@ pub(crate) mod tests {
         let (valid_remote_config_map, expected_remote_config_map) = (
             AgentConfigMap {
                 config_map: HashMap::from([(
-                    DEFAULT_AGENT_CONFIG_IDENTIFIER.to_string(),
+                    AGENT_CONFIG_PREFIX.to_string(),
                     AgentConfigFile {
                         body: "enable_proces_metrics: true".as_bytes().to_vec(),
                         content_type: "".to_string(),
                     },
                 )]),
             },
             ConfigurationMap::new(HashMap::from([(
-                DEFAULT_AGENT_CONFIG_IDENTIFIER.to_string(),
+                AGENT_CONFIG_PREFIX.to_string(),
                 "enable_proces_metrics: true".to_string(),
             )])),
         );
@@ -493,7 +491,7 @@ pub(crate) mod tests {
                         capability: SIGNATURE_CUSTOM_CAPABILITY.to_string(),
                         r#type: SIGNATURE_CUSTOM_MESSAGE_TYPE.to_string(),
                         data: serde_json::json!({
-                            DEFAULT_AGENT_CONFIG_IDENTIFIER: [{
+                            AGENT_CONFIG_PREFIX: [{
                                 "signature": "fake config",
                                 "signingAlgorithm": "ED25519",
                                 "keyId": "fake keyid"
@@ -508,7 +506,7 @@ pub(crate) mod tests {
                 expected_remote_config_config_map: expected_remote_config_map.clone(),
                 expected_remote_config_hash: Hash::from(valid_hash),
                 expected_remote_config_state: ConfigState::Applying,
-                expected_signature: Some(Signatures::new_default(DEFAULT_AGENT_CONFIG_IDENTIFIER,
+                expected_signature: Some(Signatures::new_default(AGENT_CONFIG_PREFIX,
                     "fake config",
                     ED25519,
                     "fake keyid",
diff --git a/agent-control/src/opamp/remote_config.rs b/agent-control/src/opamp/remote_config.rs
@@ -12,8 +12,10 @@ pub mod report;
 pub mod signature;
 pub mod validators;
 
-/// Identifier key for the primary agent configuration within the OpAMP [opamp_client::opamp::proto::AgentConfigMap].
-pub const DEFAULT_AGENT_CONFIG_IDENTIFIER: &str = "agentConfig";
+/// Prefix that identifies the agent configuration keys within the OpAMP [opamp_client::opamp::proto::AgentConfigMap].
+/// Any key that starts with this prefix is considered part of the agent configuration. See parsing implementation
+/// for each case.
+pub const AGENT_CONFIG_PREFIX: &str = "agentConfig";
 
 /// This structure represents the remote configuration that we would retrieve from a server via OpAMP.
 /// Contains identifying metadata and the actual configuration values
@@ -59,16 +61,24 @@ impl OpampRemoteConfig {
         }
     }
 
-    /// Get all configuration values
-    pub fn configs(&self) -> &ConfigurationMap {
-        &self.config_map
+    /// Returns an iterator over the configuration key-value pairs.
+    pub fn configs_iter(&self) -> impl Iterator<Item = (&String, &String)> {
+        self.config_map.0.iter()
+    }
+
+    /// Returns an iterator over the configuration key-value pairs that start with [AGENT_CONFIG_PREFIX].
+    pub fn agent_configs_iter(&self) -> impl Iterator<Item = (&String, &String)> {
+        self.config_map
+            .0
+            .iter()
+            .filter(|(k, _)| k.starts_with(AGENT_CONFIG_PREFIX))
     }
 
     /// Get configuration value at the
     pub fn get_default(&self) -> Result<&str, OpampRemoteConfigError> {
         self.config_map
             .0
-            .get(DEFAULT_AGENT_CONFIG_IDENTIFIER)
+            .get(AGENT_CONFIG_PREFIX)
             .map(|s| s.as_str())
             .ok_or(OpampRemoteConfigError::InvalidConfig(
                 self.hash.to_string(),
@@ -142,3 +152,47 @@ impl From<ConfigurationMap> for EffectiveConfig {
         Self { config_map }
     }
 }
+
+#[cfg(test)]
+mod tests {
+    use super::*;
+    use rstest::rstest;
+
+    #[rstest]
+    #[case::single_agent_config(
+        r#"{"agentConfig": "key: value"}"#,
+        r#"{"agentConfig": "key: value"}"#
+    )]
+    #[case::multiple_agent_configs(
+        r#"{"agentConfig": "key1: value1", "agentConfig2": "key2: value2"}"#,
+        r#"{"agentConfig": "key1: value1", "agentConfig2": "key2: value2"}"#
+    )]
+    #[case::mixed_configs_filters_non_agent(
+        r#"{"agentConfig": "key1: value1", "otherConfig": "key2: value2", "agentConfig3": "key3: value3"}"#,
+        r#"{"agentConfig": "key1: value1", "agentConfig3": "key3: value3"}"#
+    )]
+    #[case::no_agent_configs(
+        r#"{"otherConfig": "key1: value1", "someConfig": "key2: value2"}"#,
+        r#"{}"#
+    )]
+    fn test_agent_configs_iter(#[case] config_json: &str, #[case] expected_json: &str) {
+        let agent_id = AgentID::try_from("test-agent").unwrap();
+        let hash = Hash::from("some-hash");
+        let state = ConfigState::Applying;
+        let config_map = ConfigurationMap::new(
+            serde_json::from_str::<HashMap<String, String>>(config_json).unwrap(),
+        );
+        let opamp_config = OpampRemoteConfig::new(agent_id, hash, state, config_map);
+
+        let result: HashMap<&String, &String> = opamp_config.agent_configs_iter().collect();
+        let expected: HashMap<String, String> = serde_json::from_str(expected_json).unwrap();
+
+        assert_eq!(result.len(), expected.len());
+        for (expected_key, expected_value) in &expected {
+            assert_eq!(
+                result.get(expected_key).map(|v| v.as_str()),
+                Some(expected_value.as_str())
+            );
+        }
+    }
+}
diff --git a/agent-control/src/opamp/remote_config/validators/regexes.rs b/agent-control/src/opamp/remote_config/validators/regexes.rs
@@ -37,9 +37,7 @@ impl RemoteConfigValidator for RegexValidator {
     ) -> Result<(), RegexValidatorError> {
         // This config will fail further on the event processor.
         opamp_remote_config
-            .configs()
-            .0
-            .iter()
+            .agent_configs_iter()
             .try_for_each(|(_, raw_config)| {
                 self.validate_regex_rules(&agent_identity.agent_type_id, raw_config)
             })?;
@@ -147,7 +145,7 @@ pub(super) mod tests {
     use crate::agent_control::defaults::AGENT_TYPE_NAME_INFRA_AGENT;
     use crate::agent_control::defaults::AGENT_TYPE_NAME_NRDOT;
     use crate::agent_type::agent_type_id::AgentTypeID;
-    use crate::opamp::remote_config::DEFAULT_AGENT_CONFIG_IDENTIFIER;
+    use crate::opamp::remote_config::AGENT_CONFIG_PREFIX;
     use crate::opamp::remote_config::hash::{ConfigState, Hash};
     use crate::opamp::remote_config::validators::RemoteConfigValidator;
     use crate::opamp::remote_config::validators::regexes::{RegexValidator, RegexValidatorError};
@@ -197,7 +195,7 @@ pub(super) mod tests {
             Hash::from("this-is-a-hash"),
             ConfigState::Applying,
             ConfigurationMap::new(HashMap::from([(
-                DEFAULT_AGENT_CONFIG_IDENTIFIER.to_string(),
+                AGENT_CONFIG_PREFIX.to_string(),
                 content.to_string(),
             )])),
         );
@@ -509,7 +507,7 @@ config:
             Hash::from("this-is-a-hash"),
             ConfigState::Applying,
             ConfigurationMap::new(HashMap::from([(
-                DEFAULT_AGENT_CONFIG_IDENTIFIER.to_string(),
+                AGENT_CONFIG_PREFIX.to_string(),
                 config.to_string(),
             )])),
         )
diff --git a/agent-control/src/opamp/remote_config/validators/signature/validator.rs b/agent-control/src/opamp/remote_config/validators/signature/validator.rs
@@ -111,7 +111,7 @@ impl RemoteConfigValidator for SignatureValidator {
         };
 
         // Iterate over all remote configs and verify signatures
-        for (config_name, config_content) in opamp_remote_config.configs().0.iter() {
+        for (config_name, config_content) in opamp_remote_config.configs_iter() {
             let signature = opamp_remote_config.signature(config_name).map_err(|e| {
                 SignatureValidatorError::VerifySignature(format!(
                     "getting signature for config '{}' config signature: {}",
diff --git a/agent-control/src/sub_agent.rs b/agent-control/src/sub_agent.rs
@@ -732,9 +732,7 @@ pub mod tests {
     use crate::opamp::client_builder::tests::MockStartedOpAMPClient;
     use crate::opamp::remote_config::hash::Hash;
     use crate::opamp::remote_config::validators::tests::MockRemoteConfigValidator;
-    use crate::opamp::remote_config::{
-        ConfigurationMap, DEFAULT_AGENT_CONFIG_IDENTIFIER, OpampRemoteConfig,
-    };
+    use crate::opamp::remote_config::{AGENT_CONFIG_PREFIX, ConfigurationMap, OpampRemoteConfig};
     use crate::secrets_provider::SecretsProviders;
     use crate::values::config::RemoteConfig;
     use crate::values::config_repository::tests::InMemoryConfigRepository;
@@ -955,7 +953,7 @@ deployment:
                 Self::hash(),
                 ConfigState::Applying,
                 ConfigurationMap::new(HashMap::from([(
-                    DEFAULT_AGENT_CONFIG_IDENTIFIER.to_string(),
+                    AGENT_CONFIG_PREFIX.to_string(),
                     Self::valid_config_yaml().try_into().unwrap(),
                 )])),
             )
@@ -967,7 +965,7 @@ deployment:
                 Self::hash(),
                 ConfigState::Applying,
                 ConfigurationMap::new(HashMap::from([(
-                    DEFAULT_AGENT_CONFIG_IDENTIFIER.to_string(),
+                    AGENT_CONFIG_PREFIX.to_string(),
                     // Reset signal
                     "".to_string(),
                 )])),
@@ -982,7 +980,7 @@ deployment:
                     error_message: "error_message".to_string(),
                 },
                 ConfigurationMap::new(HashMap::from([(
-                    DEFAULT_AGENT_CONFIG_IDENTIFIER.to_string(),
+                    AGENT_CONFIG_PREFIX.to_string(),
                     "broken config:".to_string(),
                 )])),
             )
diff --git a/agent-control/src/sub_agent/remote_config_parser.rs b/agent-control/src/sub_agent/remote_config_parser.rs
diff --git a/agent-control/src/values/yaml_config.rs b/agent-control/src/values/yaml_config.rs
diff --git a/agent-control/tests/common/opamp.rs b/agent-control/tests/common/opamp.rs
