Skip to content

ref(django): Remove transaction_style parameter #7799

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 2 commits into from
Oct 1, 2026
Merged

ref(django): Remove transaction_style parameter #7799

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ec50d43
ref(django): Remove transaction_style parameter
alexander-alderman-webb Oct 1, 2026
4d50ceb
rename transaction_style tests
alexander-alderman-webb Oct 1, 2026
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
67 changes: 14 additions & 53 deletions sentry_sdk/integrations/django/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,6 @@
import sys
import threading
import weakref
from importlib import import_module

import sentry_sdk
from sentry_sdk.consts import OP, SPANDATA, SPANNAME
Expand All @@ -21,7 +20,7 @@
from sentry_sdk.integrations.wsgi import SentryWsgiMiddleware
from sentry_sdk.scope import add_global_event_processor, should_send_default_pii
from sentry_sdk.serializer import add_global_repr_processor, add_repr_sequence_type
from sentry_sdk.traces import SOURCE_FOR_STYLE, SegmentNameSource
from sentry_sdk.traces import SegmentNameSource
from sentry_sdk.tracing_utils import (
add_query_source,
record_sql_queries,
Expand All @@ -33,15 +32,13 @@
ensure_integration_enabled,
event_from_exception,
has_data_collection_enabled,
transaction_from_function,
walk_exception_chain,
)

try:
from django import VERSION as DJANGO_VERSION
from django.conf import settings
from django.core import signals
from django.urls import Resolver404, resolve
from django.utils.functional import SimpleLazyObject

# Only available in Django 3.0+
Expand Down Expand Up @@ -86,14 +83,10 @@
from sentry_sdk.traces import Span


TRANSACTION_STYLE_VALUES = ("function_name", "url")


