ddapm-test-agent 1.36.0__tar.gz → 1.38.0__tar.gz

{ddapm_test_agent-1.36.0 → ddapm_test_agent-1.38.0}/.github/workflows/main.yml

@@ -15,8 +15,8 @@ jobs:
       - uses: actions/checkout@08eba0b27e820071cde6df949e0beb9ba4906955 # v4.3.0
         with:
           fetch-depth: 0
+      - run: pip install --upgrade 'pip<24.1'
       - run: pip install .[testing]
-      - run: riot -v run -s check_fmt
       - run: riot -v run -s flake8
       - run: riot -v run mypy
   test:
@@ -30,8 +30,14 @@ jobs:
       - uses: actions/setup-python@e797f83bcb11b83ae66e0230d6156d7c80228e7c # v6.0.0
         with:
           python-version: ${{ matrix.python-version }}
+      - name: Downgrade pip for riot compatibility
+        if: runner.os != 'Windows'
+        run: pip install --upgrade 'pip<24.1'
       - name: install deps
         run: pip install .[testing]
+      - name: install pip-tools
+        if: runner.os != 'Windows'
+        run: pip install 'pip-tools>=7.4.0'
       # Windows: Use vanilla pytest (riot doesn't support Windows - see https://github.com/DataDog/riot/issues/74)
       - name: Run tests (Windows - direct pytest)
         if: runner.os == 'Windows'

{ddapm_test_agent-1.36.0 → ddapm_test_agent-1.38.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ddapm-test-agent
-Version: 1.36.0
+Version: 1.38.0
 Summary: Test agent for Datadog APM client libraries
 Home-page: https://github.com/Datadog/dd-apm-test-agent
 Author: Kyle Verhoog
@@ -20,14 +20,15 @@ Requires-Dist: msgpack
 Requires-Dist: requests
 Requires-Dist: typing_extensions
 Requires-Dist: yarl
-Requires-Dist: vcrpy
 Requires-Dist: requests-aws4auth
+Requires-Dist: jinja2>=3.0.0
+Requires-Dist: pyyaml
 Requires-Dist: opentelemetry-proto<1.37.0,>1.33.0
 Requires-Dist: protobuf>=3.19.0
 Requires-Dist: grpcio<2.0,>=1.66.2
 Requires-Dist: pywin32; sys_platform == "win32"
 Provides-Extra: testing
-Requires-Dist: ddtrace==3.11.0; extra == "testing"
+Requires-Dist: ddtrace==3.15.0; extra == "testing"
 Requires-Dist: pytest; extra == "testing"
 Requires-Dist: riot==0.20.1; extra == "testing"
 Requires-Dist: PyYAML==6.0.3; extra == "testing"
@@ -67,8 +68,8 @@ The test agent can be installed from PyPI:
 
     pip install ddapm-test-agent
 
-    # HTTP on port 8126, OTLP HTTP on port 4318, OTLP GRPC on port 4317
-    ddapm-test-agent --port=8126 --otlp-http-port=4318 --otlp-grpc-port=4317
+    # HTTP on port 8126, OTLP HTTP on port 4318, OTLP GRPC on port 4317, with the web-ui enabled
+    ddapm-test-agent --port=8126 --otlp-http-port=4318 --otlp-grpc-port=4317 --web-ui-port=8080
 
 or from Docker:
 
@@ -171,6 +172,15 @@ The traces are normalized and output in JSON to a file. The following transforma
 - The span meta and metrics maps if empty are excluded.
 
 
+#### Web UI
+
+The test agent includes an optional and **experimental** Web UI that provides a dashboard for inspecting agent configuration, viewing received requests, exploring traces and snapshots, and managing tracer-flare and remote configuration.
+
+The UI can be enabled with the `--web-ui-port PORT` command-line argument or by setting the `WEB_UI_PORT` environment variable.
+Once enabled, the Web UI can be accessed at `http://localhost:PORT` (default port is `8080`).
+
+There is also a maximum number of requests to store in memory to display in the UI, which can be configured with the `--max-requests` command-line argument or by setting the `MAX_REQUESTS` environment variable (default is `200` requests).
+
 ### Recording 3rd party API requests
 
 The test agent can be configured to proxy requests to select provider API endpoints, capturing real requests to

{ddapm_test_agent-1.36.0 → ddapm_test_agent-1.38.0}/README.md

@@ -21,8 +21,8 @@ The test agent can be installed from PyPI:
 
     pip install ddapm-test-agent
 
-    # HTTP on port 8126, OTLP HTTP on port 4318, OTLP GRPC on port 4317
-    ddapm-test-agent --port=8126 --otlp-http-port=4318 --otlp-grpc-port=4317
+    # HTTP on port 8126, OTLP HTTP on port 4318, OTLP GRPC on port 4317, with the web-ui enabled
+    ddapm-test-agent --port=8126 --otlp-http-port=4318 --otlp-grpc-port=4317 --web-ui-port=8080
 
 or from Docker:
 
@@ -125,6 +125,15 @@ The traces are normalized and output in JSON to a file. The following transforma
 - The span meta and metrics maps if empty are excluded.
 
 
+#### Web UI
+
+The test agent includes an optional and **experimental** Web UI that provides a dashboard for inspecting agent configuration, viewing received requests, exploring traces and snapshots, and managing tracer-flare and remote configuration.
+
+The UI can be enabled with the `--web-ui-port PORT` command-line argument or by setting the `WEB_UI_PORT` environment variable.
+Once enabled, the Web UI can be accessed at `http://localhost:PORT` (default port is `8080`).
+
+There is also a maximum number of requests to store in memory to display in the UI, which can be configured with the `--max-requests` command-line argument or by setting the `MAX_REQUESTS` environment variable (default is `200` requests).
+
 ### Recording 3rd party API requests
 
 The test agent can be configured to proxy requests to select provider API endpoints, capturing real requests to

{ddapm_test_agent-1.36.0 → ddapm_test_agent-1.38.0}/ddapm_test_agent/agent.py

@@ -39,7 +39,9 @@ from aiohttp.web import middleware
 from grpc import aio as grpc_aio
 from msgpack.exceptions import ExtraData as MsgPackExtraDataException
 from multidict import CIMultiDict
+from opentelemetry.proto.collector.logs.v1.logs_service_pb2 import ExportLogsServiceResponse
 from opentelemetry.proto.collector.logs.v1.logs_service_pb2_grpc import add_LogsServiceServicer_to_server
+from opentelemetry.proto.collector.metrics.v1.metrics_service_pb2 import ExportMetricsServiceResponse
 from opentelemetry.proto.collector.metrics.v1.metrics_service_pb2_grpc import add_MetricsServiceServicer_to_server
 
 from . import _get_version
@@ -323,12 +325,14 @@ class Agent:
             "/v1.0/traces",
             "/v0.6/stats",
             "/v0.7/config",
+            "/info",
             "/telemetry/proxy/api/v2/apmtelemetry",
             "/v0.1/pipeline_stats",
             "/tracer_flare/v1",
             "/evp_proxy/v2/api/v2/llmobs",
             "/evp_proxy/v2/api/intake/llm-obs/v1/eval-metric",
             "/evp_proxy/v2/api/intake/llm-obs/v2/eval-metric",
+            "/evp_proxy/v2/api/v2/exposures",
             "/evp_proxy/v4/api/v2/errorsintake",
         ]
 
