aiohttp-client: add support for OTEL_PYTHON_EXCLUDED_URLS / OTEL_PYTHON_HTTPX_EXCLUDED_URLS

Author: xrmx

instrumentation/opentelemetry-instrumentation-aiohttp-client/src/opentelemetry/instrumentation/aiohttp_client/__init__.py

@@ -135,7 +135,11 @@ def response_hook(span: Span, params: typing.Union[
 )
 from opentelemetry.trace import Span, SpanKind, TracerProvider, get_tracer
 from opentelemetry.trace.status import Status, StatusCode
-from opentelemetry.util.http import redact_url, sanitize_method
+from opentelemetry.util.http import (
+    get_excluded_urls,
+    redact_url,
+    sanitize_method,
+)
 
 _UrlFilterT = typing.Optional[typing.Callable[[yarl.URL], str]]
 _RequestHookT = typing.Optional[
@@ -271,6 +275,8 @@ def create_trace_config(
 
     metric_attributes = {}
 
+    excluded_urls = get_excluded_urls("AIOHTTP_CLIENT")
+
     def _end_trace(trace_config_ctx: types.SimpleNamespace):
         elapsed_time = max(default_timer() - trace_config_ctx.start_time, 0)
         if trace_config_ctx.token:
@@ -304,7 +310,10 @@ async def on_request_start(
         trace_config_ctx: types.SimpleNamespace,
         params: aiohttp.TraceRequestStartParams,
     ):
-        if not is_instrumentation_enabled():
+        if (
+            not is_instrumentation_enabled()
+            or trace_config_ctx.excluded_urls.url_disabled(str(params.url))
+        ):
             trace_config_ctx.span = None
             return
 
@@ -426,6 +435,7 @@ def _trace_config_ctx_factory(**kwargs):
             start_time=start_time,
             duration_histogram_old=duration_histogram_old,
             duration_histogram_new=duration_histogram_new,
+            excluded_urls=excluded_urls,
             **kwargs,
         )
 

instrumentation/opentelemetry-instrumentation-aiohttp-client/tests/test_aiohttp_client_integration.py

@@ -16,6 +16,7 @@
 
 import asyncio
 import contextlib
+import os
 import typing
 import unittest
 import urllib.parse
@@ -803,6 +804,24 @@ async def do_request(url):
         )
         self.memory_exporter.clear()
 
+    @mock.patch.dict(
+        os.environ, {"OTEL_PYTHON_AIOHTTP_CLIENT_EXCLUDED_URLS": "/some/path"}
+    )
+    def test_ignores_excluded_urls(self):
+        async def request_handler(request):
+            assert "traceparent" not in request.headers
+            return aiohttp.web.Response(status=HTTPStatus.OK)
+
+        host, port = self._http_request(
+            trace_config=aiohttp_client.create_trace_config(),
+            request_handler=request_handler,
+            url="/some/path?query=param&other=param2",
+            status_code=HTTPStatus.OK,
+        )
+
+        self._assert_spans([], 0)
+        self._assert_metrics(0)
+
 
 class TestAioHttpClientInstrumentor(TestBase):
     URL = "/test-path"
@@ -1115,6 +1134,21 @@ def response_hook(
         self.assertIn("response_hook_attr", span.attributes)
         self.assertEqual(span.attributes["response_hook_attr"], "value")
 
+    @mock.patch.dict(
+        os.environ, {"OTEL_PYTHON_AIOHTTP_CLIENT_EXCLUDED_URLS": "/test-path"}
+    )
+    def test_ignores_excluded_urls(self):
+        # need the env var set at instrument time
+        AioHttpClientInstrumentor().uninstrument()
+        AioHttpClientInstrumentor().instrument()
+
+        url = "/test-path?query=params"
+        host, port = run_with_test_server(
+            self.get_default_request(url), url, self.default_handler
+        )
+        self._assert_spans(0)
+        self._assert_metrics(0)
+
 
 class TestLoadingAioHttpInstrumentor(unittest.TestCase):
     def test_loading_instrumentor(self):