[SqlClient] Remove non-functional netfx properties (#3079)

martincostello · web-flow · commit 8409e20be3ff · 2025-09-25T06:26:50.000+02:00
diff --git a/src/OpenTelemetry.Instrumentation.SqlClient/.publicApi/.NETCoreApp/PublicAPI.Unshipped.txt b/src/OpenTelemetry.Instrumentation.SqlClient/.publicApi/.NETCoreApp/PublicAPI.Unshipped.txt
@@ -0,0 +1,7 @@
+#nullable enable
+OpenTelemetry.Instrumentation.SqlClient.SqlClientTraceInstrumentationOptions.Enrich.get -> System.Action<System.Diagnostics.Activity!, string!, object!>?
+OpenTelemetry.Instrumentation.SqlClient.SqlClientTraceInstrumentationOptions.Enrich.set -> void
+OpenTelemetry.Instrumentation.SqlClient.SqlClientTraceInstrumentationOptions.Filter.get -> System.Func<object!, bool>?
+OpenTelemetry.Instrumentation.SqlClient.SqlClientTraceInstrumentationOptions.Filter.set -> void
+OpenTelemetry.Instrumentation.SqlClient.SqlClientTraceInstrumentationOptions.RecordException.get -> bool
+OpenTelemetry.Instrumentation.SqlClient.SqlClientTraceInstrumentationOptions.RecordException.set -> void
diff --git a/src/OpenTelemetry.Instrumentation.SqlClient/.publicApi/.NETStandard/PublicAPI.Shipped.txt b/src/OpenTelemetry.Instrumentation.SqlClient/.publicApi/.NETStandard/PublicAPI.Shipped.txt
@@ -0,0 +1 @@
+#nullable enable
diff --git a/src/OpenTelemetry.Instrumentation.SqlClient/.publicApi/.NETStandard/PublicAPI.Unshipped.txt b/src/OpenTelemetry.Instrumentation.SqlClient/.publicApi/.NETStandard/PublicAPI.Unshipped.txt
@@ -0,0 +1,7 @@
+#nullable enable
+OpenTelemetry.Instrumentation.SqlClient.SqlClientTraceInstrumentationOptions.Enrich.get -> System.Action<System.Diagnostics.Activity!, string!, object!>?
+OpenTelemetry.Instrumentation.SqlClient.SqlClientTraceInstrumentationOptions.Enrich.set -> void
+OpenTelemetry.Instrumentation.SqlClient.SqlClientTraceInstrumentationOptions.Filter.get -> System.Func<object!, bool>?
+OpenTelemetry.Instrumentation.SqlClient.SqlClientTraceInstrumentationOptions.Filter.set -> void
+OpenTelemetry.Instrumentation.SqlClient.SqlClientTraceInstrumentationOptions.RecordException.get -> bool
+OpenTelemetry.Instrumentation.SqlClient.SqlClientTraceInstrumentationOptions.RecordException.set -> void
diff --git a/src/OpenTelemetry.Instrumentation.SqlClient/.publicApi/PublicAPI.Unshipped.txt b/src/OpenTelemetry.Instrumentation.SqlClient/.publicApi/PublicAPI.Unshipped.txt
@@ -1,11 +1,5 @@
 #nullable enable
 OpenTelemetry.Instrumentation.SqlClient.SqlClientTraceInstrumentationOptions
-OpenTelemetry.Instrumentation.SqlClient.SqlClientTraceInstrumentationOptions.Enrich.get -> System.Action<System.Diagnostics.Activity!, string!, object!>?
-OpenTelemetry.Instrumentation.SqlClient.SqlClientTraceInstrumentationOptions.Enrich.set -> void
-OpenTelemetry.Instrumentation.SqlClient.SqlClientTraceInstrumentationOptions.Filter.get -> System.Func<object!, bool>?
-OpenTelemetry.Instrumentation.SqlClient.SqlClientTraceInstrumentationOptions.Filter.set -> void
-OpenTelemetry.Instrumentation.SqlClient.SqlClientTraceInstrumentationOptions.RecordException.get -> bool
-OpenTelemetry.Instrumentation.SqlClient.SqlClientTraceInstrumentationOptions.RecordException.set -> void
 OpenTelemetry.Instrumentation.SqlClient.SqlClientTraceInstrumentationOptions.SqlClientTraceInstrumentationOptions() -> void
 OpenTelemetry.Metrics.SqlClientMeterProviderBuilderExtensions
 OpenTelemetry.Trace.TracerProviderBuilderExtensions
diff --git a/src/OpenTelemetry.Instrumentation.SqlClient/CHANGELOG.md b/src/OpenTelemetry.Instrumentation.SqlClient/CHANGELOG.md
@@ -16,6 +16,10 @@
   Behaviors related to this option are now always enabled.
   ([#3072](https://github.com/open-telemetry/opentelemetry-dotnet-contrib/pull/3072))
 
+* **Breaking change**: The `Enrich`, `Filter` and `RecordException` properties have
+  been removed for .NET Framework where they were non-functional.
+  ([#3079](https://github.com/open-telemetry/opentelemetry-dotnet-contrib/pull/3079))
+
 ## 1.12.0-beta.2
 
 Released 2025-Jul-15
diff --git a/src/OpenTelemetry.Instrumentation.SqlClient/CompatibilitySuppressions.xml b/src/OpenTelemetry.Instrumentation.SqlClient/CompatibilitySuppressions.xml
@@ -0,0 +1,39 @@
+<?xml version="1.0" encoding="utf-8"?>
+<Suppressions xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
+    <Suppression>
+        <DiagnosticId>CP0002</DiagnosticId>
+        <Target>M:OpenTelemetry.Instrumentation.SqlClient.SqlClientTraceInstrumentationOptions.get_Enrich</Target>
+        <Left>lib/netstandard2.0/OpenTelemetry.Instrumentation.SqlClient.dll</Left>
+        <Right>lib/net462/OpenTelemetry.Instrumentation.SqlClient.dll</Right>
+    </Suppression>
+    <Suppression>
+        <DiagnosticId>CP0002</DiagnosticId>
+        <Target>M:OpenTelemetry.Instrumentation.SqlClient.SqlClientTraceInstrumentationOptions.get_Filter</Target>
+        <Left>lib/netstandard2.0/OpenTelemetry.Instrumentation.SqlClient.dll</Left>
+        <Right>lib/net462/OpenTelemetry.Instrumentation.SqlClient.dll</Right>
+    </Suppression>
+    <Suppression>
+        <DiagnosticId>CP0002</DiagnosticId>
+        <Target>M:OpenTelemetry.Instrumentation.SqlClient.SqlClientTraceInstrumentationOptions.get_RecordException</Target>
+        <Left>lib/netstandard2.0/OpenTelemetry.Instrumentation.SqlClient.dll</Left>
+        <Right>lib/net462/OpenTelemetry.Instrumentation.SqlClient.dll</Right>
+    </Suppression>
+    <Suppression>
+        <DiagnosticId>CP0002</DiagnosticId>
+        <Target>M:OpenTelemetry.Instrumentation.SqlClient.SqlClientTraceInstrumentationOptions.set_Enrich(System.Action{System.Diagnostics.Activity,System.String,System.Object})</Target>
+        <Left>lib/netstandard2.0/OpenTelemetry.Instrumentation.SqlClient.dll</Left>
+        <Right>lib/net462/OpenTelemetry.Instrumentation.SqlClient.dll</Right>
+    </Suppression>
+    <Suppression>
+        <DiagnosticId>CP0002</DiagnosticId>
+        <Target>M:OpenTelemetry.Instrumentation.SqlClient.SqlClientTraceInstrumentationOptions.set_Filter(System.Func{System.Object,System.Boolean})</Target>
+        <Left>lib/netstandard2.0/OpenTelemetry.Instrumentation.SqlClient.dll</Left>
+        <Right>lib/net462/OpenTelemetry.Instrumentation.SqlClient.dll</Right>
+    </Suppression>
+    <Suppression>
+        <DiagnosticId>CP0002</DiagnosticId>
+        <Target>M:OpenTelemetry.Instrumentation.SqlClient.SqlClientTraceInstrumentationOptions.set_RecordException(System.Boolean)</Target>
+        <Left>lib/netstandard2.0/OpenTelemetry.Instrumentation.SqlClient.dll</Left>
+        <Right>lib/net462/OpenTelemetry.Instrumentation.SqlClient.dll</Right>
+    </Suppression>
+</Suppressions>
diff --git a/src/OpenTelemetry.Instrumentation.SqlClient/Implementation/SqlClientDiagnosticListener.cs b/src/OpenTelemetry.Instrumentation.SqlClient/Implementation/SqlClientDiagnosticListener.cs
@@ -127,13 +127,15 @@ public override void OnEventWritten(string name, object? payload)
                     {
                         try
                         {
+#if !NETFRAMEWORK
                             if (options.Filter?.Invoke(command) == false)
                             {
                                 SqlClientInstrumentationEventSource.Log.CommandIsFilteredOut(activity.OperationName);
                                 activity.IsAllDataRequested = false;
                                 activity.ActivityTraceFlags &= ~ActivityTraceFlags.Recorded;
                                 return;
                             }
+#endif
                         }
                         catch (Exception ex)
                         {
@@ -175,6 +177,7 @@ public override void OnEventWritten(string name, object? payload)
                             }
                         }
 
+#if !NETFRAMEWORK
                         try
                         {
                             options.Enrich?.Invoke(activity, "OnCustom", command);
@@ -183,6 +186,7 @@ public override void OnEventWritten(string name, object? payload)
                         {
                             SqlClientInstrumentationEventSource.Log.EnrichmentException(ex);
                         }
+#endif
                     }
                 }
 
@@ -261,10 +265,12 @@ public override void OnEventWritten(string name, object? payload)
 
                                 activity.SetStatus(ActivityStatusCode.Error, exception.Message);
 
+#if !NETFRAMEWORK
                                 if (options.RecordException)
                                 {
                                     activity.AddException(exception);
                                 }
+#endif
                             }
                             else
                             {
diff --git a/src/OpenTelemetry.Instrumentation.SqlClient/SqlClientTraceInstrumentationOptions.cs b/src/OpenTelemetry.Instrumentation.SqlClient/SqlClientTraceInstrumentationOptions.cs
@@ -1,7 +1,9 @@
 // Copyright The OpenTelemetry Authors
 // SPDX-License-Identifier: Apache-2.0
 
+#if !NETFRAMEWORK
 using System.Diagnostics;
+#endif
 using Microsoft.Extensions.Configuration;
 #if NET
 using OpenTelemetry.Instrumentation.SqlClient.Implementation;
@@ -56,6 +58,7 @@ internal SqlClientTraceInstrumentationOptions(IConfiguration configuration)
 #endif
     }
 
+#if !NETFRAMEWORK
     /// <summary>
     /// Gets or sets an action to enrich an <see cref="Activity"/> with the
     /// raw <c>SqlCommand</c> object.
@@ -106,6 +109,7 @@ internal SqlClientTraceInstrumentationOptions(IConfiguration configuration)
     /// href="https://github.com/open-telemetry/semantic-conventions/blob/main/docs/exceptions/exceptions-spans.md"/>.</para>
     /// </remarks>
     public bool RecordException { get; set; }
+#endif
 
 #if !NETFRAMEWORK
     /// <summary>
diff --git a/test/OpenTelemetry.Instrumentation.SqlClient.Tests/SqlClientIntegrationTests.cs b/test/OpenTelemetry.Instrumentation.SqlClient.Tests/SqlClientIntegrationTests.cs
@@ -57,7 +57,12 @@ public void SuccessfulCommandTest(
         using var tracerProvider = Sdk.CreateTracerProviderBuilder()
             .SetSampler(sampler)
             .AddInMemoryExporter(activities)
-            .AddSqlClientInstrumentation(options => options.RecordException = recordException)
+            .AddSqlClientInstrumentation(options =>
+            {
+#if NET
+                options.RecordException = recordException;
+#endif
+            })
             .Build();
 
         using var sqlConnection = new SqlConnection(this.GetConnectionString());
diff --git a/test/OpenTelemetry.Instrumentation.SqlClient.Tests/SqlClientTests.cs b/test/OpenTelemetry.Instrumentation.SqlClient.Tests/SqlClientTests.cs
@@ -141,7 +141,12 @@ public void SpansAndMetricsGeneratedOnlyWhenEnabled(bool tracesEnabled, bool met
         if (tracesEnabled)
         {
             tracerProviderBuilder
-                .AddSqlClientInstrumentation(options => options.RecordException = true)
+                .AddSqlClientInstrumentation(options =>
+                {
+#if NET
+                    options.RecordException = true;
+#endif
+                })
                 .AddInMemoryExporter(activities);
         }
 
@@ -337,7 +342,9 @@ private void RunSqlClientTestCase(
             .SetSampler(sampler)
             .AddSqlClientInstrumentation(options =>
             {
+#if NET
                 options.RecordException = true;
+#endif
                 options.EmitOldAttributes = emitOldAttributes;
                 options.EmitNewAttributes = emitNewAttributes;
             })
diff --git a/test/OpenTelemetry.Instrumentation.SqlClient.Tests/SqlClientTraceInstrumentationOptionsTests.cs b/test/OpenTelemetry.Instrumentation.SqlClient.Tests/SqlClientTraceInstrumentationOptionsTests.cs
@@ -3,7 +3,9 @@
 
 using System.Data;
 using System.Diagnostics;
+#if NET
 using Microsoft.Data.SqlClient;
+#endif
 using Microsoft.Extensions.Configuration;
 using Microsoft.Extensions.DependencyInjection;
 using OpenTelemetry.Internal;
@@ -238,7 +240,6 @@ public void ShouldAssignSetDatabaseQueryParametersFromEnvironmentVariable(string
         var options = new SqlClientTraceInstrumentationOptions(configuration);
         Assert.Equal(expected, options.SetDbQueryParameters);
     }
-#endif
 
     private static void ActivityEnrichment(Activity activity, string method, object obj)
     {
@@ -274,4 +275,5 @@ private Activity[] RunCommandWithFilter(
 
         return [.. activities];
     }
+#endif
 }

Original file line number	Diff line number	Diff line change
`@@ -127,13 +127,15 @@ public override void OnEventWritten(string name, object? payload)`
`127`	`127`	`{`
`128`	`128`	`try`
`129`	`129`	`{`
	`130`	`+#if !NETFRAMEWORK`
`130`	`131`	`if (options.Filter?.Invoke(command) == false)`
`131`	`132`	`{`
`132`	`133`	`SqlClientInstrumentationEventSource.Log.CommandIsFilteredOut(activity.OperationName);`
`133`	`134`	`activity.IsAllDataRequested = false;`
`134`	`135`	`activity.ActivityTraceFlags &= ~ActivityTraceFlags.Recorded;`
`135`	`136`	`return;`
`136`	`137`	`}`
	`138`	`+#endif`
`137`	`139`	`}`
`138`	`140`	`catch (Exception ex)`
`139`	`141`	`{`
`@@ -175,6 +177,7 @@ public override void OnEventWritten(string name, object? payload)`
`175`	`177`	`}`
`176`	`178`	`}`
`177`	`179`
	`180`	`+#if !NETFRAMEWORK`
`178`	`181`	`try`
`179`	`182`	`{`
`180`	`183`	`options.Enrich?.Invoke(activity, "OnCustom", command);`
`@@ -183,6 +186,7 @@ public override void OnEventWritten(string name, object? payload)`
`183`	`186`	`{`
`184`	`187`	`SqlClientInstrumentationEventSource.Log.EnrichmentException(ex);`
`185`	`188`	`}`
	`189`	`+#endif`
`186`	`190`	`}`
`187`	`191`	`}`
`188`	`192`
`@@ -261,10 +265,12 @@ public override void OnEventWritten(string name, object? payload)`
`261`	`265`
`262`	`266`	`activity.SetStatus(ActivityStatusCode.Error, exception.Message);`
`263`	`267`
	`268`	`+#if !NETFRAMEWORK`
`264`	`269`	`if (options.RecordException)`
`265`	`270`	`{`
`266`	`271`	`activity.AddException(exception);`
`267`	`272`	`}`
	`273`	`+#endif`
`268`	`274`	`}`
`269`	`275`	`else`
`270`	`276`	`{`