with_child_span drops spans when blocks exit via break, return, or throw

Abierto
#3,206 1 comentario 0 reacciones 0 asignados Ver en GitHub

Los mantenedores suelen responder en 2 días

@itsrayeedscodespace ya está trabajando en esto.

Desde el 14/11/2026.

  • #3207 de @itsrayeedscodespace — abierto

Evaluación

Dificultad
2/5
Tiempo estimado
1-3 horas
Aptitud para principiantes
38/100
Tipo de issue
Error
Claridad
Bien especificado
Estado de actividad
Activo
Stack tecnológico
ruby

Línea de trabajo

Start in the SDK's Span#with_child_span, where finish runs after yield and in the rescue branch, and in the public wrapper on the Sentry module that delegates to it. Read the existing specs around span finishing and the transaction event's span filtering to confirm an unfinished span is dropped. The fix is to finish the child span in an ensure while keeping the StandardError handling and the direct return value, then run the span specs plus the four reproduction cases (break, nonlocal return, catch/throw, custom Exception).

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

Bug Ruby Traces Waiting for: Product Owner
Issue Description

Sentry.with_child_span silently loses its child span when the block exits via break, a nonlocal return, or throw. The same happens when the block raises an exception outside StandardError.

The underlying Span#with_child_span calls finish after yield and in its rescue branch. None of those paths run for nonlocal control flow. The hub restores the parent scope in ensure, but the child still has a nil timestamp, so TransactionEvent filters it out of the captured transaction.

Reproduction Steps

On current master (314eacad), with Ruby 3.4.12:

require "sentry-ruby"

Sentry.init do |config|
  config.dsn = "http://public@localhost/1"
  config.transport.transport_class = Sentry::DummyTransport
  config.background_worker_threads = 0
  config.traces_sample_rate = 1.0
end

transaction = Sentry.start_transaction(name: "repro", sampled: true)
Sentry.get_current_scope.set_span(transaction)
result = Sentry.with_child_span(op: "work") { break :done }
transaction.finish

p result # :done
p Sentry.get_current_client.transport.events.last.spans # []

A method returning from inside the span block, catch/throw, and a raised custom Exception subclass all produce the same missing span. Four public-API regression specs reproduce this on unchanged master.

Expected Behavior

The child span is finished and included in the transaction regardless of how control leaves the block. Return values and exception propagation remain unchanged.

Actual Behavior

The child span is unfinished and silently excluded from the captured transaction.

Proposed Fix

Finish the child span in an ensure block around the yield. Keep the existing StandardError handling and direct Span#with_child_span return value.

Lenguaje dominante
Ruby
Estrellas
990
Forks
552
Merge medio
2 d 16 h
PR fusionados (30 d)
29

Preparar el entorno

Abrir en Codespaces

Inicia el contenedor de desarrollo del proyecto en tu navegador, con tu propia cuenta de GitHub.

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de getsentry/sentry-ruby

Todos los issues de getsentry/sentry-ruby

Issues similares

Más issues de Ruby

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.