ref(client)!: Remove EventScrubber and the event_scrubber option (#7772)

`data_collection` is now the default way to control what data the SDK
collects, so the always-on `EventScrubber` is no longer needed. The
expectation is that, if people need to filter out request bodies, etc.,
that they use the `before_send` callback.

Removes `sentry_sdk.scrubber` (`EventScrubber`, `DEFAULT_DENYLIST`,
`DEFAULT_PII_DENYLIST`), the scrubbing step in `_prepare_event`, and the
`event_scrubber` init option. Passing `event_scrubber=` to `init` now
raises a `TypeError`.

Refs PY-2798
Refs #7566

Author: ericapisani

docs/apidocs.rst

@@ -35,9 +35,6 @@ API Docs
 .. autoclass:: sentry_sdk.attachments.Attachment
    :members:
 
-.. autoclass:: sentry_sdk.scrubber.EventScrubber
-   :members:
-
 .. autoclass:: sentry_sdk.monitor.Monitor
    :members:
 

sentry_sdk/client.py

@@ -27,7 +27,6 @@
 from sentry_sdk.integrations.dedupe import DedupeIntegration
 from sentry_sdk.monitor import Monitor
 from sentry_sdk.profiler.continuous_profiler import setup_continuous_profiler
-from sentry_sdk.scrubber import EventScrubber
 from sentry_sdk.serializer import serialize
 from sentry_sdk.sessions import SessionFlusher
 from sentry_sdk.traces import Span, trace
@@ -49,7 +48,6 @@
     get_sdk_name,
     get_type_name,
     handle_in_app,
-    has_data_collection_enabled,
     logger,
 )
 
@@ -132,20 +130,6 @@ def _get_options(*args: "Optional[str]", **kwargs: "Any") -> "Dict[str, Any]":
 
     rv["data_collection"] = _resolve_data_collection(rv)
 
