[FileBasedConfiguration] Support for IL rewrite for SqlClient (#4721)

Author: ysolomchenko

CHANGELOG.md

@@ -14,6 +14,8 @@ This component adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.h
 - Support for [`NLog`](https://www.nuget.org/packages/NLog/)
   logs instrumentation for versions `5.*` and `6.*` on .NET using duck typing
   for zero-config auto-injection.
+- Support for file-based configuration of the IL rewrite for
+  SqlClient instrumentation setting
 
 ### Changed
 

docs/file-based-configuration.md

@@ -51,7 +51,6 @@ file-based configuration to include these parameters.
 | `OTEL_DOTNET_AUTO_EXCLUDE_PROCESSES`                 | Names of the executable files that the profiler cannot instrument.                                                        |
 | `OTEL_DOTNET_AUTO_OPENTRACING_ENABLED`               | Enables OpenTracing tracer.                                                                                               |
 | `OTEL_DOTNET_AUTO_NETFX_REDIRECT_ENABLED`            | Enables automatic redirection of the assemblies used by the automatic instrumentation on the .NET Framework.              |
-| `OTEL_DOTNET_AUTO_SQLCLIENT_NETFX_ILREWRITE_ENABLED` | Enables IL rewriting of `SqlCommand` on .NET Framework to ensure `CommandText` is present for `SqlClient` instrumentation |
 
 ---
 
@@ -543,6 +542,10 @@ instrumentation/development:
         # Whether the Oracle Client instrumentation can pass SQL statements through the db.statement attribute. Queries might contain sensitive information. If set to false, db.statement is recorded only for executing stored procedures.
         # Default is false
         set_db_statement_for_text: false
+      sqlclient:
+        # Enables IL rewriting of SqlCommand on .NET Framework to ensure CommandText is available for instrumentation.
+        # Default is false
+        netfx_ilrewrite_enabled: false
       aspnet:
         # A comma-separated list of HTTP header names. ASP.NET instrumentations will capture HTTP request header values for all configured header names.
         capture_request_headers: "X-Key,X-Custom-Header,X-Header-Example"

examples/file-based-configuration-files/kitchen-sink.yaml

@@ -595,6 +595,9 @@ instrumentation/development:
       rabbitmq:            # RabbitMQ.Client
       quartz:              # Quartz
       sqlclient:           # Microsoft.Data.SqlClient & System.Data.SqlClient
+        # Enables IL rewriting of SqlCommand on .NET Framework to ensure CommandText is available for instrumentation.
+        # If omitted false is used.
+        netfx_ilrewrite_enabled: false
       stackexchangeredis:  # StackExchange.Redis
       wcfclient:           # WCF Client
       wcfservice:          # WCF Service

examples/file-based-configuration-files/sdk-migration-config.yaml

@@ -236,6 +236,9 @@ instrumentation/development:
       rabbitmq:            # RabbitMQ.Client
       quartz:              # Quartz
       sqlclient:           # Microsoft.Data.SqlClient & System.Data.SqlClient
+        # Enables IL rewriting of SqlCommand on .NET Framework to ensure CommandText is available for instrumentation.
+        # If omitted false is used.
+        netfx_ilrewrite_enabled: ${OTEL_DOTNET_AUTO_SQLCLIENT_NETFX_ILREWRITE_ENABLED:-false}
       stackexchangeredis:  # StackExchange.Redis
       wcfclient:           # WCF Client
       wcfservice:          # WCF Service

src/OpenTelemetry.AutoInstrumentation.Native/CMakeLists.txt

@@ -150,6 +150,7 @@ endif()
 add_library("OpenTelemetry.AutoInstrumentation.Native.static" STATIC
         class_factory.cpp
         clr_helpers.cpp
+	configuration.cpp
         continuous_profiler_clr_helpers.cpp
         continuous_profiler.cpp
         cor_profiler_base.cpp

src/OpenTelemetry.AutoInstrumentation.Native/OpenTelemetry.AutoInstrumentation.Native.def

@@ -7,6 +7,7 @@ EXPORTS
     IsProfilerAttached
     AddInstrumentations
     AddDerivedInstrumentations
+    SetSqlClientNetFxILRewriteEnabled
     InitializeTraceMethods
     ConfigureContinuousProfiler
     ContinuousProfilerReadThreadSamples

src/OpenTelemetry.AutoInstrumentation.Native/OpenTelemetry.AutoInstrumentation.Native.vcxproj

@@ -174,6 +174,7 @@
     <ClInclude Include="calltarget_tokens.h" />
     <ClInclude Include="class_factory.h" />
     <ClInclude Include="com_ptr.h" />
+    <ClInclude Include="configuration.h" />
     <ClInclude Include="continuous_profiler_clr_helpers.h" />
     <ClInclude Include="continuous_profiler.h" />
     <ClInclude Include="cor_profiler.h" />
@@ -220,6 +221,7 @@
     <ClCompile Include="calltarget_tokens.cpp" />
     <ClCompile Include="class_factory.cpp" />
     <ClCompile Include="clr_helpers.cpp" />
+    <ClCompile Include="configuration.cpp" />
     <ClCompile Include="continuous_profiler_clr_helpers.cpp" />
     <ClCompile Include="continuous_profiler.cpp" />
     <ClCompile Include="cor_profiler_base.cpp" />

src/OpenTelemetry.AutoInstrumentation.Native/configuration.cpp

@@ -0,0 +1,23 @@
+/*
+ * Copyright The OpenTelemetry Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+#include "configuration.h"
+
+namespace trace
+{
+
+bool sqlclient_netfx_ilrewrite_enabled = false;
+
+bool IsSqlClientNetFxILRewriteEnabled()
+{
+    return sqlclient_netfx_ilrewrite_enabled;
+}
+
+void SetSqlClientNetFxILRewriteEnabled(bool enabled)
+{
+    sqlclient_netfx_ilrewrite_enabled = enabled;
+}
+
+} // namespace trace

src/OpenTelemetry.AutoInstrumentation.Native/configuration.h

@@ -0,0 +1,17 @@
+/*
+ * Copyright The OpenTelemetry Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+#ifndef OTEL_CLR_CONFIGURATION_H_
+#define OTEL_CLR_CONFIGURATION_H_
+
+namespace trace
+{
+
+bool IsSqlClientNetFxILRewriteEnabled();
+void SetSqlClientNetFxILRewriteEnabled(bool enabled);
+
+} // namespace trace
+
+#endif // OTEL_CLR_CONFIGURATION_H_

src/OpenTelemetry.AutoInstrumentation.Native/cor_profiler.cpp

@@ -12,6 +12,7 @@
 #include "dllmain.h"
 #include "environment_variables.h"
 #include "environment_variables_util.h"
+#include "configuration.h"
 #include "il_rewriter.h"
 #include "il_rewriter_wrapper.h"
 #include "stub_generator.h"