[SqlClient] [EFCore] Support query parameter attributes #3015

martincostello · 2025-08-20T16:35:55Z

Changes

Add support for db.query.parameter.<key> for SqlClient and EFCore via new opt-in SetDbQueryParameters option.

Merge requirement checklist

CONTRIBUTING guidelines followed (license requirements, nullable enabled, static analysis, etc.)
Unit tests added/updated
Appropriate CHANGELOG.md files updated for non-trivial changes
Changes in public API reviewed (if applicable)

codecov · 2025-08-20T16:37:09Z

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 69.78%. Comparing base (7cfcb51) to head (26a3f01).
⚠️ Report is 1 commits behind head on main.
✅ All tests successful. No failed tests found.

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #3015      +/-   ##
==========================================
+ Coverage   69.66%   69.78%   +0.11%     
==========================================
  Files         413      414       +1     
  Lines       16229    16246      +17     
==========================================
+ Hits        11306    11337      +31     
+ Misses       4923     4909      -14

Flag	Coverage Δ
unittests-Contrib.Shared.Tests	`87.65% <100.00%> (+0.29%)`	⬆️
unittests-Exporter.Geneva	`53.66% <ø> (+0.33%)`	⬆️
unittests-Exporter.InfluxDB	`95.14% <ø> (ø)`
unittests-Exporter.Instana	`74.86% <ø> (ø)`
unittests-Exporter.OneCollector	`94.61% <ø> (ø)`
unittests-Extensions	`90.65% <ø> (ø)`
unittests-Extensions.Enrichment	`100.00% <ø> (ø)`
unittests-Instrumentation.AWS	`83.80% <ø> (ø)`
unittests-Instrumentation.AspNet	`74.93% <ø> (-0.25%)`	⬇️
unittests-Instrumentation.AspNetCore	`70.76% <ø> (ø)`
unittests-Instrumentation.Cassandra	`23.52% <ø> (ø)`
unittests-Instrumentation.ConfluentKafka	`14.10% <ø> (ø)`
unittests-Instrumentation.ElasticsearchClient	`80.12% <ø> (ø)`
unittests-Instrumentation.EntityFrameworkCore	`81.06% <100.00%> (+0.23%)`	⬆️
unittests-Instrumentation.EventCounters	`76.36% <ø> (ø)`
unittests-Instrumentation.GrpcCore	`91.42% <ø> (ø)`
unittests-Instrumentation.GrpcNetClient	`79.61% <ø> (ø)`
unittests-Instrumentation.Hangfire	`84.61% <ø> (ø)`
unittests-Instrumentation.Http	`74.18% <ø> (ø)`
unittests-Instrumentation.Owin	`88.62% <ø> (ø)`
unittests-Instrumentation.Process	`100.00% <ø> (ø)`
unittests-Instrumentation.Quartz	`78.76% <ø> (ø)`
unittests-Instrumentation.Runtime	`100.00% <ø> (ø)`
unittests-Instrumentation.ServiceFabricRemoting	`34.54% <ø> (ø)`
unittests-Instrumentation.SqlClient	`87.24% <100.00%> (+0.08%)`	⬆️
unittests-Instrumentation.StackExchangeRedis	`70.81% <ø> (ø)`
unittests-Instrumentation.Wcf	`78.95% <ø> (ø)`
unittests-OpAmp.Client	`61.08% <ø> (ø)`
unittests-PersistentStorage	`65.21% <ø> (-0.67%)`	⬇️
unittests-Resources.AWS	`75.00% <ø> (ø)`
unittests-Resources.Azure	`85.31% <ø> (ø)`
unittests-Resources.Container	`67.34% <ø> (ø)`
unittests-Resources.Gcp	`71.42% <ø> (ø)`
unittests-Resources.Host	`73.91% <ø> (ø)`
unittests-Resources.OperatingSystem	`76.98% <ø> (ø)`
unittests-Resources.Process	`100.00% <ø> (ø)`
unittests-Resources.ProcessRuntime	`79.59% <ø> (ø)`
unittests-Sampler.AWS	`88.25% <ø> (ø)`

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

