Adds DB connection attributes in spans

sentry_sdk/consts.py

@@ -68,6 +68,12 @@ class SPANDATA:
     See: https://develop.sentry.dev/sdk/performance/span-data-conventions/
     """
 
+    DB_NAME = "db.name"
+    """
+    The name of the database being accessed. For commands that switch the database, this should be set to the target database (even if the command fails).
+    Example: myDatabase
+    """
+
     DB_OPERATION = "db.operation"
     """
     The name of the operation being executed, e.g. the MongoDB command name such as findAndModify, or the SQL keyword.
@@ -118,6 +124,31 @@ class SPANDATA:
     Example: 418
     """
 
+    SERVER_ADDRESS = "server.address"
+    """
+    Name of the database host.
+    Example: example.com
+    """
+
+    SERVER_PORT = "server.port"
+    """
+    Logical server port number
+    Example: 80; 8080; 443
+    """
+
+    SERVER_SOCKET_ADDRESS = "server.socket.address"
+    """
+    Physical server IP address or Unix socket address.
+    Example: 10.5.3.2
+    """
+
+    SERVER_SOCKET_PORT = "server.socket.port"
+    """
+    Physical server port.
+    Recommended: If different than server.port.
+    Example: 16456
+    """
+
 
 class OP:
     CACHE_GET_ITEM = "cache.get_item"

sentry_sdk/integrations/django/__init__.py

@@ -612,7 +612,7 @@
         with record_sql_queries(
             hub, self.cursor, sql, params, paramstyle="format", executemany=False
         ) as span:
-            _set_db_system_on_span(span, self.db.vendor)
+            _set_db_data(span, self.db.vendor, self.db.get_connection_params())
             return real_execute(self, sql, params)
 
     def executemany(self, sql, param_list):
@@ -624,7 +624,7 @@
         with record_sql_queries(
             hub, self.cursor, sql, param_list, paramstyle="format", executemany=True
         ) as span:
-            _set_db_system_on_span(span, self.db.vendor)
+            _set_db_data(span, self.db.vendor, self.db.get_connection_params())
             return real_executemany(self, sql, param_list)
 
     def connect(self):
@@ -637,7 +637,7 @@
             hub.add_breadcrumb(message="connect", category="query")
 
         with hub.start_span(op=OP.DB, description="connect") as span:
-            _set_db_system_on_span(span, self.vendor)
+            _set_db_data(span, self.vendor, self.get_connection_params())
             return real_connect(self)
 
     CursorWrapper.execute = execute
@@ -646,8 +646,9 @@
     ignore_logger("django.db.backends")
 
 
-# https://github.com/django/django/blob/6a0dc2176f4ebf907e124d433411e52bba39a28e/django/db/backends/base/base.py#L29
-# Avaliable in Django 1.8+
-def _set_db_system_on_span(span, vendor):
-    # type: (Span, str) -> None
+def _set_db_data(span, vendor, connection_params):
+    # type: (Span, str, Dict[str, str]) -> None
     span.set_data(SPANDATA.DB_SYSTEM, vendor)
+    span.set_data(SPANDATA.DB_NAME, connection_params.get("database"))
+    span.set_data(SPANDATA.SERVER_ADDRESS, connection_params.get("host"))
+    span.set_data(SPANDATA.SERVER_PORT, connection_params.get("port"))

sentry_sdk/integrations/pymongo.py

@@ -121,10 +121,13 @@ def started(self, event):
                 pass
 
             data = {"operation_ids": {}}  # type: Dict[str, Any]
-
             data["operation_ids"]["operation"] = event.operation_id
             data["operation_ids"]["request"] = event.request_id
+
             data[SPANDATA.DB_SYSTEM] = "mongodb"
+            data[SPANDATA.DB_NAME] = event.database_name
+            data[SPANDATA.SERVER_ADDRESS] = event.connection_id[0]
+            data[SPANDATA.SERVER_PORT] = event.connection_id[1]
 
             try:
                 lsid = command.pop("lsid")["id"]

sentry_sdk/integrations/sqlalchemy.py

@@ -67,9 +67,7 @@
     span = ctx_mgr.__enter__()
 
     if span is not None:
-        db_system = _get_db_system(conn.engine.name)
-        if db_system is not None:
-            span.set_data(SPANDATA.DB_SYSTEM, db_system)
+        _set_db_data(span, conn)
         context._sentry_sql_span = span
 
 
@@ -128,3 +126,15 @@
         return "oracle"
 
     return None
+
+
+def _set_db_data(span, conn):
+    # type: (Span, Any) -> None
+    db_system = _get_db_system(conn.engine.name)
+    if db_system is not None:
+        span.set_data(SPANDATA.DB_SYSTEM, db_system)
+
+    span.set_data(SPANDATA.DB_NAME, conn.engine.url.database)
+
+    span.set_data(SPANDATA.SERVER_ADDRESS, conn.engine.url.host)
+    span.set_data(SPANDATA.SERVER_PORT, conn.engine.url.port)

tests/integrations/pymongo/test_pymongo.py

@@ -57,6 +57,9 @@ def test_transactions(sentry_init, capture_events, mongo_server, with_pii):
     }
     for span in find, insert_success, insert_fail:
         assert span["data"][SPANDATA.DB_SYSTEM] == "mongodb"
+        assert span["data"][SPANDATA.DB_NAME] == "test_db"
+        assert span["data"][SPANDATA.SERVER_ADDRESS] == "localhost"
+        assert span["data"][SPANDATA.SERVER_PORT] == mongo_server.port
         for field, value in common_tags.items():
             assert span["tags"][field] == value
 

tests/integrations/sqlalchemy/test_sqlalchemy.py

@@ -122,6 +122,13 @@ class Address(Base):
 
     for span in event["spans"]:
         assert span["data"][SPANDATA.DB_SYSTEM] == "sqlite"
+        assert span["data"][SPANDATA.DB_NAME] == ":memory:"
+        assert (
+            span["data"][SPANDATA.SERVER_ADDRESS] is None
+        )  # sqlite does not have a server
+        assert (
+            span["data"][SPANDATA.SERVER_PORT] is None
+        )  # sqlite does not have a server
 
     assert (
         render_span_tree(event)