Tracing does not work with ActiveController::Live actions
维护者通常 2 天内回复
@sl0thentr0py 已经在做这个了。
开始于 2024年7月25日。
评估
这个 Issue 还没有评估数据。
描述
Issue Description
ActiveController::Live is a Rails module to enable livestreaming of server responses. It's quite useful to do things like generating CSVs.
The way it works internally, however, makes it problematic to use with Sentry. ActionController::Live executes all actions in a separate thread from the original controller thread. This means that any Sentry traces will not work, as the middleware which starts a transaction only applies to a particular thread.
I was actually able to fix this by creating the following patch. It basically tells sentry to treat the spawned thread like it is a new part of a distributed trace. I'm not exactly familiar with this library, though, so it's sort of... Gross. There's probably a better way to do it.
module ActionControllerLiveSentryPatch
def new_controller_thread
opts = sentry_propagation_hash
super do
scope = Sentry.get_current_scope
transaction = scope && Sentry.start_transaction(
op: "action_controller.live_action",
name: scope.transaction_name,
source: scope.transaction_source,
**opts
)
scope&.set_span(transaction)
res = yield
transaction&.set_http_status(response&.status)
res
rescue StandardError
transaction&.set_http_status(500)
raise
ensure
transaction&.finish
end
end
def sentry_propagation_hash
context = Sentry.get_current_scope&.propagation_context
span = Sentry.get_current_scope&.get_span
return {} unless context && span
{
trace_id: span.trace_id,
parent_span_id: span.span_id,
parent_sampled: span.sampled
}.tap do |hash|
baggage_str = span.to_baggage
next unless baggage_str.present?
hash.merge!(baggage: Sentry::Baggage.from_incoming_header(baggage_str))
end
end
end
Reproduction Steps
- Create a Rails application
- Add sentry with tracing enabled
- Include
ActiveController::Livein some controller and add actions that would log to sentry (IE, they do DB queries or whatever) - Make requests against that controller
Expected Behavior
We should see traces from the controller action in Sentry.
Actual Behavior
We only see one overall HTTP trace in Sentry for the entire action, with no sub-traces.
Ruby Version
3.3.3
SDK Version
5.18.2
Integration and Its Version
Rails 5.18.2
Sentry Config
Sentry.init do |config|
config.dsn = ENV.fetch("SENTRY_DSN", nil)
config.breadcrumbs_logger = %i[active_support_logger]
# Set traces_sample_rate to 1.0 to capture 100%
# of transactions for performance monitoring.
# We recommend adjusting this value in production.
config.traces_sample_rate = 1
# Set profiles_sample_rate to profile 100%
# of sampled transactions.
# We recommend adjusting this value in production.
config.profiles_sample_rate = 1
config.logger = Logger.new($stdout)
config.logger.level = :debug
# config.enabled_environments = %w[production]
end
- 主要语言
- Ruby
- 星标
- 990
- 派生
- 552
- 平均合并
- 2 天 16 小时
- 30 天内合并 PR
- 29
环境准备
在浏览器里用你自己的 GitHub 账号启动这个项目的开发容器。
- 没有 Dockerfile 或 Docker Compose 文件
- 有 Pull Request 模板
- 阅读贡献指南
从这里开始
- 先读完整个 Issue,再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库,在一个分支上完成修改。
- 提交 Pull Request,并在描述里引用这个 Issue 编号。
getsentry/sentry-ruby 的其他 Issue
-
Bug Ruby
难度 2/5 1-3 小时 新手友好度 76/100
getsentry/sentry-ruby#3211 · 1 条评论 ·
维护者通常 2 天内回复
-
Events dropped client-side for size are only logged at debug level and not recorded as lost可能已有人在做 @sentry-junior 今天认领。 未关闭Bug Junior: repro Ruby
难度 2/5 1-3 小时 新手友好度 76/100
getsentry/sentry-ruby#3209 · 2 条评论 · 1 个 reaction ·
维护者通常 2 天内回复
-
with_child_span drops spans when blocks exit via break, return, or throw可能已有人在做 @itsrayeedscodespace 于 1 天前认领。 未关闭Bug Ruby Traces Waiting for: Product Owner
难度 2/5 1-3 小时 新手友好度 38/100
getsentry/sentry-ruby#3206 · 1 条评论 ·
维护者通常 2 天内回复
-
Let apps choose how the client IP on events is determined可能已有人在做 @sl0thentr0py 于 11 天前认领。 未关闭Improvement Ruby
getsentry/sentry-ruby#3180 · 2 条评论 · 1 个 reaction · 已指派 1 人 ·
维护者通常 2 天内回复
-
breaking change Next Major
难度 2/5 1-3 小时 新手友好度 58/100
getsentry/sentry-ruby#3176 · 1 条评论 ·
维护者通常 2 天内回复
查看 getsentry/sentry-ruby 的全部 Issue
相似的 Issue
-
enhancement
难度 2/5 1-3 小时 新手友好度 66/100
internetee/registry#2984 ·
维护者通常 6 天内回复
-
难度 2/5 1-3 小时 新手友好度 82/100
ecosyste-ms/issues#862 ·
维护者通常 1 天内回复
-
Redis Lua error `@user_script:52: ERR value is not an integer or out of range` when `window_size` is configured可能已有人在做 @mimosa 今天认领。 未关闭bug
难度 2/5 1-3 小时 新手友好度 82/100
维护者通常 1 天内回复
-
难度 2/5 1-3 小时 新手友好度 67/100
riscv/riscv-unified-db#2829 ·
维护者通常 1 天内回复
-
⛓️ Security Difficulty: Easy Good First Issue Help Wanted ruby Type: Bug
难度 2/5 1-3 小时 新手友好度 82/100
rubyforgood/casa#7404 ·
维护者通常 1 天内回复