feat: Enable HTTP request code origin by default (#4967)

Set the `enable_http_request_source` option to `True` by default.

Author: alexander-alderman-webb

sentry_sdk/consts.py

@@ -909,7 +909,7 @@ def __init__(
         error_sampler=None,  # type: Optional[Callable[[Event, Hint], Union[float, bool]]]
         enable_db_query_source=True,  # type: bool
         db_query_source_threshold_ms=100,  # type: int
-        enable_http_request_source=False,  # type: bool
+        enable_http_request_source=True,  # type: bool
         http_request_source_threshold_ms=100,  # type: int
         spotlight=None,  # type: Optional[Union[bool, str]]
         cert_file=None,  # type: Optional[str]

sentry_sdk/tracing_utils.py

@@ -330,7 +330,7 @@ def add_http_request_source(span):
     if span.timestamp is None or span.start_timestamp is None:
         return
 
-    should_add_request_source = client.options.get("enable_http_request_source", False)
+    should_add_request_source = client.options.get("enable_http_request_source", True)
     if not should_add_request_source:
         return
 

tests/integrations/aiohttp/test_aiohttp.py

@@ -637,23 +637,19 @@ async def handler(request):
 
 
 @pytest.mark.asyncio
-@pytest.mark.parametrize("enable_http_request_source", [None, False])
 async def test_request_source_disabled(
     sentry_init,
     aiohttp_raw_server,
     aiohttp_client,
     capture_events,
-    enable_http_request_source,
 ):
     sentry_options = {
         "integrations": [AioHttpIntegration()],
         "traces_sample_rate": 1.0,
+        "enable_http_request_source": False,
         "http_request_source_threshold_ms": 0,
     }
 
-    if enable_http_request_source is not None:
-        sentry_options["enable_http_request_source"] = enable_http_request_source
-
     sentry_init(**sentry_options)
 
     # server for making span request
@@ -689,18 +685,21 @@ async def hello(request):
 
 
 @pytest.mark.asyncio
+@pytest.mark.parametrize("enable_http_request_source", [None, True])
 async def test_request_source_enabled(
     sentry_init,
     aiohttp_raw_server,
     aiohttp_client,
     capture_events,
+    enable_http_request_source,
 ):
     sentry_options = {
         "integrations": [AioHttpIntegration()],
         "traces_sample_rate": 1.0,
-        "enable_http_request_source": True,
         "http_request_source_threshold_ms": 0,
     }
+    if enable_http_request_source is not None:
+        sentry_options["enable_http_request_source"] = enable_http_request_source
 
     sentry_init(**sentry_options)
 

tests/integrations/httpx/test_httpx.py

@@ -396,22 +396,18 @@ def test_omit_url_data_if_parsing_fails(sentry_init, capture_events, httpx_mock)
     assert SPANDATA.HTTP_QUERY not in event["breadcrumbs"]["values"][0]["data"]
 
 
-@pytest.mark.parametrize("enable_http_request_source", [None, False])
 @pytest.mark.parametrize(
     "httpx_client",
     (httpx.Client(), httpx.AsyncClient()),
 )
-def test_request_source_disabled(
-    sentry_init, capture_events, enable_http_request_source, httpx_client, httpx_mock
-):
+def test_request_source_disabled(sentry_init, capture_events, httpx_client, httpx_mock):
     httpx_mock.add_response()
     sentry_options = {
         "integrations": [HttpxIntegration()],
         "traces_sample_rate": 1.0,
+        "enable_http_request_source": False,
         "http_request_source_threshold_ms": 0,
     }
-    if enable_http_request_source is not None:
-        sentry_options["enable_http_request_source"] = enable_http_request_source
 
     sentry_init(**sentry_options)
 
@@ -438,18 +434,23 @@ def test_request_source_disabled(
     assert SPANDATA.CODE_FUNCTION not in data
 
 
+@pytest.mark.parametrize("enable_http_request_source", [None, True])
 @pytest.mark.parametrize(
     "httpx_client",
     (httpx.Client(), httpx.AsyncClient()),
 )
-def test_request_source_enabled(sentry_init, capture_events, httpx_client, httpx_mock):
+def test_request_source_enabled(
+    sentry_init, capture_events, enable_http_request_source, httpx_client, httpx_mock
+):
     httpx_mock.add_response()
     sentry_options = {
         "integrations": [HttpxIntegration()],
         "traces_sample_rate": 1.0,
-        "enable_http_request_source": True,
         "http_request_source_threshold_ms": 0,
     }
+    if enable_http_request_source is not None:
+        sentry_options["enable_http_request_source"] = enable_http_request_source
+
     sentry_init(**sentry_options)
 
     events = capture_events()

tests/integrations/stdlib/test_httplib.py

@@ -376,16 +376,12 @@ def test_option_trace_propagation_targets(
             assert "baggage" not in request_headers
 
 
-@pytest.mark.parametrize("enable_http_request_source", [None, False])
-def test_request_source_disabled(
-    sentry_init, capture_events, enable_http_request_source
-):
+def test_request_source_disabled(sentry_init, capture_events):
     sentry_options = {
         "traces_sample_rate": 1.0,
+        "enable_http_request_source": False,
         "http_request_source_threshold_ms": 0,
     }
-    if enable_http_request_source is not None:
-        sentry_options["enable_http_request_source"] = enable_http_request_source
 
     sentry_init(**sentry_options)
 
@@ -409,12 +405,17 @@ def test_request_source_disabled(
     assert SPANDATA.CODE_FUNCTION not in data
 
 
-def test_request_source_enabled(sentry_init, capture_events):
+@pytest.mark.parametrize("enable_http_request_source", [None, True])
+def test_request_source_enabled(
+    sentry_init, capture_events, enable_http_request_source
+):
     sentry_options = {
         "traces_sample_rate": 1.0,
-        "enable_http_request_source": True,
         "http_request_source_threshold_ms": 0,
     }
+    if enable_http_request_source is not None:
+        sentry_options["enable_http_request_source"] = enable_http_request_source
+
     sentry_init(**sentry_options)
 
     events = capture_events()