Tracing does not work with ActiveController::Live actions
Les mainteneurs répondent en général sous 2 jours
@sl0thentr0py y travaille déjà.
Depuis le 25/7/2024.
Évaluation
Cette issue n'a pas encore été évaluée.
Description
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
- Langage dominant
- Ruby
- Étoiles
- 990
- Forks
- 552
- Merge moyen
- 2 j 16 h
- PR mergées (30 j)
- 29
Préparer son environnement
Lance le conteneur de développement du projet dans votre navigateur, avec votre propre compte GitHub.
- Aucun Dockerfile ni fichier Docker Compose
- Propose un modèle de pull request
- Lire le guide de contribution
Par où commencer
- Lisez l'issue en entier, puis le guide de contribution du projet.
- Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
- Forkez le dépôt et travaillez sur une branche.
- Ouvrez une pull request qui référence le numéro de l'issue.
Autres issues de getsentry/sentry-ruby
-
Bug Ruby
Difficulté 2/5 1-3 heures Accessibilité débutants 76/100
getsentry/sentry-ruby#3211 · 1 commentaire ·
Les mainteneurs répondent en général sous 2 jours
-
Events dropped client-side for size are only logged at debug level and not recorded as lostPeut-être pris @sentry-junior l’a pris aujourd’hui. OuverteBug Junior: repro Ruby
Difficulté 2/5 1-3 heures Accessibilité débutants 76/100
getsentry/sentry-ruby#3209 · 2 commentaires · 1 réaction ·
Les mainteneurs répondent en général sous 2 jours
-
with_child_span drops spans when blocks exit via break, return, or throwPeut-être pris @itsrayeedscodespace l’a pris il y a 1 jour. OuverteBug Ruby Traces Waiting for: Product Owner
Difficulté 2/5 1-3 heures Accessibilité débutants 38/100
getsentry/sentry-ruby#3206 · 1 commentaire ·
Les mainteneurs répondent en général sous 2 jours
-
Let apps choose how the client IP on events is determinedPeut-être pris @sl0thentr0py l’a pris il y a 11 jours. OuverteImprovement Ruby
getsentry/sentry-ruby#3180 · 2 commentaires · 1 réaction · 1 personne assignée ·
Les mainteneurs répondent en général sous 2 jours
-
Remove `sentry-ruby-core` gemOuvertebreaking change Next Major
Difficulté 2/5 1-3 heures Accessibilité débutants 58/100
getsentry/sentry-ruby#3176 · 1 commentaire ·
Les mainteneurs répondent en général sous 2 jours
Toutes les issues de getsentry/sentry-ruby
Issues similaires
-
enhancement
Difficulté 2/5 1-3 heures Accessibilité débutants 66/100
internetee/registry#2984 ·
Les mainteneurs répondent en général sous 6 jours
-
Difficulté 2/5 1-3 heures Accessibilité débutants 82/100
ecosyste-ms/issues#862 ·
Les mainteneurs répondent en général sous 1 jour
-
Redis Lua error `@user_script:52: ERR value is not an integer or out of range` when `window_size` is configuredPeut-être pris @mimosa l’a pris aujourd’hui. Ouvertebug
Difficulté 2/5 1-3 heures Accessibilité débutants 82/100
Les mainteneurs répondent en général sous 1 jour
-
Difficulté 2/5 1-3 heures Accessibilité débutants 67/100
riscv/riscv-unified-db#2829 ·
Les mainteneurs répondent en général sous 1 jour
-
⛓️ Security Difficulty: Easy Good First Issue Help Wanted ruby Type: Bug
Difficulté 2/5 1-3 heures Accessibilité débutants 82/100
rubyforgood/casa#7404 ·
Les mainteneurs répondent en général sous 1 jour