Sentry-Python 项目中 ASGI 集成覆盖自定义事务的问题解析

在 Sentry-Python 项目中，当开发者尝试为 FastAPI/Starlette 应用添加自定义事务（Transaction）时，可能会遇到 ASGI 集成层自动覆盖手动创建的事务的问题。本文将深入分析该问题的技术背景、产生原因及解决方案。

问题现象

开发者在 FastAPI 应用中通过以下方式创建自定义事务：

scope = sentry_sdk.get_current_scope()
transaction = scope.start_transaction(
    name="ttr",
    op="function",
    start_timestamp=timestamp,
)
scope.span = transaction

但最终在 Sentry 控制台看到的却是 ASGI 自动生成的 /sessions/{session_id} 事务名称（对应 WebSocket 端点），而非预期的 "ttr"。

技术背景

Sentry 事务机制

Sentry 的事务（Transaction）用于追踪代码执行路径和性能指标。在 Python SDK 中，可以通过以下两种方式创建：

1. 显式创建：通过 start_transaction() 方法
2. 框架自动创建：通过 ASGI/WSGI 等集成自动捕获 HTTP 请求

ASGI 集成的工作流程

ASGI 中间件会在请求处理前后自动创建事务，其核心逻辑包括：

1. 请求开始时创建根事务
2. 根据路由信息设置默认事务名称
3. 通过事件处理器（event_processor）最终确定事务属性

问题根源

在 asgi.py 的事件处理器中存在以下关键逻辑：

already_set = event["transaction"] != _DEFAULT_TRANSACTION_NAME and event[
    "transaction_info"
].get("source") in [
    TRANSACTION_SOURCE_COMPONENT,
    TRANSACTION_SOURCE_ROUTE,
]

这段代码错误地将 TRANSACTION_SOURCE_CUSTOM 类型的事务视为未设置状态，导致自定义事务名称被 ASGI 的默认命名规则覆盖。

解决方案

临时解决方案

对于不需要新建事务的场景，可以直接修改当前事务属性：

from sentry_sdk.tracing import TRANSACTION_SOURCE_CUSTOM

sentry_sdk.get_current_scope().set_transaction_name(
    "my_custom_transaction", 
    source=TRANSACTION_SOURCE_CUSTOM
)

长期解决方案

该问题已被确认为 Bug 并标记为已修复。建议升级到包含修复的 Sentry-Python 版本。

高级应用场景

对于 WebSocket 等高频率消息处理场景，建议通过采样控制减少性能开销：

def traces_sampler(sampling_context):
    if sampling_context["asgi_scope"]["type"] == "websocket":
        return 0.0  # 完全禁用 WebSocket 事务
    return 1.0

sentry_sdk.init(traces_sampler=traces_sampler)

最佳实践建议

1. 优先使用 set_transaction_name 而非手动创建事务
2. 对于性能敏感场景，合理配置采样率
3. 自定义事务时明确指定 source 参数
4. 定期更新 SDK 以获取最新的稳定性修复

通过理解这些底层机制，开发者可以更有效地利用 Sentry 进行应用性能监控和错误追踪。