@@ -722,7 +726,9 @@ class Agent:
             num_resource_logs,
             total_log_records,
         )
-        return web.HTTPOk()
+        return web.Response(
+            body=ExportLogsServiceResponse().SerializeToString(), status=200, content_type="application/x-protobuf"
+        )
 
     async def handle_v1_metrics(self, request: Request) -> web.Response:
         metrics_data = self._decode_v1_metrics(request)
@@ -737,7 +743,9 @@ class Agent:
             num_resource_metrics,
             total_metrics,
         )
-        return web.HTTPOk()
+        return web.Response(
+            body=ExportMetricsServiceResponse().SerializeToString(), status=200, content_type="application/x-protobuf"
+        )
 
     async def handle_v07_remoteconfig(self, request: Request) -> web.Response:
         """Emulates Remote Config endpoint: /v0.7/config"""
@@ -802,6 +810,9 @@ class Agent:
     async def handle_evp_proxy_v2_llmobs_eval_metric(self, request: Request) -> web.Response:
         return web.HTTPOk()
 
+    async def handle_evp_proxy_v2_api_v2_exposures(self, request: Request) -> web.Response:
+        return web.HTTPOk()
+
     async def handle_evp_proxy_v4_api_v2_errorsintake(self, request: Request) -> web.Response:
         return web.HTTPOk()
 
@@ -1129,6 +1140,7 @@ class Agent:
                 self.handle_v1_tracer_flare,
                 self.handle_evp_proxy_v2_api_v2_llmobs,
                 self.handle_evp_proxy_v2_llmobs_eval_metric,
+                self.handle_evp_proxy_v2_api_v2_exposures,
                 self.handle_evp_proxy_v4_api_v2_errorsintake,
                 self.handle_v1_logs,
                 self.handle_v1_metrics,
