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

Open
#3,206 1 comment 0 reactions 0 assignees View on GitHub

Maintainers usually reply within 2 days

@itsrayeedscodespace is already working on this.

Since Nov 14, 2026.

  • #3207 by @itsrayeedscodespace — open

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
38/100
Issue type
Bug
Clarity
Clearly specified
Activity status
Active
Tech stack
ruby
Domain
observability

Research direction

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).

Written by the indexing model from the issue text.

Description

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.

Dominant language
Ruby
Stars
990
Forks
552
Avg merge
2d 16h
Merged PRs (30d)
29

Getting set up

Open in Codespaces

Starts the project's dev container in your browser, under your own GitHub account.

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from getsentry/sentry-ruby

All issues in getsentry/sentry-ruby

Similar issues

More Ruby issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.