Skip to content

Commit 79f20d7

Browse files
mgalignianamgaligniana
committed
ref(tracing): Move TRANSACTION_SOURCE_* constants to Enum
Fixes GH-2696
1 parent bb85c26 commit 79f20d7

27 files changed

+97
-99
lines changed

Diff for: ‎CHANGELOG.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -2226,7 +2226,7 @@ By: @mgaligniana (#1773)
22262226

22272227
import sentry_sdk
22282228
from sentry_sdk.integrations.arq import ArqIntegration
2229-
from sentry_sdk.tracing import TRANSACTION_SOURCE_COMPONENT
2229+
from sentry_sdk.tracing import TransactionSource
22302230

22312231
sentry_sdk.init(
22322232
dsn="...",
@@ -2246,7 +2246,7 @@ By: @mgaligniana (#1773)
22462246
await ctx['session'].aclose()
22472247

22482248
async def main():
2249-
with sentry_sdk.start_transaction(name="testing_arq_tasks", source=TRANSACTION_SOURCE_COMPONENT):
2249+
with sentry_sdk.start_transaction(name="testing_arq_tasks", source=TransactionSource.COMPONENT.value):
22502250
redis = await create_pool(RedisSettings())
22512251
for url in ('https://facebook.com', 'https://microsoft.com', 'https://github.com', "asdf"
22522252
):
@@ -2320,7 +2320,7 @@ By: @mgaligniana (#1773)
23202320

23212321
import sentry_sdk
23222322
from sentry_sdk.integrations.huey import HueyIntegration
2323-
from sentry_sdk.tracing import TRANSACTION_SOURCE_COMPONENT, Transaction
2323+
from sentry_sdk.tracing import TransactionSource, Transaction
23242324

23252325

23262326
def main():
@@ -2332,7 +2332,7 @@ By: @mgaligniana (#1773)
23322332
traces_sample_rate=1.0,
23332333
)
23342334

2335-
with sentry_sdk.start_transaction(name="testing_huey_tasks", source=TRANSACTION_SOURCE_COMPONENT):
2335+
with sentry_sdk.start_transaction(name="testing_huey_tasks", source=TransactionSource.COMPONENT.value):
23362336
r = add_numbers(1, 2)
23372337

23382338
if __name__ == "__main__":

Diff for: ‎sentry_sdk/integrations/aiohttp.py

+2-2
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@
1919
from sentry_sdk.tracing import (
2020
BAGGAGE_HEADER_NAME,
2121
SOURCE_FOR_STYLE,
22-
TRANSACTION_SOURCE_ROUTE,
22+
TransactionSource,
2323
)
2424
from sentry_sdk.tracing_utils import should_propagate_trace
2525
from sentry_sdk.utils import (
@@ -133,7 +133,7 @@ async def sentry_app_handle(self, request, *args, **kwargs):
133133
# If this transaction name makes it to the UI, AIOHTTP's
134134
# URL resolver did not find a route or died trying.
135135
name="generic AIOHTTP request",
136-
source=TRANSACTION_SOURCE_ROUTE,
136+
source=TransactionSource.ROUTE.value,
137137
origin=AioHttpIntegration.origin,
138138
)
139139
with sentry_sdk.start_transaction(

Diff for: ‎sentry_sdk/integrations/arq.py

+2-2
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
from sentry_sdk.integrations import DidNotEnable, Integration
66
from sentry_sdk.integrations.logging import ignore_logger
77
from sentry_sdk.scope import should_send_default_pii
8-
from sentry_sdk.tracing import Transaction, TRANSACTION_SOURCE_TASK
8+
from sentry_sdk.tracing import Transaction, TransactionSource
99
from sentry_sdk.utils import (
1010
capture_internal_exceptions,
1111
ensure_integration_enabled,
@@ -104,7 +104,7 @@ async def _sentry_run_job(self, job_id, score):
104104
name="unknown arq task",
105105
status="ok",
106106
op=OP.QUEUE_TASK_ARQ,
107-
source=TRANSACTION_SOURCE_TASK,
107+
source=TransactionSource.TASK.value,
108108
origin=ArqIntegration.origin,
109109
)
110110

Diff for: ‎sentry_sdk/integrations/asgi.py

+7-10
Original file line numberDiff line numberDiff line change
@@ -25,10 +25,7 @@
2525
from sentry_sdk.sessions import track_session
2626
from sentry_sdk.tracing import (
2727
SOURCE_FOR_STYLE,
28-
TRANSACTION_SOURCE_ROUTE,
29-
TRANSACTION_SOURCE_URL,
30-
TRANSACTION_SOURCE_COMPONENT,
31-
TRANSACTION_SOURCE_CUSTOM,
28+
TransactionSource,
3229
)
3330
from sentry_sdk.utils import (
3431
ContextVar,
@@ -273,9 +270,9 @@ def event_processor(self, event, hint, asgi_scope):
273270
already_set = event["transaction"] != _DEFAULT_TRANSACTION_NAME and event[
274271
"transaction_info"
275272
].get("source") in [
276-
TRANSACTION_SOURCE_COMPONENT,
277-
TRANSACTION_SOURCE_ROUTE,
278-
TRANSACTION_SOURCE_CUSTOM,
273+
TransactionSource.COMPONENT.value,
274+
TransactionSource.ROUTE.value,
275+
TransactionSource.CUSTOM.value,
279276
]
280277
if not already_set:
281278
name, source = self._get_transaction_name_and_source(
@@ -313,7 +310,7 @@ def _get_transaction_name_and_source(self, transaction_style, asgi_scope):
313310
name = transaction_from_function(endpoint) or ""
314311
else:
315312
name = _get_url(asgi_scope, "http" if ty == "http" else "ws", host=None)
316-
source = TRANSACTION_SOURCE_URL
313+
source = TransactionSource.URL.value
317314

318315
elif transaction_style == "url":
319316
# 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):
325322
name = path
326323
else:
327324
name = _get_url(asgi_scope, "http" if ty == "http" else "ws", host=None)
328-
source = TRANSACTION_SOURCE_URL
325+
source = TransactionSource.URL.value
329326

330327
if name is None:
331328
name = _DEFAULT_TRANSACTION_NAME
332-
source = TRANSACTION_SOURCE_ROUTE
329+
source = TransactionSource.ROUTE.value
333330
return name, source
334331

335332
return name, source

Diff for: ‎sentry_sdk/integrations/aws_lambda.py

+2-2
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010
from sentry_sdk.api import continue_trace
1111
from sentry_sdk.consts import OP
1212
from sentry_sdk.scope import should_send_default_pii
13-
from sentry_sdk.tracing import TRANSACTION_SOURCE_COMPONENT
13+
from sentry_sdk.tracing import TransactionSource
1414
from sentry_sdk.utils import (
1515
AnnotatedValue,
1616
capture_internal_exceptions,
@@ -150,7 +150,7 @@ def sentry_handler(aws_event, aws_context, *args, **kwargs):
150150
headers,
151151
op=OP.FUNCTION_AWS,
152152
name=aws_context.function_name,
153-
source=TRANSACTION_SOURCE_COMPONENT,
153+
source=TransactionSource.COMPONENT.value,
154154
origin=AwsLambdaIntegration.origin,
155155
)
156156
with sentry_sdk.start_transaction(

Diff for: ‎sentry_sdk/integrations/celery/__init__.py

+2-2
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414
)
1515
from sentry_sdk.integrations.celery.utils import _now_seconds_since_epoch
1616
from sentry_sdk.integrations.logging import ignore_logger
17-
from sentry_sdk.tracing import BAGGAGE_HEADER_NAME, TRANSACTION_SOURCE_TASK
17+
from sentry_sdk.tracing import BAGGAGE_HEADER_NAME, TransactionSource
1818
from sentry_sdk.tracing_utils import Baggage
1919
from sentry_sdk.utils import (
2020
capture_internal_exceptions,
@@ -320,7 +320,7 @@ def _inner(*args, **kwargs):
320320
headers,
321321
op=OP.QUEUE_TASK_CELERY,
322322
name="unknown celery task",
323-
source=TRANSACTION_SOURCE_TASK,
323+
source=TransactionSource.TASK.value,
324324
origin=CeleryIntegration.origin,
325325
)
326326
transaction.name = task.name

Diff for: ‎sentry_sdk/integrations/chalice.py

+2-2
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
import sentry_sdk
55
from sentry_sdk.integrations import Integration, DidNotEnable
66
from sentry_sdk.integrations.aws_lambda import _make_request_event_processor
7-
from sentry_sdk.tracing import TRANSACTION_SOURCE_COMPONENT
7+
from sentry_sdk.tracing import TransactionSource
88
from sentry_sdk.utils import (
99
capture_internal_exceptions,
1010
event_from_exception,
@@ -67,7 +67,7 @@ def wrapped_view_function(**function_args):
6767
configured_time = app.lambda_context.get_remaining_time_in_millis()
6868
scope.set_transaction_name(
6969
app.lambda_context.function_name,
70-
source=TRANSACTION_SOURCE_COMPONENT,
70+
source=TransactionSource.COMPONENT.value,
7171
)
7272

7373
scope.add_event_processor(

Diff for: ‎sentry_sdk/integrations/django/__init__.py

+2-2
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
from sentry_sdk.consts import OP, SPANDATA
99
from sentry_sdk.scope import add_global_event_processor, should_send_default_pii
1010
from sentry_sdk.serializer import add_global_repr_processor
11-
from sentry_sdk.tracing import SOURCE_FOR_STYLE, TRANSACTION_SOURCE_URL
11+
from sentry_sdk.tracing import SOURCE_FOR_STYLE, TransactionSource
1212
from sentry_sdk.tracing_utils import add_query_source, record_sql_queries
1313
from sentry_sdk.utils import (
1414
AnnotatedValue,
@@ -400,7 +400,7 @@ def _set_transaction_name_and_source(scope, transaction_style, request):
400400

401401
if transaction_name is None:
402402
transaction_name = request.path_info
403-
source = TRANSACTION_SOURCE_URL
403+
source = TransactionSource.URL.value
404404
else:
405405
source = SOURCE_FOR_STYLE[transaction_style]
406406

Diff for: ‎sentry_sdk/integrations/fastapi.py

+2-2
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
import sentry_sdk
66
from sentry_sdk.integrations import DidNotEnable
77
from sentry_sdk.scope import should_send_default_pii
8-
from sentry_sdk.tracing import SOURCE_FOR_STYLE, TRANSACTION_SOURCE_ROUTE
8+
from sentry_sdk.tracing import SOURCE_FOR_STYLE, TransactionSource
99
from sentry_sdk.utils import (
1010
transaction_from_function,
1111
logger,
@@ -61,7 +61,7 @@ def _set_transaction_name_and_source(scope, transaction_style, request):
6161

6262
if not name:
6363
name = _DEFAULT_TRANSACTION_NAME
64-
source = TRANSACTION_SOURCE_ROUTE
64+
source = TransactionSource.ROUTE.value
6565
else:
6666
source = SOURCE_FOR_STYLE[transaction_style]
6767

Diff for: ‎sentry_sdk/integrations/gcp.py

+2-2
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010
from sentry_sdk.integrations import Integration
1111
from sentry_sdk.integrations._wsgi_common import _filter_headers
1212
from sentry_sdk.scope import should_send_default_pii
13-
from sentry_sdk.tracing import TRANSACTION_SOURCE_COMPONENT
13+
from sentry_sdk.tracing import TransactionSource
1414
from sentry_sdk.utils import (
1515
AnnotatedValue,
1616
capture_internal_exceptions,
@@ -88,7 +88,7 @@ def sentry_func(functionhandler, gcp_event, *args, **kwargs):
8888
headers,
8989
op=OP.FUNCTION_GCP,
9090
name=environ.get("FUNCTION_NAME", ""),
91-
source=TRANSACTION_SOURCE_COMPONENT,
91+
source=TransactionSource.COMPONENT.value,
9292
origin=GcpIntegration.origin,
9393
)
9494
sampling_context = {

Diff for: ‎sentry_sdk/integrations/grpc/aio/server.py

+2-2
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
from sentry_sdk.consts import OP
33
from sentry_sdk.integrations import DidNotEnable
44
from sentry_sdk.integrations.grpc.consts import SPAN_ORIGIN
5-
from sentry_sdk.tracing import Transaction, TRANSACTION_SOURCE_CUSTOM
5+
from sentry_sdk.tracing import Transaction, TransactionSource
66
from sentry_sdk.utils import event_from_exception
77

88
from typing import TYPE_CHECKING
@@ -48,7 +48,7 @@ async def wrapped(request, context):
4848
dict(context.invocation_metadata()),
4949
op=OP.GRPC_SERVER,
5050
name=name,
51-
source=TRANSACTION_SOURCE_CUSTOM,
51+
source=TransactionSource.CUSTOM.value,
5252
origin=SPAN_ORIGIN,
5353
)
5454

Diff for: ‎sentry_sdk/integrations/grpc/server.py

+2-2
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
from sentry_sdk.consts import OP
33
from sentry_sdk.integrations import DidNotEnable
44
from sentry_sdk.integrations.grpc.consts import SPAN_ORIGIN
5-
from sentry_sdk.tracing import Transaction, TRANSACTION_SOURCE_CUSTOM
5+
from sentry_sdk.tracing import Transaction, TransactionSource
66

77
from typing import TYPE_CHECKING
88

@@ -42,7 +42,7 @@ def behavior(request, context):
4242
metadata,
4343
op=OP.GRPC_SERVER,
4444
name=name,
45-
source=TRANSACTION_SOURCE_CUSTOM,
45+
source=TransactionSource.CUSTOM.value,
4646
origin=SPAN_ORIGIN,
4747
)
4848

Diff for: ‎sentry_sdk/integrations/huey.py

+2-2
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99
from sentry_sdk.tracing import (
1010
BAGGAGE_HEADER_NAME,
1111
SENTRY_TRACE_HEADER_NAME,
12-
TRANSACTION_SOURCE_TASK,
12+
TransactionSource,
1313
)
1414
from sentry_sdk.utils import (
1515
capture_internal_exceptions,
@@ -159,7 +159,7 @@ def _sentry_execute(self, task, timestamp=None):
159159
sentry_headers or {},
160160
name=task.name,
161161
op=OP.QUEUE_TASK_HUEY,
162-
source=TRANSACTION_SOURCE_TASK,
162+
source=TransactionSource.TASK.value,
163163
origin=HueyIntegration.origin,
164164
)
165165
transaction.set_status(SPANSTATUS.OK)

Diff for: ‎sentry_sdk/integrations/litestar.py

+2-2
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
from sentry_sdk.integrations.asgi import SentryAsgiMiddleware
55
from sentry_sdk.integrations.logging import ignore_logger
66
from sentry_sdk.scope import should_send_default_pii
7-
from sentry_sdk.tracing import SOURCE_FOR_STYLE, TRANSACTION_SOURCE_ROUTE
7+
from sentry_sdk.tracing import TransactionSource, SOURCE_FOR_STYLE
88
from sentry_sdk.utils import (
99
ensure_integration_enabled,
1010
event_from_exception,
@@ -237,7 +237,7 @@ def event_processor(event, _):
237237

238238
if not tx_name:
239239
tx_name = _DEFAULT_TRANSACTION_NAME
240-
tx_info = {"source": TRANSACTION_SOURCE_ROUTE}
240+
tx_info = {"source": TransactionSource.ROUTE.value}
241241

242242
event.update(
243243
{

Diff for: ‎sentry_sdk/integrations/ray.py

+2-2
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
import sentry_sdk
55
from sentry_sdk.consts import OP, SPANSTATUS
66
from sentry_sdk.integrations import DidNotEnable, Integration
7-
from sentry_sdk.tracing import TRANSACTION_SOURCE_TASK
7+
from sentry_sdk.tracing import TransactionSource
88
from sentry_sdk.utils import (
99
event_from_exception,
1010
logger,
@@ -63,7 +63,7 @@ def _f(*f_args, _tracing=None, **f_kwargs):
6363
op=OP.QUEUE_TASK_RAY,
6464
name=qualname_from_function(f),
6565
origin=RayIntegration.origin,
66-
source=TRANSACTION_SOURCE_TASK,
66+
source=TransactionSource.TASK.value,
6767
)
6868

6969
with sentry_sdk.start_transaction(transaction) as transaction:

Diff for: ‎sentry_sdk/integrations/rq.py

+2-2
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
from sentry_sdk.api import continue_trace
66
from sentry_sdk.integrations import DidNotEnable, Integration
77
from sentry_sdk.integrations.logging import ignore_logger
8-
from sentry_sdk.tracing import TRANSACTION_SOURCE_TASK
8+
from sentry_sdk.tracing import TransactionSource
99
from sentry_sdk.utils import (
1010
capture_internal_exceptions,
1111
ensure_integration_enabled,
@@ -63,7 +63,7 @@ def sentry_patched_perform_job(self, job, *args, **kwargs):
6363
job.meta.get("_sentry_trace_headers") or {},
6464
op=OP.QUEUE_TASK_RQ,
6565
name="unknown RQ task",
66-
source=TRANSACTION_SOURCE_TASK,
66+
source=TransactionSource.TASK.value,
6767
origin=RqIntegration.origin,
6868
)
6969

Diff for: ‎sentry_sdk/integrations/sanic.py

+7-5
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99
from sentry_sdk.integrations import Integration, DidNotEnable
1010
from sentry_sdk.integrations._wsgi_common import RequestExtractor, _filter_headers
1111
from sentry_sdk.integrations.logging import ignore_logger
12-
from sentry_sdk.tracing import TRANSACTION_SOURCE_COMPONENT, TRANSACTION_SOURCE_URL
12+
from sentry_sdk.tracing import TransactionSource
1313
from sentry_sdk.utils import (
1414
capture_internal_exceptions,
1515
ensure_integration_enabled,
@@ -198,7 +198,7 @@ async def _context_enter(request):
198198
op=OP.HTTP_SERVER,
199199
# Unless the request results in a 404 error, the name and source will get overwritten in _set_transaction
200200
name=request.path,
201-
source=TRANSACTION_SOURCE_URL,
201+
source=TransactionSource.URL.value,
202202
origin=SanicIntegration.origin,
203203
)
204204
request.ctx._sentry_transaction = sentry_sdk.start_transaction(
@@ -235,7 +235,9 @@ async def _set_transaction(request, route, **_):
235235
with capture_internal_exceptions():
236236
scope = sentry_sdk.get_current_scope()
237237
route_name = route.name.replace(request.app.name, "").strip(".")
238-
scope.set_transaction_name(route_name, source=TRANSACTION_SOURCE_COMPONENT)
238+
scope.set_transaction_name(
239+
route_name, source=TransactionSource.COMPONENT.value
240+
)
239241

240242

241243
def _sentry_error_handler_lookup(self, exception, *args, **kwargs):
@@ -310,11 +312,11 @@ def _legacy_router_get(self, *args):
310312
sanic_route = sanic_route[len(sanic_app_name) + 1 :]
311313

312314
scope.set_transaction_name(
313-
sanic_route, source=TRANSACTION_SOURCE_COMPONENT
315+
sanic_route, source=TransactionSource.COMPONENT.value
314316
)
315317
else:
316318
scope.set_transaction_name(
317-
rv[0].__name__, source=TRANSACTION_SOURCE_COMPONENT
319+
rv[0].__name__, source=TransactionSource.COMPONENT.value
318320
)
319321

320322
return rv

0 commit comments

Comments
 (0)