[EFCore] [SqlClient] Remove SetDbStatementFor* options (#3072)

martincostello · web-flow · commit abe21ba2da7e · 2025-09-08T09:31:36.000+02:00
diff --git a/src/OpenTelemetry.Instrumentation.EntityFrameworkCore/.publicApi/PublicAPI.Unshipped.txt b/src/OpenTelemetry.Instrumentation.EntityFrameworkCore/.publicApi/PublicAPI.Unshipped.txt
@@ -4,10 +4,6 @@ OpenTelemetry.Instrumentation.EntityFrameworkCore.EntityFrameworkInstrumentation
 OpenTelemetry.Instrumentation.EntityFrameworkCore.EntityFrameworkInstrumentationOptions.Filter.set -> void
 OpenTelemetry.Instrumentation.EntityFrameworkCore.EntityFrameworkInstrumentationOptions.SetDbQueryParameters.get -> bool
 OpenTelemetry.Instrumentation.EntityFrameworkCore.EntityFrameworkInstrumentationOptions.SetDbQueryParameters.set -> void
-OpenTelemetry.Instrumentation.EntityFrameworkCore.EntityFrameworkInstrumentationOptions.SetDbStatementForStoredProcedure.get -> bool
-OpenTelemetry.Instrumentation.EntityFrameworkCore.EntityFrameworkInstrumentationOptions.SetDbStatementForStoredProcedure.set -> void
-OpenTelemetry.Instrumentation.EntityFrameworkCore.EntityFrameworkInstrumentationOptions.SetDbStatementForText.get -> bool
-OpenTelemetry.Instrumentation.EntityFrameworkCore.EntityFrameworkInstrumentationOptions.SetDbStatementForText.set -> void
 OpenTelemetry.Instrumentation.EntityFrameworkCore.EntityFrameworkInstrumentationOptions.EnrichWithIDbCommand.get -> System.Action<System.Diagnostics.Activity!, System.Data.IDbCommand!>?
 OpenTelemetry.Instrumentation.EntityFrameworkCore.EntityFrameworkInstrumentationOptions.EnrichWithIDbCommand.set -> void
 OpenTelemetry.Trace.TracerProviderBuilderExtensions
diff --git a/src/OpenTelemetry.Instrumentation.EntityFrameworkCore/CHANGELOG.md b/src/OpenTelemetry.Instrumentation.EntityFrameworkCore/CHANGELOG.md
@@ -21,9 +21,13 @@
 * Add the `db.query.summary` attribute and use it for the trace span name when opted
   into using the `OTEL_SEMCONV_STABILITY_OPT_IN` environment variable.
   ([#3022](https://github.com/open-telemetry/opentelemetry-dotnet-contrib/pull/3022))
-* The `db.statement` and `db.query.text` attributes added when `SetDbStatementForText`
-  is `true` are now sanitized when using specific SQL-like EFCore providers.
+* The `db.statement` and `db.query.text` attributes are now sanitized when using
+  specific SQL-like EFCore providers.
   ([#3022](https://github.com/open-telemetry/opentelemetry-dotnet-contrib/pull/3022))
+* **Breaking change**: The `SetDbStatementForStoredProcedure` and
+  `SetDbStatementForText` properties have been removed. Behaviors related to this
+  option are now always enabled.
+  ([#3072](https://github.com/open-telemetry/opentelemetry-dotnet-contrib/pull/3072))
 
 ## 1.12.0-beta.2
 
diff --git a/src/OpenTelemetry.Instrumentation.EntityFrameworkCore/EntityFrameworkInstrumentationOptions.cs b/src/OpenTelemetry.Instrumentation.EntityFrameworkCore/EntityFrameworkInstrumentationOptions.cs
@@ -28,16 +28,6 @@ internal EntityFrameworkInstrumentationOptions(IConfiguration configuration)
         this.EmitNewAttributes = databaseSemanticConvention.HasFlag(DatabaseSemanticConvention.New);
     }
 
-    /// <summary>
-    /// Gets or sets a value indicating whether or not the <see cref="EntityFrameworkInstrumentation"/> should add the names of <see cref="CommandType.StoredProcedure"/> commands as the <see cref="Trace.SemanticConventions.AttributeDbStatement"/> tag. Default value: True.
-    /// </summary>
-    public bool SetDbStatementForStoredProcedure { get; set; } = true;
-
-    /// <summary>
-    /// Gets or sets a value indicating whether or not the <see cref="EntityFrameworkInstrumentation"/> should add the text of <see cref="CommandType.Text"/> commands as the <see cref="Trace.SemanticConventions.AttributeDbStatement"/> tag. Default value: False.
-    /// </summary>
-    public bool SetDbStatementForText { get; set; }
-
     /// <summary>
     /// Gets or sets an action to enrich an Activity from the db command.
     /// </summary>
diff --git a/src/OpenTelemetry.Instrumentation.EntityFrameworkCore/Implementation/EntityFrameworkDiagnosticListener.cs b/src/OpenTelemetry.Instrumentation.EntityFrameworkCore/Implementation/EntityFrameworkDiagnosticListener.cs
@@ -165,32 +165,24 @@ public override void OnEventWritten(string name, object? payload)
                             switch (commandType)
                             {
                                 case CommandType.StoredProcedure:
-                                    if (this.options.SetDbStatementForStoredProcedure)
-                                    {
-                                        DatabaseSemanticConventionHelper.ApplyConventionsForStoredProcedure(
-                                            activity,
-                                            commandText,
-                                            this.options.EmitOldAttributes,
-                                            this.options.EmitNewAttributes);
-                                    }
-
+                                    DatabaseSemanticConventionHelper.ApplyConventionsForStoredProcedure(
+                                        activity,
+                                        commandText,
+                                        this.options.EmitOldAttributes,
+                                        this.options.EmitNewAttributes);
                                     break;
 
                                 case CommandType.Text:
-                                    if (this.options.SetDbStatementForText)
-                                    {
-                                        // Only SQL-like providers support sanitization as we are not
-                                        // able to sanitize arbitrary commands for other query dialects.
-                                        bool sanitizeQuery = IsSqlLikeProvider(providerName);
-
-                                        DatabaseSemanticConventionHelper.ApplyConventionsForQueryText(
-                                            activity,
-                                            commandText,
-                                            this.options.EmitOldAttributes,
-                                            this.options.EmitNewAttributes,
-                                            sanitizeQuery);
-                                    }
-
+                                    // Only SQL-like providers support sanitization as we are not
+                                    // able to sanitize arbitrary commands for other query dialects.
+                                    bool sanitizeQuery = IsSqlLikeProvider(providerName);
+
+                                    DatabaseSemanticConventionHelper.ApplyConventionsForQueryText(
+                                        activity,
+                                        commandText,
+                                        this.options.EmitOldAttributes,
+                                        this.options.EmitNewAttributes,
+                                        sanitizeQuery);
                                     break;
 
                                 case CommandType.TableDirect:
diff --git a/src/OpenTelemetry.Instrumentation.EntityFrameworkCore/README.md b/src/OpenTelemetry.Instrumentation.EntityFrameworkCore/README.md
@@ -141,29 +141,6 @@ services.AddOpenTelemetry()
         .AddConsoleExporter());
 ```
 
-### SetDbStatementForText
-
-`SetDbStatementForText` controls whether the `db.statement` attribute is
-emitted. The behavior of `SetDbStatementForText` depends on the runtime used,
-see below for more details.
-
-Query text may contain sensitive data, so when `SetDbStatementForText` is
-enabled the raw query text is sanitized by automatically replacing literal
-values with a `?` character.
-
-> [!NOTE]
-> Query sanitization is only supported for the following SQL-like providers:
->
-> * Firebird
-> * GCP Spanner
-> * IBM DB2
-> * Microsoft SQL Server
-> * MySQL
-> * Oracle
-> * PostgreSQL
-> * SQLite
-> * Teradata
-
 ### SetDbQueryParameters
 
 `SetDbQueryParameters` controls whether `db.query.parameter.<key>` attributes
@@ -183,7 +160,7 @@ following configuration.
 ```csharp
 using var tracerProvider = Sdk.CreateTracerProviderBuilder()
     .AddEntityFrameworkCoreInstrumentation(
-        options => options.SetDbStatementForText = true)
+        options => options.SetDbQueryParameters = true)
     .AddConsoleExporter()
     .Build();
 ```
diff --git a/src/OpenTelemetry.Instrumentation.SqlClient/.publicApi/PublicAPI.Shipped.txt b/src/OpenTelemetry.Instrumentation.SqlClient/.publicApi/PublicAPI.Shipped.txt
@@ -0,0 +1 @@
+#nullable enable
diff --git a/src/OpenTelemetry.Instrumentation.SqlClient/.publicApi/PublicAPI.Unshipped.txt b/src/OpenTelemetry.Instrumentation.SqlClient/.publicApi/PublicAPI.Unshipped.txt
@@ -8,8 +8,6 @@ OpenTelemetry.Instrumentation.SqlClient.SqlClientTraceInstrumentationOptions.Rec
 OpenTelemetry.Instrumentation.SqlClient.SqlClientTraceInstrumentationOptions.RecordException.set -> void
 OpenTelemetry.Instrumentation.SqlClient.SqlClientTraceInstrumentationOptions.SetDbQueryParameters.get -> bool
 OpenTelemetry.Instrumentation.SqlClient.SqlClientTraceInstrumentationOptions.SetDbQueryParameters.set -> void
-OpenTelemetry.Instrumentation.SqlClient.SqlClientTraceInstrumentationOptions.SetDbStatementForText.get -> bool
-OpenTelemetry.Instrumentation.SqlClient.SqlClientTraceInstrumentationOptions.SetDbStatementForText.set -> void
 OpenTelemetry.Instrumentation.SqlClient.SqlClientTraceInstrumentationOptions.SqlClientTraceInstrumentationOptions() -> void
 OpenTelemetry.Metrics.SqlClientMeterProviderBuilderExtensions
 OpenTelemetry.Trace.TracerProviderBuilderExtensions
diff --git a/src/OpenTelemetry.Instrumentation.SqlClient/.publicApi/net8.0/PublicAPI.Shipped.txt b/src/OpenTelemetry.Instrumentation.SqlClient/.publicApi/net8.0/PublicAPI.Shipped.txt
@@ -0,0 +1 @@
+#nullable enable
diff --git a/src/OpenTelemetry.Instrumentation.SqlClient/CHANGELOG.md b/src/OpenTelemetry.Instrumentation.SqlClient/CHANGELOG.md
@@ -10,6 +10,10 @@
   listener.
   ([#3041](https://github.com/open-telemetry/opentelemetry-dotnet-contrib/pull/3041))
 
+* **Breaking change**: The `SetDbStatementForText` property has been removed.
+  Behaviors related to this option are now always enabled.
+  ([#3072](https://github.com/open-telemetry/opentelemetry-dotnet-contrib/pull/3072))
+
 ## 1.12.0-beta.2
 
 Released 2025-Jul-15
diff --git a/src/OpenTelemetry.Instrumentation.SqlClient/Implementation/SqlClientDiagnosticListener.cs b/src/OpenTelemetry.Instrumentation.SqlClient/Implementation/SqlClientDiagnosticListener.cs
@@ -162,15 +162,11 @@ public override void OnEventWritten(string name, object? payload)
                                     break;
 
                                 case CommandType.Text:
-                                    if (options.SetDbStatementForText)
-                                    {
-                                        DatabaseSemanticConventionHelper.ApplyConventionsForQueryText(
-                                            activity,
-                                            commandText,
-                                            options.EmitOldAttributes,
-                                            options.EmitNewAttributes);
-                                    }
-
+                                    DatabaseSemanticConventionHelper.ApplyConventionsForQueryText(
+                                        activity,
+                                        commandText,
+                                        options.EmitOldAttributes,
+                                        options.EmitNewAttributes);
                                     break;
 
                                 case CommandType.TableDirect:
diff --git a/src/OpenTelemetry.Instrumentation.SqlClient/Implementation/SqlEventSourceListener.netfx.cs b/src/OpenTelemetry.Instrumentation.SqlClient/Implementation/SqlEventSourceListener.netfx.cs
@@ -157,7 +157,7 @@ private void OnBeginExecute(EventWrittenEventArgs eventData)
         if (activity.IsAllDataRequested)
         {
             var commandText = (string)eventData.Payload[3];
-            if (!string.IsNullOrEmpty(commandText) && options.SetDbStatementForText)
+            if (!string.IsNullOrEmpty(commandText))
             {
                 var sqlStatementInfo = SqlProcessor.GetSanitizedSql(commandText);
                 if (options.EmitOldAttributes)
diff --git a/src/OpenTelemetry.Instrumentation.SqlClient/README.md b/src/OpenTelemetry.Instrumentation.SqlClient/README.md
@@ -121,76 +121,6 @@ For an ASP.NET application, adding instrumentation is typically done in the
 This instrumentation can be configured to change the default behavior by using
 `SqlClientTraceInstrumentationOptions`.
 
-### SetDbStatementForText
-
-`SetDbStatementForText` controls whether the `db.statement` attribute is
-emitted. The behavior of `SetDbStatementForText` depends on the runtime used,
-see below for more details.
-
-Query text may contain sensitive data, so when `SetDbStatementForText` is
-enabled the raw query text is sanitized by automatically replacing literal
-values with a `?` character.
-
-#### .NET
-
-On .NET, `SetDbStatementForText` controls whether or not
-this instrumentation will set the
-[`db.statement`](https://github.com/open-telemetry/semantic-conventions/blob/main/docs/database/database-spans.md#call-level-attributes)
-attribute to the `CommandText` of the `SqlCommand` being executed when the `CommandType`
-is `CommandType.Text`. The
-[`db.statement`](https://github.com/open-telemetry/semantic-conventions/blob/main/docs/database/database-spans.md#call-level-attributes)
-attribute is always captured for `CommandType.StoredProcedure` because the `SqlCommand.CommandText`
-only contains the stored procedure name.
-
-`SetDbStatementForText` is _false_ by default. When set to `true`, the
-instrumentation will set
-[`db.statement`](https://github.com/open-telemetry/semantic-conventions/blob/main/docs/database/database-spans.md#call-level-attributes)
-attribute to the text of the SQL command being executed.
-
-To enable capturing of `SqlCommand.CommandText` for `CommandType.Text` use the
-following configuration.
-
-```csharp
-using var tracerProvider = Sdk.CreateTracerProviderBuilder()
-    .AddSqlClientInstrumentation(
-        options => options.SetDbStatementForText = true)
-    .AddConsoleExporter()
-    .Build();
-```
-
-#### .NET Framework
-
-On .NET Framework, there is no way to determine the type of command being
-executed, so the `SetDbStatementForText` property always controls whether
-or not this instrumentation will set the
-[`db.statement`](https://github.com/open-telemetry/semantic-conventions/blob/main/docs/database/database-spans.md#call-level-attributes)
-attribute to the `CommandText` of the `SqlCommand` being executed. The
-`CommandText` could be the name of a stored procedure (when
-`CommandType.StoredProcedure` is used) or the full text of a `CommandType.Text`
-query.
-
-`SetDbStatementForText` is _false_ by default. When set to `true`, the
-instrumentation will set
-[`db.statement`](https://github.com/open-telemetry/semantic-conventions/blob/main/docs/database/database-spans.md#call-level-attributes)
-attribute to the text of the SQL command being executed.
-
-To enable capturing of `SqlCommand.CommandText` for `CommandType.Text` use the
-following configuration.
-
-```csharp
-using var tracerProvider = Sdk.CreateTracerProviderBuilder()
-    .AddSqlClientInstrumentation(
-        options => options.SetDbStatementForText = true)
-    .AddConsoleExporter()
-    .Build();
-```
-
-> [!NOTE]
-> When using the built-in `System.Data.SqlClient`, only stored procedure command
-names will be captured. To capture query text, other command text and
-stored procedure command names, you need to use the `Microsoft.Data.SqlClient`
-NuGet package (v1.1+).
-
 ### SetDbQueryParameters
 
 > [!NOTE]
@@ -199,10 +129,10 @@ NuGet package (v1.1+).
 `SetDbQueryParameters` controls whether `db.query.parameter.<key>` attributes
 are emitted.
 
-Query parameters may contain sensitive data, so only enable `SetDbStatementForText`
+Query parameters may contain sensitive data, so only enable `SetDbQueryParameters`
 if your queries and/or environment are appropriate for enabling this option.
 
-`SetDbQueryParameters` is _false_ by default. When set to `true`, the
+`SetDbQueryParameters` is `false` by default. When set to `true`, the
 instrumentation will set
 [`db.query.parameter.<key>`](https://github.com/open-telemetry/semantic-conventions/blob/main/docs/database/database-spans.md#span-definition)
 attributes for each of the query parameters associated with a database command.
@@ -213,15 +143,15 @@ following configuration.
 ```csharp
 using var tracerProvider = Sdk.CreateTracerProviderBuilder()
     .AddSqlClientInstrumentation(
-        options => options.SetDbStatementForText = true)
+        options => options.SetDbQueryParameters = true)
     .AddConsoleExporter()
     .Build();
 ```
 
 ### Enrich
 
 > [!NOTE]
-> Enrich is supported on .NET and .NET Core runtimes only.
+> Enrich is available on .NET runtimes only.
 
 This option can be used to enrich the activity with additional information from
 the raw `SqlCommand` object. The `Enrich` action is called only when
@@ -258,7 +188,7 @@ access to `SqlCommand` object.
 ### RecordException
 
 > [!NOTE]
-> RecordException is supported on .NET and .NET Core runtimes only.
+> RecordException is available on .NET runtimes only.
 
 This option can be set to instruct the instrumentation to record SqlExceptions
 as Activity
@@ -277,7 +207,7 @@ using var tracerProvider = Sdk.CreateTracerProviderBuilder()
 ### Filter
 
 > [!NOTE]
-> Filter is supported on .NET and .NET Core runtimes only.
+> Filter is available on .NET runtimes only.
 
 This option can be used to filter out activities based on the properties of the
 `SqlCommand` object being instrumented using a `Func<object, bool>`. The
diff --git a/src/OpenTelemetry.Instrumentation.SqlClient/SqlClientTraceInstrumentationOptions.cs b/src/OpenTelemetry.Instrumentation.SqlClient/SqlClientTraceInstrumentationOptions.cs
@@ -1,13 +1,11 @@
 // Copyright The OpenTelemetry Authors
 // SPDX-License-Identifier: Apache-2.0
 
-using System.Data;
 using System.Diagnostics;
 using Microsoft.Extensions.Configuration;
 #if NET
 using OpenTelemetry.Instrumentation.SqlClient.Implementation;
 #endif
-using OpenTelemetry.Trace;
 using static OpenTelemetry.Internal.DatabaseSemanticConventionHelper;
 
 namespace OpenTelemetry.Instrumentation.SqlClient;
@@ -49,43 +47,12 @@ internal SqlClientTraceInstrumentationOptions(IConfiguration configuration)
 #endif
     }
 
-    /// <summary>
-    /// Gets or sets a value indicating whether or not the <see cref="SqlClientInstrumentation"/>
-    /// should add the text of commands as the <see cref="SemanticConventions.AttributeDbStatement"/> tag.
-    /// Default value: <see langword="false"/>.
-    /// </summary>
-    /// <remarks>
-    /// <para>
-    /// <b>WARNING: SetDbStatementForText will capture the raw
-    /// <c>CommandText</c>. Make sure your <c>CommandText</c> property never
-    /// contains any sensitive data.</b>
-    /// </para>
-    /// <para><b>SetDbStatementForText is supported on all runtimes.</b>
-    /// <list type="bullet">
-    /// <item>On .NET and .NET Core SetDbStatementForText only applies to
-    /// <c>SqlCommand</c>s with <see cref="CommandType.Text"/>.</item>
-    /// <item>On .NET Framework SetDbStatementForText applies to all
-    /// <c>SqlCommand</c>s regardless of <see cref="CommandType"/>.
-    /// <list type="bullet">
-    /// <item>When using <c>System.Data.SqlClient</c> use
-    /// SetDbStatementForText to capture StoredProcedure command
-    /// names.</item>
-    /// <item>When using <c>Microsoft.Data.SqlClient</c> use
-    /// SetDbStatementForText to capture Text, StoredProcedure, and all
-    /// other command text.</item>
-    /// </list></item>
-    /// </list>
-    /// </para>
-    /// </remarks>
-    public bool SetDbStatementForText { get; set; }
-
     /// <summary>
     /// Gets or sets an action to enrich an <see cref="Activity"/> with the
     /// raw <c>SqlCommand</c> object.
     /// </summary>
     /// <remarks>
-    /// <para><b>Enrich is only executed on .NET and .NET Core
-    /// runtimes.</b></para>
+    /// <para><b>Enrich is only executed on .NET runtimes.</b></para>
     /// The parameters passed to the enrich action are:
     /// <list type="number">
     /// <item>The <see cref="Activity"/> being enriched.</item>
@@ -103,8 +70,7 @@ internal SqlClientTraceInstrumentationOptions(IConfiguration configuration)
     /// collect telemetry about a command.
     /// </summary>
     /// <remarks>
-    /// <para><b>Filter is only executed on .NET and .NET Core
-    /// runtimes.</b></para>
+    /// <para><b>Filter is only executed on .NET runtimes.</b></para>
     /// Notes:
     /// <list type="bullet">
     /// <item>The first parameter passed to the filter function is the raw
@@ -126,8 +92,7 @@ internal SqlClientTraceInstrumentationOptions(IConfiguration configuration)
     /// langword="false"/>.
     /// </summary>
     /// <remarks>
-    /// <para><b>RecordException is only supported on .NET and .NET Core
-    /// runtimes.</b></para>
+    /// <para><b>RecordException is only supported on .NET runtimes.</b></para>
     /// <para>For specification details see: <see
     /// href="https://github.com/open-telemetry/semantic-conventions/blob/main/docs/exceptions/exceptions-spans.md"/>.</para>
     /// </remarks>
diff --git a/test/OpenTelemetry.Instrumentation.EntityFrameworkCore.Tests/EntityFrameworkIntegrationTests.cs b/test/OpenTelemetry.Instrumentation.EntityFrameworkCore.Tests/EntityFrameworkIntegrationTests.cs
diff --git a/test/OpenTelemetry.Instrumentation.SqlClient.Tests/SqlClientIntegrationTests.cs b/test/OpenTelemetry.Instrumentation.SqlClient.Tests/SqlClientIntegrationTests.cs
diff --git a/test/OpenTelemetry.Instrumentation.SqlClient.Tests/SqlClientTests.cs b/test/OpenTelemetry.Instrumentation.SqlClient.Tests/SqlClientTests.cs
diff --git a/test/OpenTelemetry.Instrumentation.SqlClient.Tests/SqlClientTraceInstrumentationOptionsTests.cs b/test/OpenTelemetry.Instrumentation.SqlClient.Tests/SqlClientTraceInstrumentationOptionsTests.cs
diff --git a/test/OpenTelemetry.Instrumentation.SqlClient.Tests/SqlEventSourceTests.netfx.cs b/test/OpenTelemetry.Instrumentation.SqlClient.Tests/SqlEventSourceTests.netfx.cs
