feat: add commenter_for_all_spans option to enable SQLCommenter for non-recording spans
#4090
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
…enter for non-recording spans
...tion/opentelemetry-instrumentation-dbapi/src/opentelemetry/instrumentation/dbapi/__init__.py
Outdated
Show resolved
Hide resolved
...tion/opentelemetry-instrumentation-dbapi/src/opentelemetry/instrumentation/dbapi/__init__.py
Outdated
Show resolved
Hide resolved
...tion/opentelemetry-instrumentation-dbapi/src/opentelemetry/instrumentation/dbapi/__init__.py
Outdated
Show resolved
Hide resolved
Contributor
|
This is looking good and I really appreciate the docs updates and comments so far. Just left one minor suggestion. |
Elyahou
changed the title
commenter_for_nonrecording_spans option to enable SQLCommenter for non-recording spanscommenter_for_all_spans option to enable SQLCommenter for non-recording spans
...tion/opentelemetry-instrumentation-dbapi/src/opentelemetry/instrumentation/dbapi/__init__.py
Outdated
Show resolved
Hide resolved
tammy-baylis-swi
approved these changes
Jan 20, 2026
Contributor
tammy-baylis-swi
left a comment
tammy-baylis-swi
left a comment
There was a problem hiding this comment.
Thanks @Elyahou this lgtm!
I've approved; the Maintainers of this repo also need to have a look.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 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.
Description
Add
commenter_for_all_spansoption to SQLAlchemy and DBAPI instrumentations, enabling SQLCommenter to add SQL comments (includingtraceparent) for not sampled spans.Motivation: By default, SQLCommenter only adds comments when
span.is_recording()isTrue. This means not sampled spans (e.g., when using a sampling rate < 100%) don't get SQL comments. However, some users wanttraceparentpropagated in SQL comments for all requests regardless of sampling decision, enabling database-side correlation with distributed traces.Changes:
commenter_for_all_spansparameter (default:False) to both SQLAlchemy and DBAPI instrumentationsspan.is_recording()isTrue(existing behavior preserved)Type of change
How Has This Been Tested?
Added unit tests for both instrumentations: