Tracing does not work with ActiveController::Live actions

オープン
#2,355 コメント 3 件 リアクション 0 件 担当者 1 名 GitHub で見る

メンテナーはふだん 2 日以内に返信

@sl0thentr0py がすでに取り組んでいます。

2024年7月25日 から。

評価

この issue はまだ評価されていません。

説明

Feature Ruby sentry-rails Traces
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
  1. Create a Rails application
  2. Add sentry with tracing enabled
  3. Include ActiveController::Live in some controller and add actions that would log to sentry (IE, they do DB queries or whatever)
  4. 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時間
マージ済み PR(30日)
29

環境構築

Codespaces で開く

このプロジェクトの開発コンテナを、あなたの GitHub アカウントでブラウザ上に起動します。

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

getsentry/sentry-ruby のほかの issue

getsentry/sentry-ruby の issue をすべて見る

似ている issue

Ruby の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。