.

Author: sentrivana

MIGRATION_GUIDE.md

@@ -19,7 +19,9 @@ Looking to upgrade from Sentry SDK 2.x to 3.x? Here's a comprehensive list of wh
 - The `Span()` constructor does not accept a `hub` parameter anymore.
 - The `sentry_sdk.Scope()` constructor no longer accepts a `client` parameter.
 - `Span.finish()` does not accept a `hub` parameter anymore.
-- `Span.finish()` no longer returns the `event_id` if the event is sent to sentry.
+- `Span.finish()` no longer returns the `event_id` if the event is sent to Sentry.
+- We trim events to a much lesser extent in the SDK. Note that your events might still be subject to server-side trimming.
+- The default value of `max_request_body_size` was changed to `"always"`, so request bodies will now be included in events by default, regardless of size.
 - The `Profile()` constructor does not accept a `hub` parameter anymore.
 - A `Profile` object does not have a `.hub` property anymore.
 - `MAX_PROFILE_DURATION_NS`, `PROFILE_MINIMUM_SAMPLES`, `Profile`, `Scheduler`, `ThreadScheduler`, `GeventScheduler`, `has_profiling_enabled`, `setup_profiler`, `teardown_profiler` are no longer accessible from `sentry_sdk.profiler`. They're still accessible from `sentry_sdk.profiler.transaction_profiler`.

sentry_sdk/client.py

