ref(db)!: Drop record_sql_params experiment and legacy send_default_pii fallback (#7821)

`record_sql_queries` now reads only
`data_collection.database_query_data` to
decide whether to record query params, and the
`_experiments["record_sql_params"]`
option is removed.

Tests that relied on the experiment now opt in with
`data_collection={"database_query_data": True}`.

Also removes `record_params` options in the aiomysql and asyncpg
integrations.

Refs PY-2798
Refs #7566

Author: ericapisani

MIGRATION_GUIDE.md

@@ -163,6 +163,8 @@ Looking to upgrade from Sentry SDK 2.x to 3.x? Here's a comprehensive list of wh
 - The `trace_ignore_status_codes` option was removed.
 - `add_attachment` no longer accepts an `add_to_transactions` argument.
 - The `stream_gen_ai_spans` option was removed. All spans are streamed now.
+- The experimental `record_sql_params` option was removed. Use the `database_query_data` setting of `data_collection` instead.
+- The `record_params` option of `AsyncPGIntegration` and `AioMySQLIntegration` was removed. Use the `database_query_data` setting of `data_collection` instead.
 
 
 ## Deprecated

sentry_sdk/consts.py

@@ -65,7 +65,6 @@ class CompressionAlgo(Enum):
         "Experiments",
         {
             "max_flags": Optional[int],
-            "record_sql_params": Optional[bool],
             "continuous_profiling_auto_start": Optional[bool],
             "transport_zlib_compression_level": Optional[int],
             "transport_compression_level": Optional[int],

sentry_sdk/integrations/aiomysql.py

@@ -13,7 +13,6 @@
 )
 from sentry_sdk.utils import (
     capture_internal_exceptions,
-    has_data_collection_enabled,
     parse_version,
 )
 
@@ -28,10 +27,6 @@
 class AioMySQLIntegration(Integration):
     identifier = "aiomysql"
     origin = f"auto.db.{identifier}"
-    _record_params = False
-
-    def __init__(self, *, record_params: bool = False):
-        AioMySQLIntegration._record_params = record_params
 
     @staticmethod
     def setup_once() -> None:
@@ -84,12 +79,7 @@ async def _inner(*args: Any, **kwargs: Any) -> T:
         integration = sentry_sdk.get_client().get_integration(AioMySQLIntegration)
 
         client = sentry_sdk.get_client()
-        should_record_params = False
-        if has_data_collection_enabled(client.options):
-            if client.options["data_collection"]["database_query_data"]:
-                should_record_params = True
-        else:
-            should_record_params = integration._record_params if integration else False
+        should_record_params = client.options["data_collection"]["database_query_data"]
 
         params_list = params if integration and should_record_params else None
         param_style = "pyformat" if params_list else None
@@ -134,12 +124,7 @@ async def _inner(*args: Any, **kwargs: Any) -> T:
 
         integration = sentry_sdk.get_client().get_integration(AioMySQLIntegration)
         client = sentry_sdk.get_client()
-        should_record_params = False
-        if has_data_collection_enabled(client.options):
-            if client.options["data_collection"]["database_query_data"]:
-                should_record_params = True
-        else:
-            should_record_params = integration._record_params if integration else False
+        should_record_params = client.options["data_collection"]["database_query_data"]
 
         params_list = seq_of_params if integration and should_record_params else None
         param_style = "pyformat" if params_list else None

sentry_sdk/integrations/asyncpg.py

@@ -32,10 +32,6 @@
 class AsyncPGIntegration(Integration):
     identifier = "asyncpg"
     origin = f"auto.db.{identifier}"
-    _record_params = False
-
-    def __init__(self, *, record_params: bool = False):
-        AsyncPGIntegration._record_params = record_params
 
     @staticmethod
     def setup_once() -> None:
@@ -114,7 +110,10 @@ def _record(
 ) -> "Iterator[Span]":
     client = sentry_sdk.get_client()
     integration = client.get_integration(AsyncPGIntegration)
-    if integration is not None and not integration._record_params:
+    if (
+        integration is not None
+        and not client.options["data_collection"]["database_query_data"]
+    ):
         params_list = None
 
     param_style = "pyformat" if params_list else None

sentry_sdk/tracing_utils.py

@@ -124,27 +124,15 @@ def record_sql_queries(
 ) -> "Generator[sentry_sdk.traces.Span, None, None]":
     # TODO: Bring back capturing of params by default
     client = sentry_sdk.get_client()
-    if has_data_collection_enabled(client.options):
-        if client.options["data_collection"]["database_query_data"]:
-            if not params_list or params_list == [None]:
-                params_list = None
-
-            if paramstyle == "pyformat":
-                paramstyle = "format"
-        else:
+    if client.options["data_collection"]["database_query_data"]:
+        if not params_list or params_list == [None]:
             params_list = None
-            paramstyle = None
-    else:
-        # TODO: remove this else block once data collection is released
-        if client.options["_experiments"].get("record_sql_params", False):
-            if not params_list or params_list == [None]:
-                params_list = None
 
-            if paramstyle == "pyformat":
-                paramstyle = "format"
-        else:
-            params_list = None
-            paramstyle = None
+        if paramstyle == "pyformat":
+            paramstyle = "format"
+    else:
+        params_list = None
+        paramstyle = None
 
     query = _format_sql(cursor, query)
 

tests/integrations/aiomysql/test_aiomysql.py

@@ -102,7 +102,7 @@ def _connect_args():
 async def test_connect(sentry_init, capture_events) -> None:
     sentry_init(
         integrations=[AioMySQLIntegration()],
-        _experiments={"record_sql_params": True},
+        data_collection={"database_query_data": True},
     )
     events = capture_events()
 
@@ -123,7 +123,7 @@ async def test_connect(sentry_init, capture_events) -> None:
 async def test_execute(sentry_init, capture_events) -> None:
     sentry_init(
         integrations=[AioMySQLIntegration()],
-        _experiments={"record_sql_params": True},
+        data_collection={"database_query_data": True},
     )
     events = capture_events()
 
@@ -160,13 +160,19 @@ async def test_execute(sentry_init, capture_events) -> None:
         },
         {
             "category": "query",
-            "data": {},
+            "data": {
+                "db.params": ["Bob", "secret_pw", "datetime.date(1984, 3, 1)"],
+                "db.paramstyle": "format",
+            },
             "message": "INSERT INTO users(name, password, dob) VALUES (%s, %s, %s)",
             "type": "default",
         },
         {
             "category": "query",
-            "data": {},
+            "data": {
+                "db.params": ["Bob"],
+                "db.paramstyle": "format",
+            },
             "message": "SELECT * FROM users WHERE name = %s",
             "type": "default",
         },
