feat(data-collection): add queues option to data collection config (#6770)

Add a `queues` boolean to the data collection spec, gated by
send_default_pii like other PII-bearing fields.

Depends on getsentry/sentry-docs#18637 and the
outcome of discussions there.

Fixes PY-2679
Fixes #6739

---

<sub>Stack created with <a
href="https://github.com/github/gh-stack">GitHub Stacks CLI</a> • <a
href="https://gh.io/stacks-feedback">Give Feedback 💬</a></sub>

Author: ericapisani

sentry_sdk/_types.py

@@ -193,6 +193,7 @@ class DataCollectionUserOptions(TypedDict, total=False):
         graphql: "GraphQLCollectionUserOptions"
         gen_ai: "GenAICollectionUserOptions"
         database: "DatabaseCollectionUserOptions"
+        queues: bool
         stack_frame_variables: bool
         frame_context_lines: int
 
@@ -206,6 +207,7 @@ class DataCollection(TypedDict):
         graphql: "GraphQLCollectionBehaviour"
         gen_ai: "GenAICollectionBehaviour"
         database: "DatabaseCollectionBehaviour"
+        queues: bool
         stack_frame_variables: bool
         frame_context_lines: int
 

sentry_sdk/data_collection.py

@@ -108,6 +108,7 @@ def _map_from_send_default_pii(
         "graphql": {"document": send_default_pii, "variables": send_default_pii},
         "gen_ai": {"inputs": send_default_pii, "outputs": send_default_pii},
         "database": {"query_params": send_default_pii},
+        "queues": send_default_pii,
         "stack_frame_variables": include_local_variables,
         "frame_context_lines": (
             _DEFAULT_FRAME_CONTEXT_LINES if include_source_context else 0
@@ -157,6 +158,7 @@ def _resolve_explicit(
         "graphql": _graphql_from_value(d.get("graphql") or {}),
         "gen_ai": _gen_ai_from_value(d.get("gen_ai") or {}),
         "database": _database_from_value(d.get("database") or {}),
+        "queues": d.get("queues", True),
         "stack_frame_variables": stack_frame_variables,
         "frame_context_lines": frame_context_lines,
     }

tests/test_data_collection.py

@@ -85,6 +85,7 @@ def _get(dc, path):
                 "query_params.mode": "off",
                 "http_headers.request.mode": "denylist",
                 "http_bodies": _ALL_HTTP_BODY_TYPES,
+                "queues": False,
                 "frame_context_lines": 5,
             },
             id="no_options_collects_no_pii",
@@ -97,12 +98,13 @@ def _get(dc, path):
                 "gen_ai.outputs": True,
                 "cookies.mode": "denylist",
                 "query_params.mode": "denylist",
+                "queues": True,
             },
             id="send_default_pii_true_collects_pii",
         ),
         pytest.param(
             {"send_default_pii": False},
-            {"user_info": False, "cookies.mode": "off"},
+            {"user_info": False, "cookies.mode": "off", "queues": False},
             id="send_default_pii_false_collects_no_pii",
         ),
         pytest.param(
@@ -114,6 +116,7 @@ def _get(dc, path):
                 "cookies.mode": "denylist",
                 "query_params.mode": "denylist",
                 "http_bodies": _ALL_HTTP_BODY_TYPES,
+                "queues": True,
             },
             id="explicit_data_collection_uses_spec_defaults",
         ),
@@ -193,17 +196,19 @@ def _get(dc, path):
                 "graphql.document": False,
                 "graphql.variables": False,
                 "database.query_params": False,
+                "queues": False,
             },
-            id="legacy_pii_off_gates_graphql_and_database",
+            id="legacy_pii_off_gates_graphql_database_and_queues",
         ),
         pytest.param(
             {"send_default_pii": True},
             {
                 "graphql.document": True,
                 "graphql.variables": True,
                 "database.query_params": True,
+                "queues": True,
             },
-            id="legacy_pii_on_collects_graphql_and_database",
+            id="legacy_pii_on_collects_graphql_database_and_queues",
         ),
         pytest.param(
             {"data_collection": {"graphql": {"variables": False}}},