Skip to content

chore(django): Disable middleware spans by default #5219

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
alexander-alderman-webb merged 5 commits into from
Dec 12, 2025
+13 −7
Merged

chore(django): Disable middleware spans by default #5219

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
92c5454
chore(django): Disable middleware spans by default
alexander-alderman-webb Dec 11, 2025
a674e17
tests
alexander-alderman-webb Dec 12, 2025
5496a45
Merge branch 'master' into webb/disable-django-spans
alexander-alderman-webb Dec 12, 2025
6bf8f11
fix test
alexander-alderman-webb Dec 12, 2025
684832a
parametrize test
alexander-alderman-webb Dec 12, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion sentry_sdk/integrations/django/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -130,7 +130,7 @@ class DjangoIntegration(Integration):
def __init__(
self,
transaction_style="url", # type: str
middleware_spans=True, # type: bool
middleware_spans=False, # type: bool
signals_spans=True, # type: bool
cache_spans=False, # type: bool
db_transaction_spans=False, # type: bool
Expand Down
18 changes: 12 additions & 6 deletions tests/integrations/django/test_basic.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1023,7 +1023,7 @@ def test_render_spans_queryset_in_data(sentry_init, client, capture_events):
def test_middleware_spans(sentry_init, client, capture_events, render_span_tree):
sentry_init(
integrations=[
DjangoIntegration(signals_spans=False),
DjangoIntegration(middleware_spans=True, signals_spans=False),
],
traces_sample_rate=1.0,
)
Expand All @@ -1040,7 +1040,7 @@ def test_middleware_spans(sentry_init, client, capture_events, render_span_tree)
def test_middleware_spans_disabled(sentry_init, client, capture_events):
sentry_init(
integrations=[
DjangoIntegration(middleware_spans=False, signals_spans=False),
DjangoIntegration(signals_spans=False),
],
traces_sample_rate=1.0,
)
Expand Down Expand Up @@ -1180,8 +1180,9 @@ def test_csrf(sentry_init, client):


@pytest.mark.skipif(DJANGO_VERSION < (2, 0), reason="Requires Django > 2.0")
@pytest.mark.parametrize("middleware_spans", [False, True])
def test_custom_urlconf_middleware(
settings, sentry_init, client, capture_events, render_span_tree
settings, sentry_init, client, capture_events, render_span_tree, middleware_spans
):
"""
Some middlewares (for instance in django-tenants) overwrite request.urlconf.
Expand All @@ -1192,7 +1193,10 @@ def test_custom_urlconf_middleware(
settings.MIDDLEWARE.insert(0, urlconf)
client.application.load_middleware()

sentry_init(integrations=[DjangoIntegration()], traces_sample_rate=1.0)
sentry_init(
integrations=[DjangoIntegration(middleware_spans=middleware_spans)],
traces_sample_rate=1.0,
)
events = capture_events()

content, status, _headers = unpack_werkzeug_response(client.get("/custom/ok"))
Expand All @@ -1201,7 +1205,8 @@ def test_custom_urlconf_middleware(

event = events.pop(0)
assert event["transaction"] == "/custom/ok"
assert "custom_urlconf_middleware" in render_span_tree(event)
if middleware_spans:
assert "custom_urlconf_middleware" in render_span_tree(event)

_content, status, _headers = unpack_werkzeug_response(client.get("/custom/exc"))
assert status.lower() == "500 internal server error"
Expand All @@ -1210,7 +1215,8 @@ def test_custom_urlconf_middleware(
assert error_event["transaction"] == "/custom/exc"
assert error_event["exception"]["values"][-1]["mechanism"]["type"] == "django"
assert transaction_event["transaction"] == "/custom/exc"
assert "custom_urlconf_middleware" in render_span_tree(transaction_event)
if middleware_spans:
assert "custom_urlconf_middleware" in render_span_tree(transaction_event)

settings.MIDDLEWARE.pop(0)

Expand Down