Files with missing lines	Coverage Δ
...eworkCore/EntityFrameworkInstrumentationOptions.cs	`100.00% <100.00%> (ø)`
...mplementation/EntityFrameworkDiagnosticListener.cs	`85.79% <100.00%> (+0.15%)`	⬆️
...ient/Implementation/SqlClientDiagnosticListener.cs	`88.75% <100.00%> (+0.14%)`	⬆️
....SqlClient/SqlClientTraceInstrumentationOptions.cs	`100.00% <100.00%> (ø)`
src/Shared/SqlParameterProcessor.cs	`100.00% <100.00%> (ø)`

... and 3 files with indirect coverage changes

🚀 New features to boost your workflow:

📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

src/OpenTelemetry.Instrumentation.EntityFrameworkCore/.publicApi/PublicAPI.Unshipped.txt

Copilot

Pull Request Overview

This PR adds support for capturing database query parameters as OpenTelemetry attributes in both SqlClient and Entity Framework Core instrumentations. The feature is opt-in through a new SetDbQueryParameters configuration option and adds parameters as db.query.parameter.<key> tags on database spans.

Introduces SqlParameterProcessor to extract and set query parameter attributes from database commands
Adds SetDbQueryParameters option to both SqlClient and Entity Framework Core instrumentation options
Refactors Docker platform detection logic into shared helper classes for better code organization

Reviewed Changes

Copilot reviewed 21 out of 21 changed files in this pull request and generated 2 comments.

Show a summary per file

File	Description
`src/Shared/SqlParameterProcessor.cs`	Core logic for extracting database parameters and adding them as activity tags
`src/OpenTelemetry.Instrumentation.SqlClient/SqlClientTraceInstrumentationOptions.cs`	Adds SetDbQueryParameters option to SqlClient instrumentation
`src/OpenTelemetry.Instrumentation.EntityFrameworkCore/EntityFrameworkInstrumentationOptions.cs`	Adds SetDbQueryParameters option to EF Core instrumentation
`test/Shared/DockerHelper.cs`	Refactored Docker platform detection logic into reusable helper
`test/OpenTelemetry.Contrib.Shared.Tests/SqlParameterProcessorTests.cs`	Comprehensive unit tests for parameter processing functionality
Various test files	Updated to use refactored Docker helpers and added integration tests for parameter capture

_{Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.}

src/OpenTelemetry.Instrumentation.SqlClient/SqlClientTraceInstrumentationOptions.cs

src/OpenTelemetry.Instrumentation.EntityFrameworkCore/EntityFrameworkInstrumentationOptions.cs

linux-foundation-easycla · 2025-08-20T17:05:02Z

The committers listed above are authorized under a signed CLA.

✅ login: martincostello / name: Martin Costello (1e11556, fba7b76, b2c48e4, e371e6d)
✅ login: Kielek / name: Piotr Kiełkowicz (26a3f01)

martincostello · 2025-08-20T17:06:44Z

Well that's new - if you accept any code fix suggestions from Copilot, the CLA check fails 😅

Kielek · 2025-08-20T18:47:02Z

Well that's new - if you accept any code fix suggestions from Copilot, the CLA check fails 😅

Hopefully, it is temporary: open-telemetry/community#2920

...etry.Instrumentation.EntityFrameworkCore/Implementation/EntityFrameworkDiagnosticListener.cs

Kielek · 2025-08-21T05:55:23Z

src/OpenTelemetry.Instrumentation.SqlClient/SqlClientTraceInstrumentationOptions.cs

+    /// contain any sensitive data.</b>
+    /// </para>
+    /// <para>
+    /// <b>SetDbQueryParameters is only supported on .NET and .NET Core runtimes.</b>


In general, .NET Core is no longer supported. We are testing only with .NEt8+

I assumed this was present in the comment I copied from to cover netstandard2.0. If we don't want to use the old terminology anymore than I can either remove it from all the relevant properties, or reword it to say "not .NET Framework".

It makes sense, it can be done for whole project/repo in the separate PR.

src/Shared/SqlParameterProcessor.cs

test/OpenTelemetry.Contrib.Shared.Tests/SqlParameterProcessorTests.cs

Kielek · 2025-08-21T06:05:57Z

src/OpenTelemetry.Instrumentation.SqlClient/Implementation/SqlClientDiagnosticListener.cs

                    }
 #endif

