feat: Add SQL Comment Propagator #1818
Open
+454
−11
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
Implements a helper to propagate context via SQL comments as specified here: > Instrumentations MAY propagate context using SQL commenter by injecting comments into SQL queries before execution. SQL commenter-based context propagation SHOULD NOT be enabled by default, but instrumentation MAY allow users to opt into it. > > The instrumentation implementation SHOULD append the comment to the end of the query. Semantic conventions for individual database systems MAY specify different format, which may include different position, encoding, or schema, depending on the specific database system’s requirements or preferences. > > The instrumentation SHOULD allow users to pass a propagator to overwrite the global propagator. If no propagator is provided by the user, instrumentation SHOULD use the global propagator. https://opentelemetry.io/docs/specs/semconv/database/database-spans/#context-propagation This helper conforms to the propagator inject interface, since it does not ever extract values we are skipping that implementation. Once the processors replaces the obfuscator then we can include the propagators in the SQL gems for trilogy, mysql2, and pg
arielvalentin
requested review from
a team,
ahayworth,
dazuma,
ericmustin,
fbogsany,
kaylareopelle,
mwear,
plantfansam,
robbkidd,
robertlaurin,
simi and
xuan-cao-swi
as code owners
arielvalentin
commented
Nov 27, 2025
| - name: opentelemetry-sampler-xray | ||
| directory: sampler/xray | ||
| version_constant: [OpenTelemetry, Sampler, XRay, VERSION] | ||
| version_constant: [OpenTelemetry, Sampler, XRay, VERSION] |
Contributor
Author
There was a problem hiding this comment.
unrelated but I am fixing a missing new line at the end of this file
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Implements a helper to propagate context via SQL comments as specified here:
https://opentelemetry.io/docs/specs/semconv/database/database-spans/#context-propagation
This helper conforms to the propagator inject interface, since it does not ever extract values we are skipping that implementation.
Once the processors replaces the obfuscator then we can include the propagators in the SQL gems for trilogy, mysql2, and pgFixes #479