ref(tracing): Move TRANSACTION_SOURCE_* constants to Enum (#3889)

Change the `TRANSACTION_SOURCE_*` constants defined in `tracing.py` to be enums, for better developer experience. 

Fixes GH-2696

---------

Co-authored-by: Anton Pirker <[email protected]>

Author: mgaligniana

CHANGELOG.md

@@ -2328,7 +2328,7 @@ By: @mgaligniana (#1773)
 
   import sentry_sdk
   from sentry_sdk.integrations.arq import ArqIntegration
-  from sentry_sdk.tracing import TRANSACTION_SOURCE_COMPONENT
+  from sentry_sdk.tracing import TransactionSource
 
   sentry_sdk.init(
       dsn="...",
@@ -2348,7 +2348,7 @@ By: @mgaligniana (#1773)
       await ctx['session'].aclose()
 
   async def main():
-      with sentry_sdk.start_transaction(name="testing_arq_tasks", source=TRANSACTION_SOURCE_COMPONENT):
+      with sentry_sdk.start_transaction(name="testing_arq_tasks", source=TransactionSource.COMPONENT):
           redis = await create_pool(RedisSettings())
           for url in ('https://facebook.com', 'https://microsoft.com', 'https://github.com', "asdf"
                       ):
@@ -2422,7 +2422,7 @@ By: @mgaligniana (#1773)
 
   import sentry_sdk
   from sentry_sdk.integrations.huey import HueyIntegration
-  from sentry_sdk.tracing import TRANSACTION_SOURCE_COMPONENT, Transaction
+  from sentry_sdk.tracing import TransactionSource, Transaction
 
 
   def main():
@@ -2434,7 +2434,7 @@ By: @mgaligniana (#1773)
           traces_sample_rate=1.0,
       )
 
-      with sentry_sdk.start_transaction(name="testing_huey_tasks", source=TRANSACTION_SOURCE_COMPONENT):
+      with sentry_sdk.start_transaction(name="testing_huey_tasks", source=TransactionSource.COMPONENT):
           r = add_numbers(1, 2)
 
   if __name__ == "__main__":

sentry_sdk/integrations/aiohttp.py

@@ -20,7 +20,7 @@
 from sentry_sdk.tracing import (
     BAGGAGE_HEADER_NAME,
     SOURCE_FOR_STYLE,
-    TRANSACTION_SOURCE_ROUTE,
+    TransactionSource,
 )
 from sentry_sdk.tracing_utils import should_propagate_trace
 from sentry_sdk.utils import (
@@ -129,7 +129,7 @@ async def sentry_app_handle(self, request, *args, **kwargs):
                         # 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",
-                        source=TRANSACTION_SOURCE_ROUTE,
+                        source=TransactionSource.ROUTE,
                         origin=AioHttpIntegration.origin,
                     )
                     with sentry_sdk.start_transaction(

sentry_sdk/integrations/arq.py

@@ -5,7 +5,7 @@
 from sentry_sdk.integrations import _check_minimum_version, DidNotEnable, Integration
 from sentry_sdk.integrations.logging import ignore_logger
 from sentry_sdk.scope import should_send_default_pii
-from sentry_sdk.tracing import Transaction, TRANSACTION_SOURCE_TASK
+from sentry_sdk.tracing import Transaction, TransactionSource
 from sentry_sdk.utils import (
     capture_internal_exceptions,
     ensure_integration_enabled,
@@ -102,7 +102,7 @@ async def _sentry_run_job(self, job_id, score):
                 name="unknown arq task",
                 status="ok",
                 op=OP.QUEUE_TASK_ARQ,
-                source=TRANSACTION_SOURCE_TASK,
+                source=TransactionSource.TASK,
                 origin=ArqIntegration.origin,
             )
 

sentry_sdk/integrations/asgi.py

@@ -25,10 +25,7 @@
 from sentry_sdk.sessions import track_session
 from sentry_sdk.tracing import (
     SOURCE_FOR_STYLE,
-    TRANSACTION_SOURCE_ROUTE,
-    TRANSACTION_SOURCE_URL,
-    TRANSACTION_SOURCE_COMPONENT,
-    TRANSACTION_SOURCE_CUSTOM,
+    TransactionSource,
 )
 from sentry_sdk.utils import (
     ContextVar,
@@ -273,9 +270,9 @@ def event_processor(self, event, hint, asgi_scope):
         already_set = event["transaction"] != _DEFAULT_TRANSACTION_NAME and event[
             "transaction_info"
         ].get("source") in [
-            TRANSACTION_SOURCE_COMPONENT,
-            TRANSACTION_SOURCE_ROUTE,
-            TRANSACTION_SOURCE_CUSTOM,
+            TransactionSource.COMPONENT,
+            TransactionSource.ROUTE,
+            TransactionSource.CUSTOM,
         ]
         if not already_set:
             name, source = self._get_transaction_name_and_source(
@@ -313,7 +310,7 @@ def _get_transaction_name_and_source(self, transaction_style, asgi_scope):
                 name = transaction_from_function(endpoint) or ""
             else:
                 name = _get_url(asgi_scope, "http" if ty == "http" else "ws", host=None)
-                source = TRANSACTION_SOURCE_URL
+                source = TransactionSource.URL
 
         elif transaction_style == "url":
             # FastAPI includes the route object in the scope to let Sentry extract the
@@ -325,11 +322,11 @@ def _get_transaction_name_and_source(self, transaction_style, asgi_scope):
                     name = path
             else:
                 name = _get_url(asgi_scope, "http" if ty == "http" else "ws", host=None)
-                source = TRANSACTION_SOURCE_URL
+                source = TransactionSource.URL
 
         if name is None:
             name = _DEFAULT_TRANSACTION_NAME
-            source = TRANSACTION_SOURCE_ROUTE
+            source = TransactionSource.ROUTE
             return name, source
 
         return name, source

sentry_sdk/integrations/aws_lambda.py

@@ -10,7 +10,7 @@
 from sentry_sdk.api import continue_trace
 from sentry_sdk.consts import OP
 from sentry_sdk.scope import should_send_default_pii
-from sentry_sdk.tracing import TRANSACTION_SOURCE_COMPONENT
+from sentry_sdk.tracing import TransactionSource
 from sentry_sdk.utils import (
     AnnotatedValue,
     capture_internal_exceptions,
@@ -153,7 +153,7 @@ def sentry_handler(aws_event, aws_context, *args, **kwargs):
                 headers,
                 op=OP.FUNCTION_AWS,
                 name=aws_context.function_name,
-                source=TRANSACTION_SOURCE_COMPONENT,
+                source=TransactionSource.COMPONENT,
                 origin=AwsLambdaIntegration.origin,
             )
             with sentry_sdk.start_transaction(

sentry_sdk/integrations/celery/__init__.py

@@ -14,7 +14,7 @@
 )
 from sentry_sdk.integrations.celery.utils import _now_seconds_since_epoch
 from sentry_sdk.integrations.logging import ignore_logger
-from sentry_sdk.tracing import BAGGAGE_HEADER_NAME, TRANSACTION_SOURCE_TASK
+from sentry_sdk.tracing import BAGGAGE_HEADER_NAME, TransactionSource
 from sentry_sdk.tracing_utils import Baggage
 from sentry_sdk.utils import (
     capture_internal_exceptions,
@@ -319,7 +319,7 @@ def _inner(*args, **kwargs):
                     headers,
                     op=OP.QUEUE_TASK_CELERY,
                     name="unknown celery task",
-                    source=TRANSACTION_SOURCE_TASK,
+                    source=TransactionSource.TASK,
                     origin=CeleryIntegration.origin,
                 )
                 transaction.name = task.name

sentry_sdk/integrations/chalice.py

@@ -4,7 +4,7 @@
 import sentry_sdk
 from sentry_sdk.integrations import Integration, DidNotEnable
 from sentry_sdk.integrations.aws_lambda import _make_request_event_processor
-from sentry_sdk.tracing import TRANSACTION_SOURCE_COMPONENT
+from sentry_sdk.tracing import TransactionSource
 from sentry_sdk.utils import (
     capture_internal_exceptions,
     event_from_exception,
@@ -67,7 +67,7 @@ def wrapped_view_function(**function_args):
                 configured_time = app.lambda_context.get_remaining_time_in_millis()
                 scope.set_transaction_name(
                     app.lambda_context.function_name,
-                    source=TRANSACTION_SOURCE_COMPONENT,
+                    source=TransactionSource.COMPONENT,
                 )
 
                 scope.add_event_processor(

sentry_sdk/integrations/django/__init__.py

@@ -8,7 +8,7 @@
 from sentry_sdk.consts import OP, SPANDATA
 from sentry_sdk.scope import add_global_event_processor, should_send_default_pii
 from sentry_sdk.serializer import add_global_repr_processor
-from sentry_sdk.tracing import SOURCE_FOR_STYLE, TRANSACTION_SOURCE_URL
+from sentry_sdk.tracing import SOURCE_FOR_STYLE, TransactionSource
 from sentry_sdk.tracing_utils import add_query_source, record_sql_queries
 from sentry_sdk.utils import (
     AnnotatedValue,
@@ -398,7 +398,7 @@ def _set_transaction_name_and_source(scope, transaction_style, request):
 
         if transaction_name is None:
             transaction_name = request.path_info
-            source = TRANSACTION_SOURCE_URL
+            source = TransactionSource.URL
         else:
             source = SOURCE_FOR_STYLE[transaction_style]
 

sentry_sdk/integrations/fastapi.py

@@ -5,7 +5,7 @@
 import sentry_sdk
 from sentry_sdk.integrations import DidNotEnable
 from sentry_sdk.scope import should_send_default_pii
-from sentry_sdk.tracing import SOURCE_FOR_STYLE, TRANSACTION_SOURCE_ROUTE
+from sentry_sdk.tracing import SOURCE_FOR_STYLE, TransactionSource
 from sentry_sdk.utils import (
     transaction_from_function,
     logger,
@@ -61,7 +61,7 @@ def _set_transaction_name_and_source(scope, transaction_style, request):
 
     if not name:
         name = _DEFAULT_TRANSACTION_NAME
-        source = TRANSACTION_SOURCE_ROUTE
+        source = TransactionSource.ROUTE
     else:
         source = SOURCE_FOR_STYLE[transaction_style]
 

sentry_sdk/integrations/gcp.py

@@ -10,7 +10,7 @@
 from sentry_sdk.integrations import Integration
 from sentry_sdk.integrations._wsgi_common import _filter_headers
 from sentry_sdk.scope import should_send_default_pii
-from sentry_sdk.tracing import TRANSACTION_SOURCE_COMPONENT
+from sentry_sdk.tracing import TransactionSource
 from sentry_sdk.utils import (
     AnnotatedValue,
     capture_internal_exceptions,
@@ -88,7 +88,7 @@ def sentry_func(functionhandler, gcp_event, *args, **kwargs):
                 headers,
                 op=OP.FUNCTION_GCP,
                 name=environ.get("FUNCTION_NAME", ""),
-                source=TRANSACTION_SOURCE_COMPONENT,
+                source=TransactionSource.COMPONENT,
                 origin=GcpIntegration.origin,
             )
             sampling_context = {

sentry_sdk/integrations/grpc/aio/server.py

@@ -2,7 +2,7 @@
 from sentry_sdk.consts import OP
 from sentry_sdk.integrations import DidNotEnable
 from sentry_sdk.integrations.grpc.consts import SPAN_ORIGIN
-from sentry_sdk.tracing import Transaction, TRANSACTION_SOURCE_CUSTOM
+from sentry_sdk.tracing import Transaction, TransactionSource
 from sentry_sdk.utils import event_from_exception
 
 from typing import TYPE_CHECKING
@@ -48,7 +48,7 @@ async def wrapped(request, context):
                     dict(context.invocation_metadata()),
                     op=OP.GRPC_SERVER,
                     name=name,
-                    source=TRANSACTION_SOURCE_CUSTOM,
+                    source=TransactionSource.CUSTOM,
                     origin=SPAN_ORIGIN,
                 )
 

sentry_sdk/integrations/grpc/server.py

@@ -2,7 +2,7 @@
 from sentry_sdk.consts import OP
 from sentry_sdk.integrations import DidNotEnable
 from sentry_sdk.integrations.grpc.consts import SPAN_ORIGIN
-from sentry_sdk.tracing import Transaction, TRANSACTION_SOURCE_CUSTOM
+from sentry_sdk.tracing import Transaction, TransactionSource
 
 from typing import TYPE_CHECKING
 
@@ -42,7 +42,7 @@ def behavior(request, context):
                         metadata,
                         op=OP.GRPC_SERVER,
                         name=name,
-                        source=TRANSACTION_SOURCE_CUSTOM,
+                        source=TransactionSource.CUSTOM,
                         origin=SPAN_ORIGIN,
                     )
 

sentry_sdk/integrations/huey.py

@@ -9,7 +9,7 @@
 from sentry_sdk.tracing import (
     BAGGAGE_HEADER_NAME,
     SENTRY_TRACE_HEADER_NAME,
-    TRANSACTION_SOURCE_TASK,
+    TransactionSource,
 )
 from sentry_sdk.utils import (
     capture_internal_exceptions,
@@ -159,7 +159,7 @@ def _sentry_execute(self, task, timestamp=None):
                 sentry_headers or {},
                 name=task.name,
                 op=OP.QUEUE_TASK_HUEY,
-                source=TRANSACTION_SOURCE_TASK,
+                source=TransactionSource.TASK,
                 origin=HueyIntegration.origin,
             )
             transaction.set_status(SPANSTATUS.OK)

sentry_sdk/integrations/litestar.py

@@ -9,7 +9,7 @@
 from sentry_sdk.integrations.asgi import SentryAsgiMiddleware
 from sentry_sdk.integrations.logging import ignore_logger
 from sentry_sdk.scope import should_send_default_pii
-from sentry_sdk.tracing import SOURCE_FOR_STYLE, TRANSACTION_SOURCE_ROUTE
+from sentry_sdk.tracing import TransactionSource, SOURCE_FOR_STYLE
 from sentry_sdk.utils import (
     ensure_integration_enabled,
     event_from_exception,
@@ -249,7 +249,7 @@ def event_processor(event, _):
 
             if not tx_name:
                 tx_name = _DEFAULT_TRANSACTION_NAME
-                tx_info = {"source": TRANSACTION_SOURCE_ROUTE}
+                tx_info = {"source": TransactionSource.ROUTE}
 
             event.update(
                 {

sentry_sdk/integrations/ray.py

@@ -4,7 +4,7 @@
 import sentry_sdk
 from sentry_sdk.consts import OP, SPANSTATUS
 from sentry_sdk.integrations import _check_minimum_version, DidNotEnable, Integration
-from sentry_sdk.tracing import TRANSACTION_SOURCE_TASK
+from sentry_sdk.tracing import TransactionSource
 from sentry_sdk.utils import (
     event_from_exception,
     logger,
@@ -63,7 +63,7 @@ def _f(*f_args, _tracing=None, **f_kwargs):
                 op=OP.QUEUE_TASK_RAY,
                 name=qualname_from_function(f),
                 origin=RayIntegration.origin,
-                source=TRANSACTION_SOURCE_TASK,
+                source=TransactionSource.TASK,
             )
 
             with sentry_sdk.start_transaction(transaction) as transaction:

sentry_sdk/integrations/rq.py

@@ -5,7 +5,7 @@
 from sentry_sdk.api import continue_trace
 from sentry_sdk.integrations import _check_minimum_version, DidNotEnable, Integration
 from sentry_sdk.integrations.logging import ignore_logger
-from sentry_sdk.tracing import TRANSACTION_SOURCE_TASK
+from sentry_sdk.tracing import TransactionSource
 from sentry_sdk.utils import (
     capture_internal_exceptions,
     ensure_integration_enabled,
@@ -57,7 +57,7 @@ def sentry_patched_perform_job(self, job, *args, **kwargs):
                     job.meta.get("_sentry_trace_headers") or {},
                     op=OP.QUEUE_TASK_RQ,
                     name="unknown RQ task",
-                    source=TRANSACTION_SOURCE_TASK,
+                    source=TransactionSource.TASK,
                     origin=RqIntegration.origin,
                 )
 

sentry_sdk/integrations/sanic.py

@@ -9,7 +9,7 @@
 from sentry_sdk.integrations import _check_minimum_version, Integration, DidNotEnable
 from sentry_sdk.integrations._wsgi_common import RequestExtractor, _filter_headers
 from sentry_sdk.integrations.logging import ignore_logger
-from sentry_sdk.tracing import TRANSACTION_SOURCE_COMPONENT, TRANSACTION_SOURCE_URL
+from sentry_sdk.tracing import TransactionSource
 from sentry_sdk.utils import (
     capture_internal_exceptions,
     ensure_integration_enabled,
@@ -192,7 +192,7 @@ async def _context_enter(request):
         op=OP.HTTP_SERVER,
         # Unless the request results in a 404 error, the name and source will get overwritten in _set_transaction
         name=request.path,
-        source=TRANSACTION_SOURCE_URL,
+        source=TransactionSource.URL,
         origin=SanicIntegration.origin,
     )
     request.ctx._sentry_transaction = sentry_sdk.start_transaction(
@@ -229,7 +229,7 @@ async def _set_transaction(request, route, **_):
         with capture_internal_exceptions():
             scope = sentry_sdk.get_current_scope()
             route_name = route.name.replace(request.app.name, "").strip(".")
-            scope.set_transaction_name(route_name, source=TRANSACTION_SOURCE_COMPONENT)
+            scope.set_transaction_name(route_name, source=TransactionSource.COMPONENT)
 
 
 def _sentry_error_handler_lookup(self, exception, *args, **kwargs):
@@ -304,11 +304,11 @@ def _legacy_router_get(self, *args):
                     sanic_route = sanic_route[len(sanic_app_name) + 1 :]
 
                 scope.set_transaction_name(
-                    sanic_route, source=TRANSACTION_SOURCE_COMPONENT
+                    sanic_route, source=TransactionSource.COMPONENT
                 )
             else:
                 scope.set_transaction_name(
-                    rv[0].__name__, source=TRANSACTION_SOURCE_COMPONENT
+                    rv[0].__name__, source=TransactionSource.COMPONENT
                 )
 
     return rv