class DjangoIntegration(Integration):
"""
Auto instrument a Django application.

:param transaction_style: How to derive transaction names. Either `"function_name"` or `"url"`. Defaults to `"url"`.
:param middleware_spans: Whether to create spans for middleware. Defaults to `False`.
:param signals_spans: Whether to create spans for signals. Defaults to `True`.
:param signals_denylist: A list of signals to ignore when creating spans.
Expand All @@ -109,15 +102,13 @@ class DjangoIntegration(Integration):
origin = f"auto.http.{identifier}"
origin_db = f"auto.db.{identifier}"

transaction_style = ""
middleware_spans: "Optional[bool]" = None
signals_spans: "Optional[bool]" = None
cache_spans: "Optional[bool]" = None
signals_denylist: "list[signals.Signal]" = []

def __init__(
self,
transaction_style: str = "url",
middleware_spans: bool = False,
signals_spans: bool = True,
cache_spans: bool = True,
Expand All @@ -127,12 +118,6 @@ def __init__(
*,
failed_request_status_codes: "Set[int]" = _DEFAULT_FAILED_REQUEST_STATUS_CODES,
) -> None:
if transaction_style not in TRANSACTION_STYLE_VALUES:
raise ValueError(
"Invalid value for transaction_style: %s (must be in %s)"
% (transaction_style, TRANSACTION_STYLE_VALUES)
)
self.transaction_style = transaction_style
self.middleware_spans = middleware_spans

self.signals_spans = signals_spans
Expand Down Expand Up @@ -390,48 +375,29 @@ def _patch_django_asgi_handler() -> None:

def _set_transaction_name_and_source(
scope: "sentry_sdk.Scope",
transaction_style: str,
request: "WSGIRequest",
route_path: "Optional[str]",
) -> None:
try:
transaction_name = None
if transaction_style == "function_name":
fn = resolve(request.path).func
transaction_name = transaction_from_function(getattr(fn, "view_class", fn))

elif transaction_style == "url" and route_path is not None:
if route_path is not None:
transaction_name = route_path

if transaction_name is None:
transaction_name = request.path_info
source = SegmentNameSource.URL
else:
source = SOURCE_FOR_STYLE[transaction_style]
source = SegmentNameSource.ROUTE

scope.set_transaction_name(
transaction_name,
source=source,
)

if transaction_style == "url" and route_path is not None:
if route_path is not None:
server_span = scope._server_segment_span
if server_span is not None:
server_span.set_attribute(SPANDATA.HTTP_ROUTE, route_path)
except Resolver404:
urlconf = import_module(settings.ROOT_URLCONF)
# This exception only gets thrown when transaction_style is `function_name`
# So we don't check here what style is configured
if hasattr(urlconf, "handler404"):
handler = urlconf.handler404
if isinstance(handler, str):
scope.set_transaction_name(handler)
else:
name = transaction_from_function(
getattr(handler, "view_class", handler)
)
if name:
scope.set_transaction_name(name)
except Exception:
pass

Expand Down Expand Up @@ -464,17 +430,16 @@ def _before_get_response(request: "WSGIRequest") -> None:
server_span.set_attribute(SPANDATA.HTTP_ROUTE, route_path)

# Rely on WSGI middleware to start a trace
_set_transaction_name_and_source(
scope, integration.transaction_style, request, route_path=route_path
)
_set_transaction_name_and_source(scope, request, route_path=route_path)

scope.add_event_processor(
_make_wsgi_request_event_processor(weakref.ref(request), integration)
)


def _attempt_resolve_again(
request: "WSGIRequest", scope: "sentry_sdk.Scope", transaction_style: str
request: "WSGIRequest",
scope: "sentry_sdk.Scope",
) -> None:
"""
Some django middlewares overwrite request.urlconf
Expand Down Expand Up @@ -502,9 +467,7 @@ def _attempt_resolve_again(
if server_span is not None and route_path is not None:
server_span.set_attribute(SPANDATA.HTTP_ROUTE, route_path)

_set_transaction_name_and_source(
scope, transaction_style, request, route_path=route_path
)
_set_transaction_name_and_source(scope, request, route_path=route_path)


def _get_user_from_request_and_set_on_scope(request: "WSGIRequest") -> None:
Expand Down Expand Up @@ -546,9 +509,8 @@ def _after_get_response(request: "WSGIRequest") -> None:
if integration is None:
return

if integration.transaction_style == "url":
scope = sentry_sdk.get_current_scope()
_attempt_resolve_again(request, scope, integration.transaction_style)
scope = sentry_sdk.get_current_scope()
_attempt_resolve_again(request, scope)

if has_data_collection_enabled(client.options):
if client.options["data_collection"]["user_info"]:
Expand Down Expand Up @@ -625,18 +587,17 @@ def _got_request_exception(request: "WSGIRequest" = None, **kwargs: "Any") -> No
with capture_internal_exceptions():
request._sentry_exception_reported = True

_capture_exception(sys.exc_info(), request, integration, handled=False)
_capture_exception(sys.exc_info(), request, handled=False)


def _capture_exception(
exc_info: "Union[BaseException, ExcInfo]",
request: "Optional[WSGIRequest]",
integration: "DjangoIntegration",
handled: bool,
) -> None:
if request is not None and integration.transaction_style == "url":
if request is not None:
scope = sentry_sdk.get_current_scope()
_attempt_resolve_again(request, scope, integration.transaction_style)
_attempt_resolve_again(request, scope)

event, hint = event_from_exception(
exc_info,
Expand Down Expand Up @@ -696,7 +657,7 @@ def sentry_patched_response_for_exception(
if not getattr(request, "_sentry_exception_reported", False):
status_code = getattr(response, "status_code", None)
if status_code in integration.failed_request_status_codes:
_capture_exception(exc, request, integration, handled=True)
_capture_exception(exc, request, handled=True)

return response

Expand Down
58 changes: 10 additions & 48 deletions tests/integrations/django/test_basic.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -158,28 +158,6 @@ def test_request_captured(
}


def test_transaction_with_class_view(
sentry_init,
client,
capture_items,
):
sentry_init(
integrations=[DjangoIntegration(transaction_style="function_name")],
send_default_pii=True,
)
items = capture_items("event")
content, status, headers = unpack_werkzeug_response(
client.head(reverse("classbased"))
)
assert status.lower() == "200 ok"

(event,) = (item.payload for item in items)
assert (
event["transaction"] == "tests.integrations.django.myapp.views.ClassBasedView"
)
assert event["message"] == "hi"


def test_has_trace_if_performance_enabled(
sentry_init,
client,
Expand Down Expand Up @@ -855,31 +833,23 @@ def get_connection_params(self):


@pytest.mark.parametrize(
"transaction_style,client_url,expected_transaction,expected_source,expected_response",
"client_url,expected_transaction,expected_source,expected_response",
[
(
"function_name",
"/message",
"tests.integrations.django.myapp.views.message",
"component",
b"ok",
),
("url", "/message", "/message", "route", b"ok"),
("url", "/404", "/404", "url", b"404"),
("/message", "/message", "route", b"ok"),
("/404", "/404", "url", b"404"),
],
)
def test_transaction_style(
def test_segment_name(
sentry_init,
client,
capture_items,
transaction_style,
client_url,
expected_transaction,
expected_source,
expected_response,
):
sentry_init(
integrations=[DjangoIntegration(transaction_style=transaction_style)],
integrations=[DjangoIntegration()],
traces_sample_rate=1.0,
send_default_pii=True,
)
Expand All @@ -900,31 +870,23 @@ def test_transaction_style(


@pytest.mark.parametrize(
"transaction_style,client_url,expected_transaction,expected_source,expected_response",
"client_url,expected_transaction,expected_source,expected_response",
[
(
"function_name",
"/message",
"tests.integrations.django.myapp.views.message",
"component",
b"ok",
),
("url", "/message", "/message", "route", b"ok"),
("url", "/404", "/404", "url", b"404"),
("/message", "/message", "route", b"ok"),
("/404", "/404", "url", b"404"),
],
)
def test_transaction_style_tracing_disabled(
def test_segment_name_tracing_disabled(
sentry_init,
client,
capture_items,
transaction_style,
client_url,
expected_transaction,
expected_source,
expected_response,
):
sentry_init(
integrations=[DjangoIntegration(transaction_style=transaction_style)],
integrations=[DjangoIntegration()],
send_default_pii=True,
)
items = capture_items("event")
Expand Down
Loading