Unified naming for span ops (#1661)

* Unified naming for span ops.

Author: antonpirker

CHANGELOG.md

@@ -1,5 +1,35 @@
 # Changelog
 
+## 1.9.11
+
+### Various fixes & improvements
+
+- Unified naming of span "op"s (#1643) by @antonpirker
+
+  We have unified the strings of our span operations. See https://develop.sentry.dev/sdk/performance/span-operations/
+
+  **WARNING:** If you have dashboards defined that use `transaction.op` in their fields, conditions, aggregates or columns please check them before updating to this version of the SDK.
+
+  Here a list of all the changes:
+
+  | Old operation (`op`)     | New Operation (`op`)   |
+  | ------------------------ | ---------------------- |
+  | `asgi.server`            | `http.server`          |
+  | `aws.request`            | `http.client`          |
+  | `aws.request.stream`     | `http.client.stream`   |
+  | `celery.submit`          | `queue.submit.celery`  |
+  | `celery.task`            | `queue.task.celery`    |
+  | `django.middleware`      | `middleware.django`    |
+  | `django.signals`         | `event.django`         |
+  | `django.template.render` | `template.render`      |
+  | `django.view`            | `view.render`          |
+  | `http`                   | `http.client`          |
+  | `redis`                  | `db.redis`             |
+  | `rq.task`                | `queue.task.rq`        |
+  | `serverless.function`    | `function.aws`         |
+  | `serverless.function`    | `function.gcp`         |
+  | `starlette.middleware`   | `middleware.starlette` |
+
 ## 1.9.10
 
 ### Various fixes & improvements
@@ -158,7 +188,7 @@ We can do better and in the future we will do our best to not break your code ag
 
 - fix: avoid sending empty Baggage header (#1507) by @intgr
 - fix: properly freeze Baggage object (#1508) by @intgr
-- docs: fix simple typo, collecter -> collector (#1505) by @timgates42
+- docs: fix simple typo, collecter | collector (#1505) by @timgates42
 
 ## 1.7.2
 

sentry_sdk/consts.py

@@ -110,3 +110,25 @@ def _get_default_options():
     "version": VERSION,
     "packages": [{"name": "pypi:sentry-sdk", "version": VERSION}],
 }
+
+
+class OP:
+    DB = "db"
+    DB_REDIS = "db.redis"
+    EVENT_DJANGO = "event.django"
+    FUNCTION_AWS = "function.aws"
+    FUNCTION_GCP = "function.gcp"
+    HTTP_CLIENT = "http.client"
+    HTTP_CLIENT_STREAM = "http.client.stream"
+    HTTP_SERVER = "http.server"
+    MIDDLEWARE_DJANGO = "middleware.django"
+    MIDDLEWARE_STARLETTE = "middleware.starlette"
+    QUEUE_SUBMIT_CELERY = "queue.submit.celery"
+    QUEUE_TASK_CELERY = "queue.task.celery"
+    QUEUE_TASK_RQ = "queue.task.rq"
+    SUBPROCESS = "subprocess"
+    SUBPROCESS_WAIT = "subprocess.wait"
+    SUBPROCESS_COMMUNICATE = "subprocess.communicate"
+    TEMPLATE_RENDER = "template.render"
+    VIEW_RENDER = "view.render"
+    WEBSOCKET_SERVER = "websocket.server"

sentry_sdk/integrations/aiohttp.py

@@ -2,6 +2,7 @@
 import weakref
 
 from sentry_sdk._compat import reraise
+from sentry_sdk.consts import OP
 from sentry_sdk.hub import Hub
 from sentry_sdk.integrations import Integration, DidNotEnable
 from sentry_sdk.integrations.logging import ignore_logger
@@ -101,7 +102,7 @@ async def sentry_app_handle(self, request, *args, **kwargs):
 
                     transaction = Transaction.continue_from_headers(
                         request.headers,
-                        op="http.server",
+                        op=OP.HTTP_SERVER,
                         # If this transaction name makes it to the UI, AIOHTTP's
                         # URL resolver did not find a route or died trying.
                         name="generic AIOHTTP request",

sentry_sdk/integrations/asgi.py

@@ -10,6 +10,7 @@
 
 from sentry_sdk._functools import partial
 from sentry_sdk._types import MYPY
+from sentry_sdk.consts import OP
 from sentry_sdk.hub import Hub, _should_send_default_pii
 from sentry_sdk.integrations._wsgi_common import _filter_headers
 from sentry_sdk.integrations.modules import _get_installed_modules
@@ -166,7 +167,7 @@ async def _run_app(self, scope, callback):
                             op="{}.server".format(ty),
                         )
                     else:
-                        transaction = Transaction(op="asgi.server")
+                        transaction = Transaction(op=OP.HTTP_SERVER)
 
                     transaction.name = _DEFAULT_TRANSACTION_NAME
                     transaction.source = TRANSACTION_SOURCE_ROUTE

sentry_sdk/integrations/aws_lambda.py

@@ -1,6 +1,7 @@
 from datetime import datetime, timedelta
 from os import environ
 import sys
+from sentry_sdk.consts import OP
 
 from sentry_sdk.hub import Hub, _should_send_default_pii
 from sentry_sdk.tracing import TRANSACTION_SOURCE_COMPONENT, Transaction
@@ -140,7 +141,7 @@ def sentry_handler(aws_event, aws_context, *args, **kwargs):
                 headers = {}
             transaction = Transaction.continue_from_headers(
                 headers,
-                op="serverless.function",
+                op=OP.FUNCTION_AWS,
                 name=aws_context.function_name,
                 source=TRANSACTION_SOURCE_COMPONENT,
             )

sentry_sdk/integrations/boto3.py

@@ -1,6 +1,7 @@
 from __future__ import absolute_import
 
 from sentry_sdk import Hub
+from sentry_sdk.consts import OP
 from sentry_sdk.integrations import Integration, DidNotEnable
 from sentry_sdk.tracing import Span
 
@@ -62,7 +63,7 @@ def _sentry_request_created(service_id, request, operation_name, **kwargs):
     description = "aws.%s.%s" % (service_id, operation_name)
     span = hub.start_span(
         hub=hub,
-        op="aws.request",
+        op=OP.HTTP_CLIENT,
         description=description,
     )
     span.set_tag("aws.service_id", service_id)
@@ -92,7 +93,7 @@ def _sentry_after_call(context, parsed, **kwargs):
         return
 
     streaming_span = span.start_child(
-        op="aws.request.stream",
+        op=OP.HTTP_CLIENT_STREAM,
         description=span.description,
     )
 

sentry_sdk/integrations/celery.py

@@ -1,6 +1,7 @@
 from __future__ import absolute_import
 
 import sys
+from sentry_sdk.consts import OP
 
 from sentry_sdk.hub import Hub
 from sentry_sdk.tracing import TRANSACTION_SOURCE_TASK
@@ -103,7 +104,9 @@ def apply_async(*args, **kwargs):
         hub = Hub.current
         integration = hub.get_integration(CeleryIntegration)
         if integration is not None and integration.propagate_traces:
-            with hub.start_span(op="celery.submit", description=args[0].name) as span:
+            with hub.start_span(
+                op=OP.QUEUE_SUBMIT_CELERY, description=args[0].name
+            ) as span:
                 with capture_internal_exceptions():
                     headers = dict(hub.iter_trace_propagation_headers(span))
 
@@ -156,7 +159,7 @@ def _inner(*args, **kwargs):
             with capture_internal_exceptions():
                 transaction = Transaction.continue_from_headers(
                     args[3].get("headers") or {},
-                    op="celery.task",
+                    op=OP.QUEUE_TASK_CELERY,
                     name="unknown celery task",
                     source=TRANSACTION_SOURCE_TASK,
                 )

sentry_sdk/integrations/django/__init__.py

@@ -6,6 +6,7 @@
 import weakref
 
 from sentry_sdk._types import MYPY
+from sentry_sdk.consts import OP
 from sentry_sdk.hub import Hub, _should_send_default_pii
 from sentry_sdk.scope import add_global_event_processor
 from sentry_sdk.serializer import add_global_repr_processor
@@ -581,7 +582,7 @@ def connect(self):
         with capture_internal_exceptions():
             hub.add_breadcrumb(message="connect", category="query")
 
-        with hub.start_span(op="db", description="connect"):
+        with hub.start_span(op=OP.DB, description="connect"):
             return real_connect(self)
 
     CursorWrapper.execute = execute

sentry_sdk/integrations/django/asgi.py

@@ -10,6 +10,7 @@
 
 from sentry_sdk import Hub, _functools
 from sentry_sdk._types import MYPY
+from sentry_sdk.consts import OP
 
 from sentry_sdk.integrations.asgi import SentryAsgiMiddleware
 
@@ -89,7 +90,7 @@ async def sentry_wrapped_callback(request, *args, **kwargs):
         # type: (Any, *Any, **Any) -> Any
 
         with hub.start_span(
-            op="django.view", description=request.resolver_match.view_name
+            op=OP.VIEW_RENDER, description=request.resolver_match.view_name
         ):
             return await callback(request, *args, **kwargs)
 

sentry_sdk/integrations/django/middleware.py

@@ -7,6 +7,7 @@
 from sentry_sdk import Hub
 from sentry_sdk._functools import wraps
 from sentry_sdk._types import MYPY
+from sentry_sdk.consts import OP
 from sentry_sdk.utils import (
     ContextVar,
     transaction_from_function,
@@ -88,7 +89,7 @@ def _check_middleware_span(old_method):
             description = "{}.{}".format(description, function_basename)
 
         middleware_span = hub.start_span(
-            op="django.middleware", description=description
+            op=OP.MIDDLEWARE_DJANGO, description=description
         )
         middleware_span.set_tag("django.function_name", function_name)
         middleware_span.set_tag("django.middleware_name", middleware_name)

sentry_sdk/integrations/django/signals_handlers.py

@@ -5,6 +5,7 @@
 
 from sentry_sdk import Hub
 from sentry_sdk._types import MYPY
+from sentry_sdk.consts import OP
 
 
 if MYPY:
@@ -50,7 +51,7 @@ def wrapper(*args, **kwargs):
                 # type: (Any, Any) -> Any
                 signal_name = _get_receiver_name(receiver)
                 with hub.start_span(
-                    op="django.signals",
+                    op=OP.EVENT_DJANGO,
                     description=signal_name,
                 ) as span:
                     span.set_data("signal", signal_name)

sentry_sdk/integrations/django/templates.py

@@ -3,6 +3,7 @@
 
 from sentry_sdk import _functools, Hub
 from sentry_sdk._types import MYPY
+from sentry_sdk.consts import OP
 
 if MYPY:
     from typing import Any
@@ -66,7 +67,7 @@ def rendered_content(self):
             return real_rendered_content.fget(self)
 
         with hub.start_span(
-            op="django.template.render",
+            op=OP.TEMPLATE_RENDER,
             description=_get_template_name_description(self.template_name),
         ) as span:
             span.set_data("context", self.context_data)
@@ -88,7 +89,7 @@ def render(request, template_name, context=None, *args, **kwargs):
             return real_render(request, template_name, context, *args, **kwargs)
 
         with hub.start_span(
-            op="django.template.render",
+            op=OP.TEMPLATE_RENDER,
             description=_get_template_name_description(template_name),
         ) as span:
             span.set_data("context", context)

sentry_sdk/integrations/django/views.py

@@ -1,3 +1,4 @@
+from sentry_sdk.consts import OP
 from sentry_sdk.hub import Hub
 from sentry_sdk._types import MYPY
 from sentry_sdk import _functools
@@ -62,7 +63,7 @@ def _wrap_sync_view(hub, callback):
     def sentry_wrapped_callback(request, *args, **kwargs):
         # type: (Any, *Any, **Any) -> Any
         with hub.start_span(
-            op="django.view", description=request.resolver_match.view_name
+            op=OP.VIEW_RENDER, description=request.resolver_match.view_name
         ):
             return callback(request, *args, **kwargs)
 

sentry_sdk/integrations/gcp.py

@@ -1,6 +1,7 @@
 from datetime import datetime, timedelta
 from os import environ
 import sys
+from sentry_sdk.consts import OP
 
 from sentry_sdk.hub import Hub, _should_send_default_pii
 from sentry_sdk.tracing import TRANSACTION_SOURCE_COMPONENT, Transaction
@@ -82,7 +83,7 @@ def sentry_func(functionhandler, gcp_event, *args, **kwargs):
                 headers = gcp_event.headers
             transaction = Transaction.continue_from_headers(
                 headers,
-                op="serverless.function",
+                op=OP.FUNCTION_GCP,
                 name=environ.get("FUNCTION_NAME", ""),
                 source=TRANSACTION_SOURCE_COMPONENT,
             )

sentry_sdk/integrations/httpx.py

@@ -1,4 +1,5 @@
 from sentry_sdk import Hub
+from sentry_sdk.consts import OP
 from sentry_sdk.integrations import Integration, DidNotEnable
 from sentry_sdk.utils import logger
 
@@ -41,7 +42,7 @@ def send(self, request, **kwargs):
             return real_send(self, request, **kwargs)
 
         with hub.start_span(
-            op="http", description="%s %s" % (request.method, request.url)
+            op=OP.HTTP_CLIENT, description="%s %s" % (request.method, request.url)
         ) as span:
             span.set_data("method", request.method)
             span.set_data("url", str(request.url))
@@ -73,7 +74,7 @@ async def send(self, request, **kwargs):
             return await real_send(self, request, **kwargs)
 
         with hub.start_span(
-            op="http", description="%s %s" % (request.method, request.url)
+            op=OP.HTTP_CLIENT, description="%s %s" % (request.method, request.url)
         ) as span:
             span.set_data("method", request.method)
             span.set_data("url", str(request.url))

sentry_sdk/integrations/redis.py

@@ -1,6 +1,7 @@
 from __future__ import absolute_import
 
 from sentry_sdk import Hub
+from sentry_sdk.consts import OP
 from sentry_sdk.utils import capture_internal_exceptions, logger
 from sentry_sdk.integrations import Integration, DidNotEnable
 
@@ -29,7 +30,9 @@ def sentry_patched_execute(self, *args, **kwargs):
         if hub.get_integration(RedisIntegration) is None:
             return old_execute(self, *args, **kwargs)
 
-        with hub.start_span(op="redis", description="redis.pipeline.execute") as span:
+        with hub.start_span(
+            op=OP.DB_REDIS, description="redis.pipeline.execute"
+        ) as span:
             with capture_internal_exceptions():
                 span.set_tag("redis.is_cluster", is_cluster)
                 transaction = self.transaction if not is_cluster else False
@@ -152,7 +155,7 @@ def sentry_patched_execute_command(self, name, *args, **kwargs):
 
             description = " ".join(description_parts)
 
-        with hub.start_span(op="redis", description=description) as span:
+        with hub.start_span(op=OP.DB_REDIS, description=description) as span:
             span.set_tag("redis.is_cluster", is_cluster)
             if name:
                 span.set_tag("redis.command", name)

sentry_sdk/integrations/rq.py

@@ -1,6 +1,7 @@
 from __future__ import absolute_import
 
 import weakref
+from sentry_sdk.consts import OP
 
 from sentry_sdk.hub import Hub
 from sentry_sdk.integrations import DidNotEnable, Integration
@@ -61,7 +62,7 @@ def sentry_patched_perform_job(self, job, *args, **kwargs):
 
                 transaction = Transaction.continue_from_headers(
                     job.meta.get("_sentry_trace_headers") or {},
-                    op="rq.task",
+                    op=OP.QUEUE_TASK_RQ,
                     name="unknown RQ task",
                     source=TRANSACTION_SOURCE_TASK,
                 )

sentry_sdk/integrations/starlette.py

@@ -5,6 +5,7 @@
 
 from sentry_sdk._compat import iteritems
 from sentry_sdk._types import MYPY
+from sentry_sdk.consts import OP
 from sentry_sdk.hub import Hub, _should_send_default_pii
 from sentry_sdk.integrations import DidNotEnable, Integration
 from sentry_sdk.integrations._wsgi_common import (
@@ -91,7 +92,7 @@ async def _create_span_call(*args, **kwargs):
         if integration is not None:
             middleware_name = args[0].__class__.__name__
             with hub.start_span(
-                op="starlette.middleware", description=middleware_name
+                op=OP.MIDDLEWARE_STARLETTE, description=middleware_name
             ) as middleware_span:
                 middleware_span.set_tag("starlette.middleware_name", middleware_name)