feat(django): Instrument database commits (#5100)

Add spans for SQL commits issued when Django calls `commit()` on a
PEP-249 database connection.

Commit spans are generated for `transaction.atomic` blocks and for
manual `transction.commit()` calls when auto-commit is disabled. Tests
cover both cases, for SQLite and PostgreSQL, respectively.

Author: alexander-alderman-webb

sentry_sdk/consts.py

@@ -114,6 +114,10 @@ class INSTRUMENTER:
     OTEL = "otel"
 
 
+class SPANNAME:
+    DB_COMMIT = "COMMIT"
+
+
 class SPANDATA:
     """
     Additional information describing the type of the span.

sentry_sdk/integrations/django/__init__.py

@@ -5,7 +5,7 @@
 from importlib import import_module
 
 import sentry_sdk
-from sentry_sdk.consts import OP, SPANDATA
+from sentry_sdk.consts import OP, SPANDATA, SPANNAME
 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.tracing import SOURCE_FOR_STYLE, TransactionSource
@@ -132,6 +132,7 @@ def __init__(
         middleware_spans=True,  # type: bool
         signals_spans=True,  # type: bool
         cache_spans=False,  # type: bool
+        db_transaction_spans=False,  # type: bool
         signals_denylist=None,  # type: Optional[list[signals.Signal]]
         http_methods_to_capture=DEFAULT_HTTP_METHODS_TO_CAPTURE,  # type: tuple[str, ...]
     ):
@@ -148,6 +149,7 @@ def __init__(
         self.signals_denylist = signals_denylist or []
 
         self.cache_spans = cache_spans
+        self.db_transaction_spans = db_transaction_spans
 
         self.http_methods_to_capture = tuple(map(str.upper, http_methods_to_capture))
 
@@ -633,6 +635,7 @@ def install_sql_hook():
         real_execute = CursorWrapper.execute
         real_executemany = CursorWrapper.executemany
         real_connect = BaseDatabaseWrapper.connect
+        real_commit = BaseDatabaseWrapper._commit
     except AttributeError:
         # This won't work on Django versions < 1.6
         return
@@ -690,18 +693,37 @@ def connect(self):
             _set_db_data(span, self)
             return real_connect(self)
 
+    def _commit(self):
+        # type: (BaseDatabaseWrapper) -> None
+        integration = sentry_sdk.get_client().get_integration(DjangoIntegration)
+
+        if integration is None or not integration.db_transaction_spans:
+            return real_commit(self)
+
+        with sentry_sdk.start_span(
+            op=OP.DB,
+            name=SPANNAME.DB_COMMIT,
+            origin=DjangoIntegration.origin_db,
+        ) as span:
+            _set_db_data(span, self, SPANNAME.DB_COMMIT)
+            return real_commit(self)
+
     CursorWrapper.execute = execute
     CursorWrapper.executemany = executemany
     BaseDatabaseWrapper.connect = connect
+    BaseDatabaseWrapper._commit = _commit
     ignore_logger("django.db.backends")
 
 
-def _set_db_data(span, cursor_or_db):
-    # type: (Span, Any) -> None
+def _set_db_data(span, cursor_or_db, db_operation=None):
+    # type: (Span, Any, Optional[str]) -> None
     db = cursor_or_db.db if hasattr(cursor_or_db, "db") else cursor_or_db
     vendor = db.vendor
     span.set_data(SPANDATA.DB_SYSTEM, vendor)
 
+    if db_operation is not None:
+        span.set_data(SPANDATA.DB_OPERATION, db_operation)
+
     # Some custom backends override `__getattr__`, making it look like `cursor_or_db`
     # actually has a `connection` and the `connection` has a `get_dsn_parameters`
     # attribute, only to throw an error once you actually want to call it.

tests/integrations/django/myapp/urls.py

@@ -61,6 +61,16 @@ def path(path, *args, **kwargs):
     path("template-test4", views.template_test4, name="template_test4"),
     path("postgres-select", views.postgres_select, name="postgres_select"),
     path("postgres-select-slow", views.postgres_select_orm, name="postgres_select_orm"),
+    path(
+        "postgres-insert-no-autocommit",
+        views.postgres_insert_orm_no_autocommit,
+        name="postgres_insert_orm_no_autocommit",
+    ),
+    path(
+        "postgres-insert-atomic",
+        views.postgres_insert_orm_atomic,
+        name="postgres_insert_orm_atomic",
+    ),
     path(
         "postgres-select-slow-from-supplement",
         helper_views.postgres_select_orm,

tests/integrations/django/myapp/views.py

@@ -2,6 +2,7 @@
 import json
 import threading
 
+from django.db import transaction
 from django.contrib.auth import login
 from django.contrib.auth.models import User
 from django.core.exceptions import PermissionDenied
@@ -246,6 +247,32 @@ def postgres_select_orm(request, *args, **kwargs):
     return HttpResponse("ok {}".format(user))
 
 
+@csrf_exempt
+def postgres_insert_orm_no_autocommit(request, *args, **kwargs):
+    transaction.set_autocommit(False, using="postgres")
+    try:
+        user = User.objects.db_manager("postgres").create_user(
+            username="user1",
+        )
+        transaction.commit(using="postgres")
+    except Exception:
+        transaction.rollback(using="postgres")
+        transaction.set_autocommit(True, using="postgres")
+        raise
+
+    transaction.set_autocommit(True, using="postgres")
+    return HttpResponse("ok {}".format(user))
+
+
+@csrf_exempt
+def postgres_insert_orm_atomic(request, *args, **kwargs):
+    with transaction.atomic(using="postgres"):
+        user = User.objects.db_manager("postgres").create_user(
+            username="user1",
+        )
+    return HttpResponse("ok {}".format(user))
+
+
 @csrf_exempt
 def permission_denied_exc(*args, **kwargs):
     raise PermissionDenied("bye")