@@ -1423,6 +1435,7 @@ class Agent:
                 "/evp_proxy/v2/api/v2/llmobs": self.handle_evp_proxy_v2_api_v2_llmobs,
                 "/evp_proxy/v2/api/intake/llm-obs/v1/eval-metric": self.handle_evp_proxy_v2_llmobs_eval_metric,
                 "/evp_proxy/v2/api/intake/llm-obs/v2/eval-metric": self.handle_evp_proxy_v2_llmobs_eval_metric,
+                "/evp_proxy/v2/api/v2/exposures": self.handle_evp_proxy_v2_api_v2_exposures,
                 "/evp_proxy/v4/api/v2/errorsintake": self.handle_evp_proxy_v4_api_v2_errorsintake,
                 "/info": self.handle_info,
                 # Test endpoints
@@ -1588,18 +1601,30 @@ def make_app(
     vcr_ci_mode: bool,
     vcr_provider_map: str,
     vcr_ignore_headers: str,
+    enable_web_ui: bool = False,
 ) -> web.Application:
     agent = Agent()
+
+    # Build middleware list conditionally
+    middlewares = []
+    if enable_web_ui:
+        from .web import request_response_capture_middleware
+
+        middlewares.append(request_response_capture_middleware)
+    middlewares.extend(
+        [
+            handle_exception_middleware,
+            agent.check_failure_middleware,
+            agent.store_request_middleware,
+            agent.request_forwarder_middleware,
+            session_token_middleware,
+            agent.vcr_proxy_suffix_middleware,
+        ]
+    )
+
     app = web.Application(
         client_max_size=int(100e6),  # 100MB - arbitrary
-        middlewares=[
-            handle_exception_middleware,  # type: ignore
-            agent.check_failure_middleware,  # type: ignore
-            agent.store_request_middleware,  # type: ignore
-            agent.request_forwarder_middleware,  # type: ignore
-            session_token_middleware,  # type: ignore
-            agent.vcr_proxy_suffix_middleware,  # type: ignore
-        ],
+        middlewares=middlewares,
     )
     app.add_routes(
         [
@@ -1622,6 +1647,7 @@ def make_app(
             web.post("/evp_proxy/v2/api/v2/llmobs", agent.handle_evp_proxy_v2_api_v2_llmobs),
             web.post("/evp_proxy/v2/api/intake/llm-obs/v1/eval-metric", agent.handle_evp_proxy_v2_llmobs_eval_metric),
             web.post("/evp_proxy/v2/api/intake/llm-obs/v2/eval-metric", agent.handle_evp_proxy_v2_llmobs_eval_metric),
+            web.post("/evp_proxy/v2/api/v2/exposures", agent.handle_evp_proxy_v2_api_v2_exposures),
             web.post("/evp_proxy/v4/api/v2/errorsintake", agent.handle_evp_proxy_v4_api_v2_errorsintake),
             web.get("/info", agent.handle_info),
             web.get("/test/session/start", agent.handle_session_start),
@@ -1972,6 +1998,18 @@ def main(args: Optional[List[str]] = None) -> None:
         default=os.environ.get("VCR_IGNORE_HEADERS", ""),
         help="Comma-separated list of headers to ignore when recording VCR cassettes.",
     )
+    parser.add_argument(
+        "--web-ui-port",
+        type=int,
+        default=int(os.environ.get("WEB_UI_PORT", 0)),
+        help="Port to serve the optional web UI (default: disabled). Example: --web-ui-port=8080",
+    )
+    parser.add_argument(
+        "--max-requests",
+        type=int,
+        default=int(os.environ.get("MAX_REQUESTS", 200)),
+        help="Maximum number of requests to keep in memory for the UI (default: 200). Older requests are discarded when limit is reached.",
+    )
     parsed_args = parser.parse_args(args=args)
     logging.basicConfig(level=parsed_args.log_level)
 
@@ -2018,6 +2056,7 @@ def main(args: Optional[List[str]] = None) -> None:
         vcr_ci_mode=parsed_args.vcr_ci_mode,
         vcr_provider_map=parsed_args.vcr_provider_map,
         vcr_ignore_headers=parsed_args.vcr_ignore_headers,
+        enable_web_ui=parsed_args.web_ui_port > 0,
     )
 
     # Validate port configuration
@@ -2027,6 +2066,13 @@ def main(args: Optional[List[str]] = None) -> None:
         raise ValueError("APM and OTLP GRPC ports cannot be the same")
     if parsed_args.otlp_http_port == parsed_args.otlp_grpc_port:
         raise ValueError("OTLP HTTP and GRPC ports cannot be the same")
+    if parsed_args.web_ui_port > 0:
+        if parsed_args.web_ui_port == parsed_args.port:
+            raise ValueError("Web UI and APM ports cannot be the same")
+        if parsed_args.web_ui_port == parsed_args.otlp_http_port:
+            raise ValueError("Web UI and OTLP HTTP ports cannot be the same")
+        if parsed_args.web_ui_port == parsed_args.otlp_grpc_port:
+            raise ValueError("Web UI and OTLP GRPC ports cannot be the same")
 
     # Get the shared agent instance from the main app
     agent = app["agent"]
@@ -2044,15 +2090,41 @@ def main(args: Optional[List[str]] = None) -> None:
 
     otlp_http_app = make_otlp_http_app(agent)
 
+    # Create Web UI app if enabled
+    web_ui_app = None
+    if parsed_args.web_ui_port > 0:
+        from .web import WebUI
+
+        # Pass configuration directly to WebUI
+        web_ui_config = {
+            "snapshot_dir": parsed_args.snapshot_dir,
+            "vcr_cassettes_directory": parsed_args.vcr_cassettes_directory,
+            "disable_error_responses": parsed_args.disable_error_responses,
+            "web_ui_port": parsed_args.web_ui_port,
+            "max_requests": parsed_args.max_requests,
+        }
+        web_ui = WebUI(agent, config=web_ui_config)
+        web_ui_app = web_ui.make_app()
+        # Store WebUI instance reference for middleware access
+        web_ui_app._webui_instance = web_ui
+        # Also store on main app for middleware access
+        app._webui_instance = web_ui
+
     async def run_servers():
         """Run APM and OTLP HTTP servers concurrently."""
-        # Create runners for both apps
+        # Create runners for apps
         apm_runner = web.AppRunner(app)
         await apm_runner.setup()
 
         otlp_http_runner = web.AppRunner(otlp_http_app)
         await otlp_http_runner.setup()
 
+        # Create Web UI runner if enabled
+        web_ui_runner = None
+        if web_ui_app is not None:
+            web_ui_runner = web.AppRunner(web_ui_app)
+            await web_ui_runner.setup()
+
         # Start GRPC server if available (async creation)
         otlp_grpc_server = await make_otlp_grpc_server_async(
             agent, parsed_args.otlp_http_port, parsed_args.otlp_grpc_port
@@ -2066,12 +2138,23 @@ def main(args: Optional[List[str]] = None) -> None:
 
         otlp_http_site = web.TCPSite(otlp_http_runner, port=parsed_args.otlp_http_port)
 
-        # Start both servers concurrently
-        await asyncio.gather(apm_site.start(), otlp_http_site.start())
+        # Create Web UI site if enabled
+        web_ui_site = None
+        if web_ui_runner is not None:
+            web_ui_site = web.TCPSite(web_ui_runner, port=parsed_args.web_ui_port)
+
+        # Start servers concurrently
+        sites_to_start = [apm_site.start(), otlp_http_site.start()]
+        if web_ui_site is not None:
+            sites_to_start.append(web_ui_site.start())
+
+        await asyncio.gather(*sites_to_start)
 
         print(f"======== Running APM server on port {parsed_args.port} ========")
         print(f"======== Running OTLP HTTP server on port {parsed_args.otlp_http_port} ========")
         print(f"======== Running OTLP GRPC server on port {parsed_args.otlp_grpc_port} ========")
+        if web_ui_site is not None:
+            print(f"======== Running Web UI on port {parsed_args.web_ui_port} ========")
         print("(Press CTRL+C to quit)")
 
         try:
@@ -2082,6 +2165,8 @@ def main(args: Optional[List[str]] = None) -> None:
         finally:
             await apm_runner.cleanup()
             await otlp_http_runner.cleanup()
+            if web_ui_runner is not None:
+                await web_ui_runner.cleanup()
             await otlp_grpc_server.stop(grace=5.0)
 
     # Run the servers

{ddapm_test_agent-1.36.0 → ddapm_test_agent-1.38.0}/ddapm_test_agent/remoteconfig.py

@@ -26,7 +26,7 @@ class RemoteConfigServer:
         self._update_response(token, data)
 
     @staticmethod
-    def _build_config_path_response(path: str, msg: str) -> Dict[str, Any]:
+    def _build_config_path_response(path: str, msg: Any) -> Dict[str, Any]:
         expires_date = datetime.datetime.strftime(
             datetime.datetime.now() + datetime.timedelta(days=1), "%Y-%m-%dT%H:%M:%SZ"
         )
@@ -84,7 +84,7 @@ class RemoteConfigServer:
         }
         return remote_config_payload
 
-    def create_config_path_response(self, token: Optional[str], path: str, msg: str) -> None:
+    def create_config_path_response(self, token: Optional[str], path: str, msg: Any) -> None:
         remote_config_payload = self._build_config_path_response(path, msg)
         self.create_config_response(token, remote_config_payload)