fix(#2076): make db.response.error attribute selection consistent with other optional attributes by NameHaibinZhang · Pull Request #2086 · open-telemetry/opentelemetry-ebpf-instrumentation

NameHaibinZhang · 2026-05-11T02:05:22Z

Description

When db.response.error is not included in attributes.select.traces, the span status message is now left empty instead of showing a placeholder hint. This makes the behavior consistent with how other optional attributes (e.g. db.query.text) work — when not selected, they are simply omitted.

Changes

Remove the DBErrorMessagePlaceholder constant
Update DBResponseErrorAttr() to return nil when the attribute is not selected
Update config schema description to clarify that attributes.select applies to both metrics and traces
Update tests to reflect the new behavior

Fixes #2076

codecov · 2026-05-11T02:10:33Z

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 69.52%. Comparing base (a987882) to head (6adaec0).
⚠️ Report is 17 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #2086      +/-   ##
==========================================
+ Coverage   69.19%   69.52%   +0.32%     
==========================================
  Files         289      289              
  Lines       36234    36286      +52     
==========================================
+ Hits        25073    25228     +155     
+ Misses       9805     9685     -120     
- Partials     1356     1373      +17

Flag	Coverage Δ
integration-test	`53.65% <0.00%> (+0.55%)`	⬆️
integration-test-arm	`28.41% <0.00%> (+0.18%)`	⬆️
integration-test-vm-x86_64-5.15.152	`?`
integration-test-vm-x86_64-6.10.6	`?`
k8s-integration-test	`41.81% <0.00%> (-0.74%)`	⬇️
oats-test	`37.82% <100.00%> (-0.14%)`	⬇️
unittests	`61.44% <100.00%> (+0.52%)`	⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

github-actions · 2026-05-11T02:13:40Z

CI Supervisor

Workflow	Job	Last state	Re-running?	Attempt
Pull request integration tests	shard-1 (11 tests)	failure	Yes	1/2
Pull request checks	Lint	failure	No	1/2
Pull request integration tests ARM	shard-1 (1 tests)	failure	Yes	1/2

…eparate file Update the Selection type comment and JSON schema description to mention the traces key for trace attribute selection. Regenerate CONFIG.md to match the auto-generated output (removing free-form sections that break the check-config-schema CI check). Move the detailed db.response.error documentation into devdocs/db-response-error.md.

Rename devdocs/db-response-error.md to devdocs/attribute-selection.md and update the title to be more general as suggested in review.

When db.response.error is not selected, omit the status message entirely instead of adding a placeholder hint. This aligns with how other optional attributes (e.g. db.query.text) behave — they are simply not present when not selected, without any placeholder.

… (testifylint)

marctc

Unless I'm missing something, this should be documented in official OBI docs, like this open-telemetry/opentelemetry.io#9753
devdocs IMHO should be only used to documented stuff that's helpful for the developers of this project.

NameHaibinZhang · 2026-05-12T09:12:46Z

Thanks @marctc — you're right. Looking at the devdocs/README.md ("documentation that is not useful for our users but might be useful for developers") and the pattern in devdocs/metrics.md (which explicitly links to the user-facing page on opentelemetry.io and labels itself a "developer-internal companion"), the attribute-selection.md content is clearly user-facing and belongs in the official OBI docs.

I'll remove the devdocs file from this PR and open a follow-up PR against opentelemetry.io to document the db.response.error trace-selection behavior there. The code changes (removing the placeholder constant, making the opt-in behavior consistent with db.query.text) and the config-schema description updates should still be valid independently.

Let me know if you'd also like the config-schema description change reverted, or if that can stay since it's developer-facing reference.

marctc · 2026-05-12T09:16:01Z

The code changes (removing the placeholder constant, making the opt-in behavior consistent with db.query.text) and the config-schema description updates should still be valid independently.

sounds good, thanks!

Per reviewer feedback, user-facing documentation should be in official OBI docs (opentelemetry.io) rather than devdocs/. devdocs/ is intended for project developer documentation only. Will follow up with documentation PR to opentelemetry.io.

NameHaibinZhang · 2026-05-12T10:16:29Z

@marctc doc: open-telemetry/opentelemetry.io#9887

marctc

I'm happy to unblock the PR but the description and title doesn't match the PR anymore. Would you mind update it?

NameHaibinZhang · 2026-05-13T08:08:09Z

@marctc Done! I've updated the PR title and description to reflect the current scope (code behavior change only, documentation moved to opentelemetry.io in a separate PR). Thanks for flagging this!

marctc

LGTM

grcevski

LGTM!

docs: document db.response.error trace selection (open-telemetry#2076)

cb03639

NameHaibinZhang requested a review from a team as a code owner May 11, 2026 02:05

NameHaibinZhang mentioned this pull request May 11, 2026

Document the functionality of db.response.error #2076

Closed

docs: fix MD001 heading levels in CONFIG.md

440e7cb

NameHaibinZhang changed the title ~~docs: document db.response.error trace selection (#2076)~~ fix(#2076): add document db.response.error trace selection May 11, 2026

NimrodAvni78 reviewed May 11, 2026

View reviewed changes

Comment thread devdocs/db-response-error.md Outdated

Comment thread devdocs/attribute-selection.md Outdated

NameHaibinZhang added 3 commits May 11, 2026 16:09

fix: rename devdocs to attribute-selection.md per review feedback

fcb1844

Rename devdocs/db-response-error.md to devdocs/attribute-selection.md and update the title to be more general as suggested in review.

fix: use assert.Empty instead of assert.Equal for empty string checks…

e4eeb20

… (testifylint)

NameHaibinZhang requested a review from NimrodAvni78 May 12, 2026 06:04

marctc requested changes May 12, 2026

View reviewed changes

NameHaibinZhang requested a review from marctc May 12, 2026 09:28

NameHaibinZhang mentioned this pull request May 12, 2026

docs(obi): document trace attribute selection open-telemetry/opentelemetry.io#9887

Merged

marctc reviewed May 13, 2026

View reviewed changes

NameHaibinZhang changed the title ~~fix(#2076): add document db.response.error trace selection~~ fix(#2076): make db.response.error attribute selection consistent with other optional attributes May 13, 2026

NameHaibinZhang requested a review from marctc May 13, 2026 08:42

marctc approved these changes May 13, 2026

View reviewed changes

grcevski approved these changes May 13, 2026

View reviewed changes

grcevski merged commit 2991725 into open-telemetry:main May 13, 2026
79 of 80 checks passed

MrAlias added this to the v0.10.0 milestone Jun 2, 2026

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix(#2076): make db.response.error attribute selection consistent with other optional attributes#2086

fix(#2076): make db.response.error attribute selection consistent with other optional attributes#2086
grcevski merged 7 commits into
open-telemetry:mainfrom
NameHaibinZhang:feature/fix-2076

NameHaibinZhang commented May 11, 2026 •

edited

Loading

Uh oh!

codecov Bot commented May 11, 2026 •

edited

Loading

Uh oh!

github-actions Bot commented May 11, 2026 •

edited

Loading

Uh oh!

Uh oh!

Uh oh!

marctc left a comment

Uh oh!

NameHaibinZhang commented May 12, 2026

Uh oh!

marctc commented May 12, 2026

Uh oh!

NameHaibinZhang commented May 12, 2026

Uh oh!

marctc left a comment

Uh oh!

NameHaibinZhang commented May 13, 2026 •

edited

Loading

Uh oh!

marctc left a comment

Uh oh!

grcevski left a comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

Conversation

NameHaibinZhang commented May 11, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Changes

Uh oh!

codecov Bot commented May 11, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

github-actions Bot commented May 11, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

CI Supervisor

Uh oh!

Uh oh!

Uh oh!

marctc left a comment

Choose a reason for hiding this comment

Uh oh!

NameHaibinZhang commented May 12, 2026

Uh oh!

marctc commented May 12, 2026

Uh oh!

NameHaibinZhang commented May 12, 2026

Uh oh!

marctc left a comment

Choose a reason for hiding this comment

Uh oh!

NameHaibinZhang commented May 13, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

marctc left a comment

Choose a reason for hiding this comment

Uh oh!

grcevski left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

NameHaibinZhang commented May 11, 2026 •

edited

Loading

codecov Bot commented May 11, 2026 •

edited

Loading

github-actions Bot commented May 11, 2026 •

edited

Loading

NameHaibinZhang commented May 13, 2026 •

edited

Loading