+                    if (options.SetDbQueryParameters)


Only if AllDataRequested and new convention.

src/OpenTelemetry.Instrumentation.EntityFrameworkCore/CHANGELOG.md

src/OpenTelemetry.Instrumentation.EntityFrameworkCore/README.md

martincostello had a problem deploying to external August 20, 2025 16:36 — with GitHub Actions Failure

github-actions bot added comp:instrumentation.entityframeworkcore Things related to OpenTelemetry.Instrumentation.EntityFrameworkCore comp:instrumentation.sqlclient Things related to OpenTelemetry.Instrumentation.SqlClient labels Aug 20, 2025

martincostello had a problem deploying to external August 20, 2025 16:39 — with GitHub Actions Failure

martincostello had a problem deploying to external August 20, 2025 16:41 — with GitHub Actions Failure

martincostello had a problem deploying to external August 20, 2025 16:44 — with GitHub Actions Failure

martincostello commented Aug 20, 2025

View reviewed changes

src/OpenTelemetry.Instrumentation.EntityFrameworkCore/.publicApi/PublicAPI.Unshipped.txt Show resolved Hide resolved

martincostello marked this pull request as ready for review August 20, 2025 17:03

Copilot AI review requested due to automatic review settings August 20, 2025 17:03

martincostello requested a review from a team as a code owner August 20, 2025 17:03

Copilot AI reviewed Aug 20, 2025

View reviewed changes

src/OpenTelemetry.Instrumentation.SqlClient/SqlClientTraceInstrumentationOptions.cs Outdated Show resolved Hide resolved

src/OpenTelemetry.Instrumentation.EntityFrameworkCore/EntityFrameworkInstrumentationOptions.cs Outdated Show resolved Hide resolved

martincostello had a problem deploying to external August 20, 2025 17:04 — with GitHub Actions Failure

github-actions bot assigned martincostello and matt-hensley Aug 20, 2025

github-actions bot requested a review from matt-hensley August 20, 2025 17:05

martincostello force-pushed the gh-2241 branch from be0b7b3 to 230daaf Compare August 20, 2025 17:08

martincostello had a problem deploying to external August 20, 2025 17:08 — with GitHub Actions Failure

Kielek mentioned this pull request Aug 20, 2025

Enable EasyCLA co-author verification across all repositories open-telemetry/community#2920

Open

Kielek reviewed Aug 21, 2025

View reviewed changes

martincostello mentioned this pull request Aug 21, 2025

Clarify expected behaviour for db.query.parameter.<key> open-telemetry/semantic-conventions#2667

Closed

martincostello had a problem deploying to external August 21, 2025 09:03 — with GitHub Actions Failure

martincostello had a problem deploying to external August 21, 2025 09:09 — with GitHub Actions Failure

martincostello commented Aug 21, 2025

View reviewed changes

src/OpenTelemetry.Instrumentation.EntityFrameworkCore/README.md Show resolved Hide resolved

martincostello had a problem deploying to external August 21, 2025 09:28 — with GitHub Actions Failure

martincostello marked this pull request as draft August 22, 2025 08:08

martincostello mentioned this pull request Aug 22, 2025

[Infra] Add EnabledOnDockerPlatformFact #3028

Merged

4 tasks

[SqlClient] [EFCore] Support query parameter attributes #3015

[SqlClient] [EFCore] Support query parameter attributes #3015

Uh oh!

Conversation

martincostello commented Aug 20, 2025

Changes

Merge requirement checklist

Uh oh!

codecov bot commented Aug 20, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Uh oh!

Uh oh!

linux-foundation-easycla bot commented Aug 20, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

martincostello commented Aug 20, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Kielek commented Aug 20, 2025

Uh oh!

Uh oh!

Kielek Aug 21, 2025

Choose a reason for hiding this comment

Uh oh!

martincostello Aug 21, 2025

Choose a reason for hiding this comment

Uh oh!

Kielek Aug 21, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Kielek Aug 21, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

codecov bot commented Aug 20, 2025 •

edited

Loading

linux-foundation-easycla bot commented Aug 20, 2025 •

edited

Loading

martincostello commented Aug 20, 2025 •

edited

Loading