-    # Do not add the event scrubber if data collection is enabled as it can remove data that's
-    # collected under data collection config
-    if not has_data_collection_enabled(rv) and rv["event_scrubber"] is None:
-        rv["event_scrubber"] = EventScrubber(
-            send_default_pii=False
-            if rv["send_default_pii"] is None
-            else rv["send_default_pii"]
-        )
-    elif has_data_collection_enabled(rv) and rv["event_scrubber"]:
-        logger.warning(
-            "Event scrubbers are not enabled when data collection configuration is provided. Ignoring event_scrubber...",
-        )
-        rv["event_scrubber"] = None
-
     if rv["socket_options"] and not isinstance(rv["socket_options"], list):
         logger.warning(
             "Ignoring socket_options because of unexpected format. See urllib3.HTTPConnection.socket_options for the expected format."
@@ -571,11 +555,6 @@ def _prepare_event(
             self.options["project_root"],
         )
 
-        if event is not None:
-            event_scrubber = self.options["event_scrubber"]
-            if event_scrubber:
-                event_scrubber.scrub_event(event)
-
         if previous_total_breadcrumbs is not None:
             event["breadcrumbs"] = AnnotatedValue(
                 event.get("breadcrumbs", {"values": []}),

sentry_sdk/consts.py

@@ -1365,7 +1365,6 @@ def __init__(
             MATCH_ALL
         ],
         functions_to_trace: "Sequence[Dict[str, str]]" = [],  # noqa: B006
-        event_scrubber: "Optional[sentry_sdk.scrubber.EventScrubber]" = None,
         max_value_length: "Optional[int]" = DEFAULT_MAX_VALUE_LENGTH,
         enable_backpressure_handling: bool = True,
         error_sampler: "Optional[Callable[[Event, Hint], Union[float, bool]]]" = None,
@@ -1498,13 +1497,6 @@ def __init__(
 
             See https://docs.sentry.io/platforms/python/configuration/options/#data_collection for more details.
 
-        :param event_scrubber: Scrubs the event payload for sensitive information such as cookies, sessions, and
-            passwords from a `denylist`.
-
-            It can additionally be used to scrub from another `pii_denylist` if `send_default_pii` is disabled.
-
-            See how to `configure the scrubber here <https://docs.sentry.io/data-management/sensitive-data/#event-scrubber>`_.
-
         :param include_source_context: When enabled, source context will be included in events sent to Sentry.
 
             This source context includes the five lines of code above and below the line of code where an error

sentry_sdk/scrubber.py

@@ -190,7 +190,8 @@ async def test_formdata_request_body(sentry_init, capture_items):
     (event,) = (item.payload for item in items if item.type == "event")
     assert event["request"]["data"].keys() == PARSED_FORM.keys()
     assert event["request"]["data"]["username"] == PARSED_FORM["username"]
-    assert event["request"]["data"]["password"] == "[Filtered]"
+    # Expectation in data collection is that the user scrubs this within `before_send`
+    assert event["request"]["data"]["password"] == "hello123"
     assert event["request"]["data"]["photo"] == ""
 
     sentry_sdk.flush()
@@ -491,7 +492,8 @@ async def _error(request: Request):
     )
 
     event = events[0]
-    assert event["request"]["data"] == {"password": "[Filtered]"}
+    # Expectation in data collection is that the user scrubs this within `before_send`
+    assert event["request"]["data"] == {"password": "secret"}
     assert event["request"]["headers"]["authorization"] == "[Filtered]"
     assert event["request"]["headers"]["proxy-authorization"] == "[Filtered]"
 

tests/integrations/fastapi/test_fastapi.py

@@ -939,13 +939,17 @@ def index():
         assert response.data == b"hi"
 
 
-def test_request_not_modified_by_reference(sentry_init, capture_events, app):
+def test_request_not_modified_by_reference(
+    sentry_init, capture_events, app, monkeypatch
+):
     sentry_init(
         integrations=[
             flask_sentry.FlaskIntegration(),
             LoggingIntegration(event_level=logging.ERROR),
-        ]
+        ],
+        data_collection={},
     )
+    monkeypatch.setattr(flask_sentry, "flask_login", None)
 
     @app.route("/", methods=["POST"])
     def index():
@@ -969,7 +973,9 @@ def index():
 
     (event,) = events
 
-    assert event["request"]["data"]["password"] == "[Filtered]"
+    # In data collection, request bodies need to be handled in the before_send
+    # callback, so it's expected that the event will contain the raw value.
+    assert event["request"]["data"]["password"] == "ohno"
     assert event["request"]["headers"]["Authorization"] == "[Filtered]"
     assert event["request"]["headers"]["Proxy-Authorization"] == "[Filtered]"
 

tests/integrations/flask/test_flask.py

@@ -1404,7 +1404,8 @@ async def _error(request):
     )
 
     event = events[0]
-    assert event["request"]["data"] == {"password": "[Filtered]"}
+    # Expectation in data collection is that the user scrubs this within `before_send`
+    assert event["request"]["data"] == {"password": "ohno"}
     assert event["request"]["headers"]["authorization"] == "[Filtered]"
     assert event["request"]["headers"]["proxy-authorization"] == "[Filtered]"
 

tests/integrations/starlette/test_starlette.py

@@ -77,10 +77,7 @@ def get(self):
 
 # Sent by every data-collection cookie test below. Mixes benign cookies
 # (``theme``, ``lang``) with ones whose names match the data-collection
-# sensitive denylist (``jwt``, ``identity``). Those two names are deliberately
-# NOT in the ``EventScrubber`` denylist (which matches keys exactly), so any
-# filtering we observe on them comes from the extractor's data-collection
-# logic, not the always-on scrubber.
+# sensitive denylist (``jwt``, ``identity``).
 COOKIE_HEADER = "jwt=tokenval; theme=dark; lang=en; identity=alice"