@@ -547,7 +547,6 @@ def _prepare_event(
         if event is not None:
             event: Event = serialize(  # type: ignore[no-redef]
                 event,
-                max_request_body_size=self.options.get("max_request_body_size"),
                 max_value_length=self.options.get("max_value_length"),
                 custom_repr=self.options.get("custom_repr"),
             )

sentry_sdk/consts.py

@@ -812,7 +812,7 @@ def __init__(
         http_proxy: Optional[str] = None,
         https_proxy: Optional[str] = None,
         ignore_errors: Sequence[Union[type, str]] = [],  # noqa: B006
-        max_request_body_size: str = "medium",
+        max_request_body_size: str = "always",
         socket_options: Optional[List[Tuple[int, int, int | bytes]]] = None,
         keep_alive: Optional[bool] = None,
         before_send: Optional[EventProcessor] = None,

sentry_sdk/serializer.py

@@ -97,7 +97,6 @@ def serialize(event: Union[Dict[str, Any], Event], **kwargs: Any) -> Dict[str, A
     * Calling safe_repr() on objects appropriately to keep them informative and readable in the final payload.
     * Annotating the payload with the _meta field whenever trimming happens.
 
-    :param max_request_body_size: If set to "always", will never trim request bodies.
     :param max_value_length: The max length to strip strings to, defaults to sentry_sdk.consts.DEFAULT_MAX_VALUE_LENGTH
     :param is_vars: If we're serializing vars early, we want to repr() things that are JSON-serializable to make their type more apparent. For example, it's useful to see the difference between a unicode-string and a bytestring when viewing a stacktrace.
     :param custom_repr: A custom repr function that runs before safe_repr on the object to be serialized. If it returns None or throws internally, we will fallback to safe_repr.

tests/integrations/bottle/test_bottle.py

@@ -7,7 +7,6 @@
 from sentry_sdk import capture_message
 from sentry_sdk.consts import DEFAULT_MAX_VALUE_LENGTH
 from sentry_sdk.integrations.bottle import BottleIntegration
-from sentry_sdk.serializer import MAX_DATABAG_BREADTH
 
 from sentry_sdk.integrations.logging import LoggingIntegration
 from werkzeug.test import Client
@@ -122,7 +121,7 @@ def index():
 
 
 def test_large_json_request(sentry_init, capture_events, app, get_client):
-    sentry_init(integrations=[BottleIntegration()], max_request_body_size="always")
+    sentry_init(integrations=[BottleIntegration()])
 
     data = {"foo": {"bar": "a" * (DEFAULT_MAX_VALUE_LENGTH + 10)}}
 
@@ -180,7 +179,7 @@ def index():
 
 
 def test_medium_formdata_request(sentry_init, capture_events, app, get_client):
-    sentry_init(integrations=[BottleIntegration()], max_request_body_size="always")
+    sentry_init(integrations=[BottleIntegration()])
 
     data = {"foo": "a" * (DEFAULT_MAX_VALUE_LENGTH + 10)}
 
@@ -242,7 +241,7 @@ def index():
 
 
 def test_files_and_form(sentry_init, capture_events, app, get_client):
-    sentry_init(integrations=[BottleIntegration()], max_request_body_size="always")
+    sentry_init(integrations=[BottleIntegration()])
 
     data = {
         "foo": "a" * (DEFAULT_MAX_VALUE_LENGTH + 10),
@@ -287,11 +286,9 @@ def index():
 def test_json_not_truncated_if_max_request_body_size_is_always(
     sentry_init, capture_events, app, get_client
 ):
-    sentry_init(integrations=[BottleIntegration()], max_request_body_size="always")
+    sentry_init(integrations=[BottleIntegration()])
 
-    data = {
-        "key{}".format(i): "value{}".format(i) for i in range(MAX_DATABAG_BREADTH + 10)
-    }
+    data = {"key{}".format(i): "value{}".format(i) for i in range(10**5)}
 
     @app.route("/", method="POST")
     def index():

tests/integrations/falcon/test_falcon.py

@@ -208,7 +208,7 @@ def on_get(self, req, resp):
 
 
 def test_falcon_large_json_request(sentry_init, capture_events):
-    sentry_init(integrations=[FalconIntegration()], max_request_body_size="always")
+    sentry_init(integrations=[FalconIntegration()])
 
     data = {"foo": {"bar": "a" * (DEFAULT_MAX_VALUE_LENGTH + 10)}}
 

tests/integrations/flask/test_flask.py

@@ -29,7 +29,6 @@
 )
 from sentry_sdk.consts import DEFAULT_MAX_VALUE_LENGTH
 from sentry_sdk.integrations.logging import LoggingIntegration
-from sentry_sdk.serializer import MAX_DATABAG_BREADTH
 
 
 login_manager = LoginManager()
@@ -249,9 +248,7 @@ def login():
 
 
 def test_flask_large_json_request(sentry_init, capture_events, app):
-    sentry_init(
-        integrations=[flask_sentry.FlaskIntegration()], max_request_body_size="always"
-    )
+    sentry_init(integrations=[flask_sentry.FlaskIntegration()])
 
     data = {"foo": {"bar": "a" * (DEFAULT_MAX_VALUE_LENGTH + 10)}}
 
@@ -344,9 +341,7 @@ def index():
 
 
 def test_flask_medium_formdata_request(sentry_init, capture_events, app):
-    sentry_init(
-        integrations=[flask_sentry.FlaskIntegration()], max_request_body_size="always"
-    )
+    sentry_init(integrations=[flask_sentry.FlaskIntegration()])
 
     data = {"foo": "a" * (DEFAULT_MAX_VALUE_LENGTH + 10)}
 
@@ -452,9 +447,7 @@ def index():
 
 
 def test_flask_files_and_form(sentry_init, capture_events, app):
-    sentry_init(
-        integrations=[flask_sentry.FlaskIntegration()], max_request_body_size="always"
-    )
+    sentry_init(integrations=[flask_sentry.FlaskIntegration()])
 
     data = {
         "foo": "a" * (DEFAULT_MAX_VALUE_LENGTH + 10),
@@ -497,13 +490,9 @@ def index():
 def test_json_not_truncated_if_max_request_body_size_is_always(
     sentry_init, capture_events, app
 ):
-    sentry_init(
-        integrations=[flask_sentry.FlaskIntegration()], max_request_body_size="always"
-    )
+    sentry_init(integrations=[flask_sentry.FlaskIntegration()])
 
-    data = {
-        "key{}".format(i): "value{}".format(i) for i in range(MAX_DATABAG_BREADTH + 10)
-    }
+    data = {"key{}".format(i): "value{}".format(i) for i in range(10**5)}
 
     @app.route("/", methods=["POST"])
     def index():

tests/integrations/pure_eval/test_pure_eval.py

@@ -2,7 +2,7 @@
 
 import pytest
 
-from sentry_sdk import capture_exception, serializer
+from sentry_sdk import capture_exception
 from sentry_sdk.integrations.pure_eval import PureEvalIntegration
 
 
@@ -62,6 +62,14 @@ def foo():
             "i",
             "u",
             "y",
+            "t",
+            "r",
+            "e",
+            "w",
+            "q",
+            "(q, w, e, r, t, y, u, i, o, p, a, s)",
+            "str((q, w, e, r, t, y, u, i, o, p, a, s))",
+            "events",
         ]
         assert list(frame_vars.keys()) == expected_keys
         assert frame_vars["namespace.d"] == {"1": "2"}
@@ -85,4 +93,4 @@ def foo():
             "s",
             "events",
         }
-        assert len(frame_vars) == serializer.MAX_DATABAG_BREADTH
+        assert len(frame_vars) == 14

tests/integrations/pyramid/test_pyramid.py

@@ -11,7 +11,6 @@
 from sentry_sdk import capture_message, add_breadcrumb
 from sentry_sdk.consts import DEFAULT_MAX_VALUE_LENGTH
 from sentry_sdk.integrations.pyramid import PyramidIntegration
-from sentry_sdk.serializer import MAX_DATABAG_BREADTH
 from tests.conftest import unpack_werkzeug_response
 
 
@@ -157,7 +156,7 @@ def test_transaction_style(
 
 
 def test_large_json_request(sentry_init, capture_events, route, get_client):
-    sentry_init(integrations=[PyramidIntegration()], max_request_body_size="always")
+    sentry_init(integrations=[PyramidIntegration()])
 
     data = {"foo": {"bar": "a" * (DEFAULT_MAX_VALUE_LENGTH + 10)}}
 
@@ -211,11 +210,9 @@ def index(request):
 def test_json_not_truncated_if_max_request_body_size_is_always(
     sentry_init, capture_events, route, get_client
 ):
-    sentry_init(integrations=[PyramidIntegration()], max_request_body_size="always")
+    sentry_init(integrations=[PyramidIntegration()])
 
-    data = {
-        "key{}".format(i): "value{}".format(i) for i in range(MAX_DATABAG_BREADTH + 10)
-    }
+    data = {"key{}".format(i): "value{}".format(i) for i in range(10**5)}
 
     @route("/")
     def index(request):
@@ -234,7 +231,7 @@ def index(request):
 
 
 def test_files_and_form(sentry_init, capture_events, route, get_client):
-    sentry_init(integrations=[PyramidIntegration()], max_request_body_size="always")
+    sentry_init(integrations=[PyramidIntegration()])
 
     data = {
         "foo": "a" * (DEFAULT_MAX_VALUE_LENGTH + 10),

tests/test_serializer.py

@@ -141,11 +141,11 @@ def custom_repr(value):
 
 
 def test_dont_trim_databag_breadth(body_normalizer):
-    data = {"key{}".format(i): "value{}".format(i) for i in range(10**9)}
+    data = {"key{}".format(i): "value{}".format(i) for i in range(10**5)}
 
     result = body_normalizer(data)
 
-    assert len(result) == 10**9
+    assert len(result) == 10**5
     for key, value in result.items():
         assert data.get(key) == value