fix: Capture correct descriptions for RSpec one-liner examples #1712
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
RSpec one-liner examples (e.g., `it { is_expected.not_to be_nil }`)
generate descriptions after execution. Updated formatter to capture
the final description in `example_finished` instead of relying on
the incomplete description at `example_started`.
americodls
requested review from
a team,
ahayworth,
arielvalentin,
dazuma,
ericmustin,
fbogsany,
kaylareopelle,
mwear,
plantfansam,
robbkidd,
robertlaurin,
simi and
xuan-cao-swi
as code owners
americodls
changed the title
americodls
added a commit
to intercom/opentelemetry-ruby-contrib
that referenced
this pull request
Oct 2, 2025
## Why?
Span names and full descriptions for RSpec one-liner syntax (like `it {
is_expected.not_to be_nil }`) were incorrectly showing file locations
instead of the matcher-generated descriptions. This made tracing output
less useful for tests using the concise one-liner syntax.
## How?
RSpec generates descriptions for one-liner examples after execution,
when the matcher runs. The formatter was capturing `description` and
`full_description` at `example_started` time, before these values were
populated.
The fix updates both the span name and `full_description` attribute in
the `example_finished` callback, after RSpec has generated the proper
description from the matcher. This ensures accurate span names and
descriptions for both one-liner and traditional examples.
We need to point Intercom's Gemfile to this repo so that we get those
updates without waiting for the upstream repo to accept them.
---
**Note:** Upstream PR created at
open-telemetry#1712
kaylareopelle
approved these changes
Oct 6, 2025
Contributor
kaylareopelle
left a comment
kaylareopelle
left a comment
There was a problem hiding this comment.
Hi @americodls, thanks for catching this and providing a fix!
americodls
added a commit
to intercom/opentelemetry-ruby-contrib
that referenced
this pull request
Oct 8, 2025
## Why?
Span names and full descriptions for RSpec one-liner syntax (like `it {
is_expected.not_to be_nil }`) were incorrectly showing file locations
instead of the matcher-generated descriptions. This made tracing output
less useful for tests using the concise one-liner syntax.
## How?
RSpec generates descriptions for one-liner examples after execution,
when the matcher runs. The formatter was capturing `description` and
`full_description` at `example_started` time, before these values were
populated.
The fix updates both the span name and `full_description` attribute in
the `example_finished` callback, after RSpec has generated the proper
description from the matcher. This ensures accurate span names and
descriptions for both one-liner and traditional examples.
We need to point Intercom's Gemfile to this repo so that we get those
updates without waiting for the upstream repo to accept them.
---
**Note:** Upstream PR created at
open-telemetry#1712
Contributor
|
@chrisholmes may I ask for a review please? |
Contributor
I'm away from computer so I can't test it myself, but the change is simple enough and it makes sense to me. |
Contributor
|
Please review at your leisure. With your approval I will merge this PR. |
americodls
added a commit
to intercom/opentelemetry-ruby-contrib
that referenced
this pull request
Oct 12, 2025
## Why?
Span names and full descriptions for RSpec one-liner syntax (like `it {
is_expected.not_to be_nil }`) were incorrectly showing file locations
instead of the matcher-generated descriptions. This made tracing output
less useful for tests using the concise one-liner syntax.
## How?
RSpec generates descriptions for one-liner examples after execution,
when the matcher runs. The formatter was capturing `description` and
`full_description` at `example_started` time, before these values were
populated.
The fix updates both the span name and `full_description` attribute in
the `example_finished` callback, after RSpec has generated the proper
description from the matcher. This ensures accurate span names and
descriptions for both one-liner and traditional examples.
We need to point Intercom's Gemfile to this repo so that we get those
updates without waiting for the upstream repo to accept them.
---
**Note:** Upstream PR created at
open-telemetry#1712
americodls
added a commit
to intercom/opentelemetry-ruby-contrib
that referenced
this pull request
Oct 14, 2025
## Why?
Span names and full descriptions for RSpec one-liner syntax (like `it {
is_expected.not_to be_nil }`) were incorrectly showing file locations
instead of the matcher-generated descriptions. This made tracing output
less useful for tests using the concise one-liner syntax.
## How?
RSpec generates descriptions for one-liner examples after execution,
when the matcher runs. The formatter was capturing `description` and
`full_description` at `example_started` time, before these values were
populated.
The fix updates both the span name and `full_description` attribute in
the `example_finished` callback, after RSpec has generated the proper
description from the matcher. This ensures accurate span names and
descriptions for both one-liner and traditional examples.
We need to point Intercom's Gemfile to this repo so that we get those
updates without waiting for the upstream repo to accept them.
---
**Note:** Upstream PR created at
open-telemetry#1712
chrisholmes
approved these changes
Oct 30, 2025
|
|
||
| # Update name and full_description for one-liner examples where description is generated after execution | ||
| span.name = example.description | ||
| span.set_attribute('rspec.example.full_description', example.full_description.to_s) |
Contributor
There was a problem hiding this comment.
💁🏼 Use add_attributes as opposed to setting each attribute separately because each call requires a lock when changing a span
Contributor
There was a problem hiding this comment.
Great catch. I agree. @americodls, can you update the method call to combine the attributes on line 76 and 77 into one add_attributes call?
Contributor
Author
There was a problem hiding this comment.
Thank you for the feedback. I just fixed that.
Using add_attributes instead of two separate set_attribute calls reduces lock acquisition overhead, since each attribute update requires locking the span.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
RSpec one-liner examples (e.g.,
it { is_expected.not_to be_nil }) generate descriptions after execution.Updated formatter to capture the final description in
example_finishedinstead of relying on the incomplete description atexample_started.