docs(obi): document trace attribute selection#9887
Merged
vitorvasc merged 3 commits intoMay 13, 2026
Merged
Conversation
Add documentation for the traces key under attributes.select, with detailed explanation of db.response.error behavior. Related: open-telemetry/opentelemetry-ebpf-instrumentation#2076
otelbot-docs
Bot
added
the
missing:docs-approval
otelbot-docs
Bot
added
the
missing:sig-approval
otelbot-docs
Bot
removed
the
missing:sig-approval
Contributor
There was a problem hiding this comment.
Pull request overview
Note
Copilot was unable to run its full agentic suite in this review.
This PR updates OBI’s user-facing documentation to explain how to select trace-related optional attributes via attributes.select.traces, with a focus on the db.response.error configuration flag and its effect on span.status.message.
Changes:
- Added a new “Trace selection” section describing the
attributes.select.traceskey and its purpose. - Documented
db.response.errordefault vs enabled behavior and clarified it affectsspan.status.message. - Added a YAML example showing how to include trace options like
db.query.textanddb.response.error.
vitorvasc
approved these changes
May 13, 2026
otelbot-docs
Bot
added
ready-to-be-merged
Merged
via the queue into
open-telemetry:main
with commit May 13, 2026
9afd426
28 of 29 checks passed
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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
Document the
traceskey underattributes.selectand specifically thedb.response.errorconfiguration flag for OBI.This user-facing documentation was originally proposed in open-telemetry/opentelemetry-ebpf-instrumentation#2086 but per reviewer feedback, it belongs in the official OBI documentation here rather than in the project's internal devdocs.
Changes
db.response.errorbehavior (default vs enabled)span.status.message, not a separate attributeRelated