feat(integrations): Gate user info behind data_collection config

sentry_sdk/integrations/aiohttp.py

@@ -165,6 +165,8 @@ async def sentry_app_handle(
                             )
 
                         url_attributes = {}
+                        client_address_attributes = {}
+
                         if has_data_collection_enabled(client.options):
                             url_attributes["url.full"] = "%s://%s%s" % (
                                 request.scheme,
@@ -188,6 +190,15 @@ async def sentry_app_handle(
                                         "?" + filtered_query_string
                                     )
 
+                            if request.remote:
+                                if client.options["data_collection"]["user_info"]:
+                                    client_address_attributes["client.address"] = (
+                                        request.remote
+                                    )
+                                    scope.set_attribute(
+                                        SPANDATA.USER_IP_ADDRESS, request.remote
+                                    )
+
                         elif should_send_default_pii():
                             url_full = "%s://%s%s" % (
                                 request.scheme,
@@ -201,12 +212,13 @@ async def sentry_app_handle(
                             url_attributes["url.full"] = url_full
                             url_attributes["url.path"] = request.path
 
-                        client_address_attributes = {}
-                        if should_send_default_pii() and request.remote:
-                            client_address_attributes["client.address"] = request.remote
-                            scope.set_attribute(
-                                SPANDATA.USER_IP_ADDRESS, request.remote
-                            )
+                            if request.remote:
+                                client_address_attributes["client.address"] = (
+                                    request.remote
+                                )
+                                scope.set_attribute(
+                                    SPANDATA.USER_IP_ADDRESS, request.remote
+                                )
 
                         span_ctx = sentry_sdk.traces.start_span(
                             # If this name makes it to the UI, AIOHTTP's URL

sentry_sdk/integrations/asgi.py

@@ -47,6 +47,7 @@
     _get_installed_modules,
     capture_internal_exceptions,
     event_from_exception,
+    has_data_collection_enabled,
     logger,
     nullcontext,
     qualname_from_function,
@@ -253,10 +254,17 @@ async def _run_app(
                             "network.protocol.name": ty,
                         }
 
-                        if scope.get("client") and should_send_default_pii():
-                            sentry_scope.set_attribute(
-                                SPANDATA.USER_IP_ADDRESS, _get_ip(scope)
-                            )
+                        if scope.get("client"):
+                            client_options = sentry_sdk.get_client().options
+                            if has_data_collection_enabled(client_options):
+                                if client_options["data_collection"]["user_info"]:
+                                    sentry_scope.set_attribute(
+                                        SPANDATA.USER_IP_ADDRESS, _get_ip(scope)
+                                    )
+                            elif should_send_default_pii():
+                                sentry_scope.set_attribute(
+                                    SPANDATA.USER_IP_ADDRESS, _get_ip(scope)
+                                )
 
                         if ty in ("http", "websocket"):
                             if (

sentry_sdk/integrations/aws_lambda.py

@@ -437,7 +437,23 @@
         if "headers" in aws_event:
             request["headers"] = _filter_headers(aws_event["headers"])
 
-        if should_send_default_pii():
+        client_options = sentry_sdk.get_client().options
+        if has_data_collection_enabled(client_options):
+            if client_options["data_collection"]["user_info"]:
+                user_info = sentry_event.setdefault("user", {})
+
+                identity = aws_event.get("identity")
+                if identity is None:
+                    identity = {}
+
+                id = identity.get("userArn")
+                if id is not None:
+                    user_info.setdefault("id", id)
+
+                ip = identity.get("sourceIp")
+                if ip is not None:
+                    user_info.setdefault("ip_address", ip)
+        elif should_send_default_pii():
             user_info = sentry_event.setdefault("user", {})
 
             identity = aws_event.get("identity")

sentry_sdk/integrations/django/__init__.py

@@ -30,6 +30,7 @@
     capture_internal_exceptions,
     ensure_integration_enabled,
     event_from_exception,
+    has_data_collection_enabled,
     logger,
     transaction_from_function,
     walk_exception_chain,
@@ -457,6 +458,39 @@ def _attempt_resolve_again(
     _set_transaction_name_and_source(scope, transaction_style, request)
 
 
+def _get_user_from_request_and_set_on_scope(request: "WSGIRequest") -> None:
+    user = getattr(request, "user", None)
+
+    # Evaluating a SimpleLazyObject in an async view can raise django.core.exceptions.SynchronousOnlyOperation.
+    # Exit early if the user has not been materialized yet.
+    is_lazy = isinstance(user, SimpleLazyObject)
+    if is_lazy and hasattr(request, "_cached_user"):
+        user = request._cached_user
+    elif is_lazy:
+        return
+
+    if user is None or not is_authenticated(user):
+        return
+
+    user_info = {}
+    try:
+        user_info["id"] = str(user.pk)
+    except Exception:
+        pass
+
+    try:
+        user_info["email"] = user.email
+    except Exception:
+        pass
+
+    try:
+        user_info["username"] = user.get_username()
+    except Exception:
+        pass
+
+    sentry_sdk.set_user(user_info)
+
+
 def _after_get_response(request: "WSGIRequest") -> None:
     client = sentry_sdk.get_client()
     integration = client.get_integration(DjangoIntegration)
@@ -468,37 +502,12 @@ def _after_get_response(request: "WSGIRequest") -> None:
         _attempt_resolve_again(request, scope, integration.transaction_style)
 
     span_streaming = has_span_streaming_enabled(client.options)
-    if span_streaming and should_send_default_pii():
-        user = getattr(request, "user", None)
-
-        # Evaluating a SimpleLazyObject in an async view can raise django.core.exceptions.SynchronousOnlyOperation.
-        # Exit early if the user has not been materialized yet.
-        is_lazy = isinstance(user, SimpleLazyObject)
-        if is_lazy and hasattr(request, "_cached_user"):
-            user = request._cached_user
-        elif is_lazy:
-            return
-
-        if user is None or not is_authenticated(user):
-            return
-
-        user_info = {}
-        try:
-            user_info["id"] = str(user.pk)
-        except Exception:
-            pass
-
-        try:
-            user_info["email"] = user.email
-        except Exception:
-            pass
-
-        try:
-            user_info["username"] = user.get_username()
-        except Exception:
-            pass
-
-        sentry_sdk.set_user(user_info)
+    if span_streaming:
+        if has_data_collection_enabled(client.options):
+            if client.options["data_collection"]["user_info"]:
+                _get_user_from_request_and_set_on_scope(request)
+        elif should_send_default_pii():
+            _get_user_from_request_and_set_on_scope(request)
 
 
 def _patch_get_response() -> None:
@@ -544,7 +553,12 @@ def wsgi_request_event_processor(event: "Event", hint: "dict[str, Any]") -> "Eve
         with capture_internal_exceptions():
             DjangoRequestExtractor(request).extract_into_event(event)
 
-        if should_send_default_pii():
+        client_options = sentry_sdk.get_client().options
+        if has_data_collection_enabled(client_options):
+            if client_options["data_collection"]["user_info"]:
+                with capture_internal_exceptions():
+                    _set_user_info(request, event)
+        elif should_send_default_pii():
             with capture_internal_exceptions():
                 _set_user_info(request, event)
 

sentry_sdk/integrations/django/asgi.py

@@ -22,6 +22,7 @@
 from sentry_sdk.utils import (
     capture_internal_exceptions,
     ensure_integration_enabled,
+    has_data_collection_enabled,
 )
 
 if TYPE_CHECKING:
@@ -70,7 +71,12 @@ def asgi_request_event_processor(event: "Event", hint: "dict[str, Any]") -> "Eve
         with capture_internal_exceptions():
             DjangoRequestExtractor(request).extract_into_event(event)
 
-        if should_send_default_pii():
+        client_options = sentry_sdk.get_client().options
+        if has_data_collection_enabled(client_options):
+            if client_options["data_collection"]["user_info"]:
+                with capture_internal_exceptions():
+                    _set_user_info(request, event)
+        elif should_send_default_pii():
             with capture_internal_exceptions():
                 _set_user_info(request, event)
 

sentry_sdk/integrations/litestar.py

@@ -357,8 +357,14 @@ def retrieve_user_from_scope(scope: "LitestarScope") -> "Optional[dict[str, Any]
 @ensure_integration_enabled(LitestarIntegration)
 def exception_handler(exc: Exception, scope: "LitestarScope") -> None:
     user_info: "Optional[dict[str, Any]]" = None
-    if should_send_default_pii():
+    client_options = sentry_sdk.get_client().options
+
+    if has_data_collection_enabled(client_options):
+        if client_options["data_collection"]["user_info"]:
+            user_info = retrieve_user_from_scope(scope)
+    elif should_send_default_pii():
         user_info = retrieve_user_from_scope(scope)
+
     if user_info and isinstance(user_info, dict):
         sentry_scope = sentry_sdk.get_isolation_scope()
         sentry_scope.set_user(user_info)

sentry_sdk/integrations/pyramid.py

@@ -15,6 +15,7 @@
     capture_internal_exceptions,
     ensure_integration_enabled,
     event_from_exception,
+    has_data_collection_enabled,
     reraise,
 )
 
@@ -86,10 +87,16 @@ def sentry_patched_call_view(
 
             scope = sentry_sdk.get_isolation_scope()
 
-            if should_send_default_pii() and has_span_streaming_enabled(client.options):
-                user_id = authenticated_userid(request)
-                if user_id:
-                    scope.set_user({"id": user_id})
+            if has_span_streaming_enabled(client.options):
+                if has_data_collection_enabled(client.options):
+                    if client.options["data_collection"]["user_info"]:
+                        user_id = authenticated_userid(request)
+                        if user_id:
+                            scope.set_user({"id": user_id})
+                elif should_send_default_pii():
+                    user_id = authenticated_userid(request)
+                    if user_id:
+                        scope.set_user({"id": user_id})
 
             scope.add_event_processor(
                 _make_event_processor(weakref.ref(request), integration)
@@ -229,7 +236,13 @@ def pyramid_event_processor(event: "Event", hint: "Dict[str, Any]") -> "Event":
         with capture_internal_exceptions():
             PyramidRequestExtractor(request).extract_into_event(event)
 
-        if should_send_default_pii():
+        client_options = sentry_sdk.get_client().options
+        if has_data_collection_enabled(client_options):
+            if client_options["data_collection"]["user_info"]:
+                with capture_internal_exceptions():
+                    user_info = event.setdefault("user", {})
+                    user_info.setdefault("id", authenticated_userid(request))
+        elif should_send_default_pii():
             with capture_internal_exceptions():
                 user_info = event.setdefault("user", {})
                 user_info.setdefault("id", authenticated_userid(request))

sentry_sdk/integrations/quart.py

@@ -235,9 +235,25 @@ async def _request_websocket_started(app: "Quart", **kwargs: "Any") -> None:
                     else parsed_url.url,
                 )
 
-                # TODO: Add the user properties that are seen in the branch below here once
-                # code is added to respect the `user_info` settings within the data collection
-                # configuration
+                if client_options["data_collection"]["user_info"]:
+                    user_properties = {}
+
+                    if len(request_websocket.access_route) >= 1:
+                        segment.set_attribute(
+                            "client.address", request_websocket.access_route[0]
+                        )
+                        user_properties["ip_address"] = request_websocket.access_route[
+                            0
+                        ]
+
+                    current_user_id = _get_current_user_id_from_quart()
+                    if current_user_id:
+                        user_properties["id"] = current_user_id
+
+                    if user_properties:
+                        existing_user_properties = scope._user or {}
+                        scope.set_user({**existing_user_properties, **user_properties})
+
             elif should_send_default_pii():
                 segment.set_attribute("url.full", request_websocket.url)
                 segment.set_attribute(
@@ -284,7 +300,18 @@ def inner(event: "Event", hint: "dict[str, Any]") -> "Event":
             request_info["method"] = request.method
             request_info["headers"] = _filter_headers(dict(request.headers))
 
-            if should_send_default_pii():
+            client_options = sentry_sdk.get_client().options
+            if has_data_collection_enabled(client_options):
+                if client_options["data_collection"]["user_info"]:
+                    if len(request.access_route) >= 1:
+                        request_info["env"] = {"REMOTE_ADDR": request.access_route[0]}
+
+                    current_user_id = _get_current_user_id_from_quart()
+                    if current_user_id:
+                        user_info = event.setdefault("user", {})
+                        user_info["id"] = current_user_id
+
+            elif should_send_default_pii():
                 if len(request.access_route) >= 1:
                     request_info["env"] = {"REMOTE_ADDR": request.access_route[0]}
 

sentry_sdk/integrations/sanic.py

@@ -196,8 +196,12 @@ async def _context_enter(request: "Request") -> None:
         sentry_sdk.traces.continue_trace(dict(request.headers))
         scope.set_custom_sampling_context({"sanic_request": request})
 
-        if should_send_default_pii() and request.remote_addr:
-            scope.set_attribute(SPANDATA.USER_IP_ADDRESS, request.remote_addr)
+        if request.remote_addr:
+            if has_data_collection_enabled(client.options):
+                if client.options["data_collection"]["user_info"]:
+                    scope.set_attribute(SPANDATA.USER_IP_ADDRESS, request.remote_addr)
+            elif should_send_default_pii():
+                scope.set_attribute(SPANDATA.USER_IP_ADDRESS, request.remote_addr)
 
         span = sentry_sdk.traces.start_span(
             # Unless the request results in a 404 error, the name and source
@@ -401,19 +405,23 @@ def _get_request_attributes(request: "Request") -> "Dict[str, Any]":
             query=filtered_query or ""
         ).geturl()
 
+        if request.remote_addr:
+            if client_options["data_collection"]["user_info"]:
+                attributes[SPANDATA.CLIENT_ADDRESS] = request.remote_addr
+
     elif should_send_default_pii():
         attributes[SPANDATA.URL_FULL] = request.url
         attributes["url.path"] = urlparts.path
 
         if urlparts.query:
             attributes[SPANDATA.HTTP_QUERY] = urlparts.query
 
+        if request.remote_addr:
+            attributes[SPANDATA.CLIENT_ADDRESS] = request.remote_addr
+
     if urlparts.scheme:
         attributes[SPANDATA.NETWORK_PROTOCOL_NAME] = urlparts.scheme
 
-    if should_send_default_pii() and request.remote_addr:
-        attributes[SPANDATA.CLIENT_ADDRESS] = request.remote_addr
-
     return attributes
 
 

sentry_sdk/integrations/starlette.py

@@ -375,7 +375,11 @@ def _add_user_to_sentry_scope(scope: "Dict[str, Any]") -> None:
     if "user" not in scope:
         return
 
-    if not should_send_default_pii():
+    client_options = sentry_sdk.get_client().options
+    if has_data_collection_enabled(client_options):
+        if not client_options["data_collection"]["user_info"]:
+            return
+    elif not should_send_default_pii():
         return
 
     user_info: "Dict[str, Any]" = {}