feat(er): Ensure APM_MULTICONFIG compat works

Author: tylfin

tests/debugger/test_debugger_inproduct_enablement.py

@@ -5,6 +5,7 @@
 import tests.debugger.utils as debugger
 from utils import features, scenarios, missing_feature, context, logger
 import json
+import time
 
 TIMEOUT = 5
 
@@ -67,43 +68,46 @@ class Test_Debugger_InProduct_Enablement_Exception_Replay(debugger.BaseDebuggerT
     ############ exception replay ############
     _max_retries = 2
 
-    def setup_inproduct_enablement_exception_replay(self):
-        def _send_config(enabled=None):
-            self.send_rc_apm_tracing(exception_replay_enabled=enabled)
+    def _send_config(self, enabled=None, service_name="weblog", env="system-tests"):
+        self.send_rc_apm_tracing(exception_replay_enabled=enabled, service_name=service_name, env=env)
 
-        def _wait_for_exception_snapshot_received(request_path, exception_message):
-            self.weblog_responses = []
+    def _wait_for_exception_snapshot_received(self, request_path, exception_message):
+        self.weblog_responses = []
 
-            retries = 0
-            snapshot_found = False
+        retries = 0
+        snapshot_found = False
 
-            while not snapshot_found and retries < self._max_retries:
-                logger.debug(f"Waiting for snapshot, retry #{retries}")
+        while not snapshot_found and retries < self._max_retries:
+            logger.debug(f"Waiting for snapshot, retry #{retries}")
 
-                self.send_weblog_request(request_path, reset=False)
-                snapshot_found = self.wait_for_exception_snapshot_received(exception_message, TIMEOUT)
+            self.send_weblog_request(request_path, reset=False)
+            snapshot_found = self.wait_for_exception_snapshot_received(exception_message, TIMEOUT)
 
-                retries += 1
+            retries += 1
 
-            return snapshot_found
+        return snapshot_found
 
+    def setup_inproduct_enablement_exception_replay(self):
+        self.start_time = int(time.time() * 1000)
         self.initialize_weblog_remote_config()
         self.weblog_responses = []
 
-        self.er_initial_enabled = not _wait_for_exception_snapshot_received(
+        self.er_initial_enabled = not self._wait_for_exception_snapshot_received(
             "/exceptionreplay/simple", "simple exception"
         )
 
-        _send_config(enabled=True)
-        self.er_explicit_enabled = _wait_for_exception_snapshot_received("/exceptionreplay/simple", "simple exception")
+        self._send_config(enabled=True)
+        self.er_explicit_enabled = self._wait_for_exception_snapshot_received(
+            "/exceptionreplay/simple", "simple exception"
+        )
 
-        _send_config()
-        self.er_empty_config = _wait_for_exception_snapshot_received(
+        self._send_config()
+        self.er_empty_config = self._wait_for_exception_snapshot_received(
             "/exceptionreplay/recursion?depth=1", "recursion exception depth 1"
         )
 
-        _send_config(enabled=False)
-        self.er_explicit_disabled = not _wait_for_exception_snapshot_received(
+        self._send_config(enabled=False)
+        self.er_explicit_disabled = not self._wait_for_exception_snapshot_received(
             "/exceptionreplay/multiframe", "multiple stack frames exception"
         )
 
@@ -116,6 +120,42 @@ def test_inproduct_enablement_exception_replay(self):
         assert self.er_empty_config, "Expected snapshots to continue emitting with empty config"
         assert self.er_explicit_disabled, "Expected snapshots to stop emitting after explicit disable"
 
+    def setup_inproduct_enablement_exception_replay_apm_multiconfig(self):
+        self.start_time = int(time.time() * 1000)
+        self.initialize_weblog_remote_config()
+        self.weblog_responses = []
+
+        self._send_config(enabled=False, service_name="*", env="*")
+        self.er_initial_enabled = not self._wait_for_exception_snapshot_received(
+            "/exceptionreplay/simple", "simple exception"
+        )
+
+        self._send_config(enabled=True, service_name="*", env="*")
+        self.er_apm_multiconfig_enabled = self._wait_for_exception_snapshot_received(
+            "/exceptionreplay/simple", "simple exception"
+        )
+
+        self._send_config(enabled=False, service_name="weblog", env="system-tests")
+        self.er_disabled_by_service_name = not self._wait_for_exception_snapshot_received(
+            "/exceptionreplay/recursion?depth=1", "recursion exception depth 1"
+        )
+
+        self._send_config(enabled=True, service_name="*", env="*")
+        self.er_apm_multiconfig_enabled_2 = not self._wait_for_exception_snapshot_received(
+            "/exceptionreplay/multiframe", "multiple stack frames exception"
+        )
+
+    @missing_feature(context.library == "python", force_skip=True)
+    @missing_feature(context.library == "java", force_skip=True)
+    def test_inproduct_enablement_exception_replay_apm_multiconfig(self):
+        self.assert_rc_state_not_error()
+        self.assert_all_weblog_responses_ok(expected_code=500)
+
+        assert self.er_initial_enabled, "Expected snapshots to not be emitting when exception replay was disabled"
+        assert self.er_apm_multiconfig_enabled, "Expected snapshots to be emitting after enabling exception replay"
+        assert self.er_disabled_by_service_name, "Expected snapshots to stop emitting after service name override"
+        assert self.er_apm_multiconfig_enabled_2, "Expected snapshots to not be emitting after service name override"
+
 
 @features.debugger_inproduct_enablement
 @scenarios.debugger_inproduct_enablement

tests/debugger/utils.py

@@ -80,6 +80,8 @@ class BaseDebuggerTest:
     all_spans: list = []
     symbols: list = []
 
+    start_time: int | None = None
+
     rc_states: list[remote_config.RemoteConfigStateResults] = []
     weblog_responses: list = []
 
@@ -212,6 +214,8 @@ def send_rc_apm_tracing(
         live_debugging_enabled: bool | None = None,
         code_origin_enabled: bool | None = None,
         dynamic_sampling_enabled: bool | None = None,
+        service_name: str | None = "weblog",
+        env: str | None = "system-tests",
         *,
         reset: bool = True,
     ) -> None:
@@ -228,6 +232,8 @@ def send_rc_apm_tracing(
                 code_origin_enabled=code_origin_enabled,
                 dynamic_sampling_enabled=dynamic_sampling_enabled,
                 version=BaseDebuggerTest._rc_version,
+                service_name=service_name,
+                env=env,
             )
         )
 
@@ -315,14 +321,17 @@ def _wait_for_snapshot_received(self, data: dict):
             contents = data["request"].get("content", []) or []
 
             for content in contents:
+                # Filter out snapshots from before the test start time for multiple tests using the same file.
+                if "timestamp" in content and self.start_time is not None:
+                    if content["timestamp"] < self.start_time:
+                        continue
+
                 snapshot = content.get("debugger", {}).get("snapshot") or content.get("debugger.snapshot")
 
                 if not snapshot or "probe" not in snapshot:
-                    logger.debug("Snapshot doesn't have pobe")
                     continue
 
                 if "exceptionId" not in snapshot:
-                    logger.debug("Snapshot doesnt't have exception")
                     continue
 
                 exception_message = self.get_exception_message(snapshot)

utils/_remote_config.py

@@ -265,6 +265,8 @@ def build_apm_tracing_command(
     live_debugging_enabled: bool | None = None,
     code_origin_enabled: bool | None = None,
     dynamic_sampling_enabled: bool | None = None,
+    service_name: str | None = "weblog",
+    env: str | None = "system-tests",
 ):
     lib_config: dict[str, str | bool] = {
         "library_language": "all",
@@ -287,6 +289,7 @@ def build_apm_tracing_command(
         "schema_version": "v1.0.0",
         "action": "enable",
         "lib_config": lib_config,
+        "service_target": {"service": service_name, "env": env},
     }
 
     path_payloads = {"datadog/2/APM_TRACING/config_overrides/config": config}
@@ -299,6 +302,8 @@ def send_apm_tracing_command(
     live_debugging_enabled: bool | None = None,
     code_origin_enabled: bool | None = None,
     dynamic_sampling_enabled: bool | None = None,
+    service_name: str | None = "weblog",
+    env: str | None = "system-tests",
     version: int = 1,
 ) -> RemoteConfigStateResults:
     raw_payload = build_apm_tracing_command(
@@ -308,6 +313,8 @@ def send_apm_tracing_command(
         live_debugging_enabled=live_debugging_enabled,
         code_origin_enabled=code_origin_enabled,
         dynamic_sampling_enabled=dynamic_sampling_enabled,
+        service_name=service_name,
+        env=env,
     )
 
     return send_state(raw_payload)