Add helpers for handling of ReportFullState ServerToAgent flag

Introducing basic handling of the ReportsEffectiveConfig capability

Author: xrmx

opamp/opentelemetry-opamp-client/src/opentelemetry/_opamp/client.py

@@ -46,6 +46,7 @@
     | opamp_pb2.AgentCapabilities.AgentCapabilities_ReportsHeartbeat
     | opamp_pb2.AgentCapabilities.AgentCapabilities_AcceptsRemoteConfig
     | opamp_pb2.AgentCapabilities.AgentCapabilities_ReportsRemoteConfig
+    | opamp_pb2.AgentCapabilities.AgentCapabilities_ReportsEffectiveConfig
 )
 
 
@@ -87,6 +88,7 @@ def __init__(
         self._sequence_num: int = 0
         self._instance_uid: bytes = uuid7().bytes
         self._remote_config_status: opamp_pb2.RemoteConfigStatus | None = None
+        self._effective_config: opamp_pb2.EffectiveConfig | None = None
 
     def build_connection_message(self) -> bytes:
         message = messages.build_presentation_message(
@@ -116,6 +118,14 @@ def build_heartbeat_message(self) -> bytes:
         data = messages.encode_message(message)
         return data
 
+    def update_effective_config(
+        self, effective_config: dict[str, dict[str, str]], content_type: str
+    ) -> opamp_pb2.EffectiveConfig:
+        self._effective_config = messages.build_effective_config_message(
+            config=effective_config, content_type=content_type
+        )
+        return self._effective_config
+
     def update_remote_config_status(
         self,
         remote_config_hash: bytes,
@@ -158,6 +168,18 @@ def build_remote_config_status_response_message(
         data = messages.encode_message(message)
         return data
 
+    def build_full_state_message(self) -> bytes:
+        message = messages.build_full_state_message(
+            instance_uid=self._instance_uid,
+            agent_description=self._agent_description,
+            remote_config_status=self._remote_config_status,
+            sequence_num=self._sequence_num,
+            effective_config=self._effective_config,
+            capabilities=_HANDLED_CAPABILITIES,
+        )
+        data = messages.encode_message(message)
+        return data
+
     def send(self, data: bytes):
         token = attach(set_value(_SUPPRESS_INSTRUMENTATION_KEY, True))
         try:

opamp/opentelemetry-opamp-client/src/opentelemetry/_opamp/messages.py

@@ -144,6 +144,39 @@ def build_remote_config_status_response_message(
     return command
 
 
+def build_effective_config_message(
+    config: dict[str, dict[str, str]], content_type: str
+):
+    agent_config_map = opamp_pb2.AgentConfigMap()
+    for filename, value in config.items():
+        if content_type == "application/json":
+            body = json.dumps(value)
+            agent_config_map.config_map[filename].body = body.encode("utf-8")
+            agent_config_map.config_map[filename].content_type = content_type
+    return opamp_pb2.EffectiveConfig(
+        config_map=agent_config_map,
+    )
+
+
+def build_full_state_message(
+    instance_uid: bytes,
+    sequence_num: int,
+    agent_description: opamp_pb2.AgentDescription,
+    capabilities: int,
+    remote_config_status: opamp_pb2.RemoteConfigStatus | None,
+    effective_config: opamp_pb2.EffectiveConfig | None,
+) -> opamp_pb2.AgentToServer:
+    command = opamp_pb2.AgentToServer(
+        instance_uid=instance_uid,
+        sequence_num=sequence_num,
+        agent_description=agent_description,
+        remote_config_status=remote_config_status,
+        effective_config=effective_config,
+        capabilities=capabilities,
+    )
+    return command
+
+
 def encode_message(data: opamp_pb2.AgentToServer) -> bytes:
     return data.SerializeToString()
 

opamp/opentelemetry-opamp-client/tests/opamp/test_client.py

@@ -317,6 +317,78 @@ def test_build_remote_config_status_response_message_with_error_message(
     assert message.remote_config_status.error_message == "an error message"
 
 
+def test_update_effective_config_json_content_type(client):
+    config = {"filename": {"a": "config"}}
+    client.update_effective_config(config, content_type="application/json")
+
+    assert isinstance(client._effective_config, opamp_pb2.EffectiveConfig)
+
+    decoded_config = {}
+    for (
+        file_name,
+        config_file,
+    ) in client._effective_config.config_map.config_map.items():
+        body = config_file.body.decode()
+        decoded_config[file_name] = json.loads(body)
+
+    assert config == decoded_config
+
+
+def test_build_full_state_message(client):
+    client.update_remote_config_status(
+        remote_config_hash=b"12345678",
+        status=opamp_pb2.RemoteConfigStatuses_APPLIED,
+    )
+    config = {"filename": {"a": "config"}}
+    client.update_effective_config(config, content_type="application/json")
+
+    data = client.build_full_state_message()
+
+    message = opamp_pb2.AgentToServer()
+    message.ParseFromString(data)
+
+    assert message
+    assert message.instance_uid == client._instance_uid
+    assert message.sequence_num == 0
+    assert message.capabilities == _HANDLED_CAPABILITIES
+    assert message.agent_description.identifying_attributes == [
+        PB2KeyValue(key="foo", value=PB2AnyValue(string_value="bar")),
+    ]
+    assert message.remote_config_status
+    assert message.remote_config_status.last_remote_config_hash == b"12345678"
+    assert (
+        message.remote_config_status.status
+        == opamp_pb2.RemoteConfigStatuses_APPLIED
+    )
+    assert "filename" in message.effective_config.config_map.config_map
+    config_file = message.effective_config.config_map.config_map["filename"]
+    assert config_file.content_type == "application/json"
+    body = config_file.body.decode()
+    assert config["filename"] == json.loads(body)
+
+
+def test_build_full_state_message_no_config(client):
+    data = client.build_full_state_message()
+
+    message = opamp_pb2.AgentToServer()
+    message.ParseFromString(data)
+
+    assert message
+    assert message.instance_uid == client._instance_uid
+    assert message.sequence_num == 0
+    assert message.capabilities == _HANDLED_CAPABILITIES
+    assert message.agent_description.identifying_attributes == [
+        PB2KeyValue(key="foo", value=PB2AnyValue(string_value="bar")),
+    ]
+    assert message.remote_config_status
+    assert message.remote_config_status.last_remote_config_hash == b""
+    assert (
+        message.remote_config_status.status
+        == opamp_pb2.RemoteConfigStatuses_UNSET
+    )
+    assert message.effective_config.config_map.config_map == {}
+
+
 def test_message_sequence_num_increases_in_send(client):
     client._transport = mock.Mock()
     for index in range(2):