@@ -177,7 +183,6 @@ async def test_execute(sentry_init, capture_events) -> None:
 async def test_execute_many(sentry_init, capture_events) -> None:
     sentry_init(
         integrations=[AioMySQLIntegration()],
-        _experiments={"record_sql_params": True},
     )
     events = capture_events()
 
@@ -260,47 +265,6 @@ async def test_execute_many_record_params_with_data_collection_enabled(
     ]
 
 
-@pytest.mark.asyncio
-async def test_execute_many_record_params_with_data_collection_disabled(
-    sentry_init, capture_events
-) -> None:
-    sentry_init(
-        integrations=[AioMySQLIntegration(record_params=True)],
-        data_collection={"database_query_data": False},
-    )
-    events = capture_events()
-
-    conn = await aiomysql.connect(**_connect_args())
-
-    async with conn.cursor() as cur:
-        await cur.executemany(
-            "INSERT INTO users(name, password, dob) VALUES (%s, %s, %s)",
-            [
-                ("Bob", "secret_pw", datetime.date(1984, 3, 1)),
-                ("Alice", "pw", datetime.date(1990, 12, 25)),
-            ],
-        )
-
-    conn.close()
-
-    capture_message("hi")
-
-    (event,) = events
-
-    for crumb in event["breadcrumbs"]["values"]:
-        del crumb["timestamp"]
-
-    assert event["breadcrumbs"]["values"] == [
-        CRUMBS_CONNECT,
-        {
-            "category": "query",
-            "data": {"db.executemany": True},
-            "message": "INSERT INTO users(name, password, dob) VALUES (%s, %s, %s)",
-            "type": "default",
-        },
-    ]
-
-
 @pytest.mark.asyncio
 async def test_execute_many_record_params_with_data_collection_default(
     sentry_init, capture_events
@@ -354,7 +318,7 @@ async def test_execute_many_non_insert(sentry_init, capture_events) -> None:
     """Test executemany with non-INSERT queries (falls back to row-by-row)."""
     sentry_init(
         integrations=[AioMySQLIntegration()],
-        _experiments={"record_sql_params": True},
+        data_collection={"database_query_data": True},
     )
     events = capture_events()
 
@@ -400,48 +364,7 @@ async def test_execute_many_non_insert(sentry_init, capture_events) -> None:
 
 
 @pytest.mark.asyncio
-async def test_record_params(sentry_init, capture_events) -> None:
-    sentry_init(
-        integrations=[AioMySQLIntegration(record_params=True)],
-        _experiments={"record_sql_params": True},
-    )
-    events = capture_events()
-
-    conn = await aiomysql.connect(**_connect_args())
-
-    async with conn.cursor() as cur:
-        await cur.execute(
-            "INSERT INTO users(name, password, dob) VALUES (%s, %s, %s)",
-            ("Bob", "secret_pw", datetime.date(1984, 3, 1)),
-        )
-
-    conn.close()
-
-    capture_message("hi")
-
-    (event,) = events
-
-    for crumb in event["breadcrumbs"]["values"]:
-        del crumb["timestamp"]
-
-    assert event["breadcrumbs"]["values"] == [
-        CRUMBS_CONNECT,
-        {
-            "category": "query",
-            "data": {
-                "db.params": ["Bob", "secret_pw", "datetime.date(1984, 3, 1)"],
-                "db.paramstyle": "format",
-            },
-            "message": "INSERT INTO users(name, password, dob) VALUES (%s, %s, %s)",
-            "type": "default",
-        },
-    ]
-
-
-@pytest.mark.asyncio
-async def test_execute_record_params_with_data_collection_enabled(
-    sentry_init, capture_events
-) -> None:
+async def test_execute_record_params(sentry_init, capture_events) -> None:
     sentry_init(
         integrations=[AioMySQLIntegration()],
         data_collection={"database_query_data": True},
@@ -479,44 +402,6 @@ async def test_execute_record_params_with_data_collection_enabled(
     ]
 
 
-@pytest.mark.asyncio
-async def test_execute_record_params_with_data_collection_disabled(
-    sentry_init, capture_events
-) -> None:
-    sentry_init(
-        integrations=[AioMySQLIntegration(record_params=True)],
-        data_collection={"database_query_data": False},
-    )
-    events = capture_events()
-
-    conn = await aiomysql.connect(**_connect_args())
-
-    async with conn.cursor() as cur:
-        await cur.execute(
-            "INSERT INTO users(name, password, dob) VALUES (%s, %s, %s)",
-            ("Bob", "secret_pw", datetime.date(1984, 3, 1)),
-        )
-
-    conn.close()
-
-    capture_message("hi")
-
-    (event,) = events
-
-    for crumb in event["breadcrumbs"]["values"]:
-        del crumb["timestamp"]
-
-    assert event["breadcrumbs"]["values"] == [
-        CRUMBS_CONNECT,
-        {
-            "category": "query",
-            "data": {},
-            "message": "INSERT INTO users(name, password, dob) VALUES (%s, %s, %s)",
-            "type": "default",
-        },
-    ]
-
-
 @pytest.mark.asyncio
 async def test_execute_record_params_with_data_collection_default(
     sentry_init, capture_events
@@ -562,7 +447,7 @@ async def test_execute_record_params_with_data_collection_default(
 async def test_cursor_context_manager(sentry_init, capture_events) -> None:
     sentry_init(
         integrations=[AioMySQLIntegration()],
-        _experiments={"record_sql_params": True},
+        data_collection={"database_query_data": True},
     )
     events = capture_events()
 
@@ -604,7 +489,7 @@ async def test_cursor_context_manager(sentry_init, capture_events) -> None:
 async def test_cursor_async_iteration(sentry_init, capture_events) -> None:
     sentry_init(
         integrations=[AioMySQLIntegration()],
-        _experiments={"record_sql_params": True},
+        data_collection={"database_query_data": True},
     )
     events = capture_events()
 
@@ -637,7 +522,7 @@ async def test_cursor_async_iteration(sentry_init, capture_events) -> None:
 async def test_connection_pool(sentry_init, capture_events) -> None:
     sentry_init(
         integrations=[AioMySQLIntegration()],
-        _experiments={"record_sql_params": True},
+        data_collection={"database_query_data": True},
     )
     events = capture_events()