open-telemetry · Kielek · Feb 1, 2023 · Jan 25, 2023 · Jan 25, 2023 · Jan 25, 2023
@@ -29,6 +29,24 @@ This beta release is built on top of [OpenTelemetry .NET](https://github.com/ope
   to `linux-musl-x64` for Linux musl and
   `OpenTelemetry.AutoInstrumentation.Native.dylib`
   to `osx-x64` for MacOS.
+- Change the way to manage enabled instrumentations. The following environmental
+  variables:
+  - `OTEL_DOTNET_AUTO_TRACES_ENABLED_INSTRUMENTATIONS`,
+  - `OTEL_DOTNET_AUTO_TRACES_DISABLED_INSTRUMENTATIONS`z,
+  - `OTEL_DOTNET_AUTO_METRICS_ENABLED_INSTRUMENTATIONS`,
+  - `OTEL_DOTNET_AUTO_METRICS_DISABLED_INSTRUMENTATIONS`,
+  - `OTEL_DOTNET_AUTO_LOGS_ENABLED_INSTRUMENTATIONS`,
+  - `OTEL_DOTNET_AUTO_LOGS_DISABLED_INSTRUMENTATIONS`
+
+  are replaced by:
+
+  - `OTEL_DOTNET_AUTO_INSTRUMENTATION_ENABLED`,
+  - `OTEL_DOTNET_AUTO_TRACES_INSTRUMENTATION_ENABLED`,
+  - `OTEL_DOTNET_AUTO_TRACES_{0}_INSTRUMENTATION_ENABLED`,
+  - `OTEL_DOTNET_AUTO_METRICS_INSTRUMENTATION_ENABLED`,
+  - `OTEL_DOTNET_AUTO_METRICS_{0}_INSTRUMENTATION_ENABLED`,
+  - `OTEL_DOTNET_AUTO_LOGS_INSTRUMENTATION_ENABLED`,
+  - `OTEL_DOTNET_AUTO_LOGS_{0}_INSTRUMENTATION_ENABLED`.
 
 ### Deprecated
 

@@ -63,15 +63,16 @@ for more details.
 
 ## Instrumentations
 
-| Environment variable                                 | Description                                                                                                                                                                                                                                                     | Default value                  |
-|------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------|
-| `OTEL_DOTNET_AUTO_INTEGRATIONS_FILE`                 | List of bytecode instrumentations JSON configuration filepaths, delimited by the platform-specific path separator (`;` on Windows, `:` on Linux and macOS). For example: `%ProfilerDirectory%/integrations.json`. It is required for bytecode instrumentations. |                                |
-| `OTEL_DOTNET_AUTO_TRACES_ENABLED_INSTRUMENTATIONS`   | Comma-separated list of traces source instrumentations you want to enable. Set to `none` to disable all trace instrumentations.                                                                                                                                 | all available instrumentations |
-| `OTEL_DOTNET_AUTO_TRACES_DISABLED_INSTRUMENTATIONS`  | Comma-separated list of traces source and bytecode instrumentations you want to disable.                                                                                                                                                                        |                                |
-| `OTEL_DOTNET_AUTO_METRICS_ENABLED_INSTRUMENTATIONS`  | Comma-separated list of metrics source instrumentations you want to enable. Set to `none` to disable all metric instrumentations.                                                                                                                               | all available instrumentations |
-| `OTEL_DOTNET_AUTO_METRICS_DISABLED_INSTRUMENTATIONS` | Comma-separated list of metrics source instrumentations you want to disable.                                                                                                                                                                                    |                                |
-| `OTEL_DOTNET_AUTO_LOGS_ENABLED_INSTRUMENTATIONS`     | Comma-separated list of logs source instrumentations you want to enable. Set to `none` to disable all metric instrumentations.                                                                                                                                  | all available instrumentations |
-| `OTEL_DOTNET_AUTO_LOGS_DISABLED_INSTRUMENTATIONS`    | Comma-separated list of logs source instrumentations you want to disable.                                                                                                                                                                                       |                                |
+| Environment variable                                   | Description                                                                                                                                                                                                                                                     | Default value                                              |
+|--------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------|
+| `OTEL_DOTNET_AUTO_INTEGRATIONS_FILE`                   | List of bytecode instrumentations JSON configuration filepaths, delimited by the platform-specific path separator (`;` on Windows, `:` on Linux and macOS). For example: `%ProfilerDirectory%/integrations.json`. It is required for bytecode instrumentations. |                                                            |
+| `OTEL_DOTNET_AUTO_INSTRUMENTATION_ENABLED`             | Enables all instrumentations.                                                                                                                                                                                                                                   | `true`                                                     |
+| `OTEL_DOTNET_AUTO_TRACES_INSTRUMENTATION_ENABLED`      | Enables all trace instrumentations. Overrides `OTEL_DOTNET_AUTO_INSTRUMENTATION_ENABLED`.                                                                                                                                                                       | Same as `OTEL_DOTNET_AUTO_INSTRUMENTATION_ENABLED`         |
+| `OTEL_DOTNET_AUTO_TRACES_{0}_INSTRUMENTATION_ENABLED`  | Configuration pattern for enabling or disabling a specific trace instrumentation, where `{0}` is the case-sensitive name of the instrumentation you want to enable. Overrides `OTEL_DOTNET_AUTO_TRACES_INSTRUMENTATION_ENABLED`.                                | Same as `OTEL_DOTNET_AUTO_TRACES_INSTRUMENTATION_ENABLED`  |
+| `OTEL_DOTNET_AUTO_METRICS_INSTRUMENTATION_ENABLED`     | Enables all metric instrumentations. Overrides `OTEL_DOTNET_AUTO_INSTRUMENTATION_ENABLED`.                                                                                                                                                                      | Same as `OTEL_DOTNET_AUTO_INSTRUMENTATION_ENABLED`         |
+| `OTEL_DOTNET_AUTO_METRICS_{0}_INSTRUMENTATION_ENABLED` | Configuration pattern for enabling or disabling a specific metric instrumentation, where `{0}` is the case-sensitive name of the instrumentation you want to enable. Overrides `OTEL_DOTNET_AUTO_METRICS_INSTRUMENTATION_ENABLED`.                              | Same as `OTEL_DOTNET_AUTO_METRICS_INSTRUMENTATION_ENABLED` |
+| `OTEL_DOTNET_AUTO_LOGS_INSTRUMENTATION_ENABLED`        | Enables all log instrumentations. Overrides `OTEL_DOTNET_AUTO_INSTRUMENTATION_ENABLED`.                                                                                                                                                                         | Same as `OTEL_DOTNET_AUTO_INSTRUMENTATION_ENABLED`         |
+| `OTEL_DOTNET_AUTO_LOGS_{0}_INSTRUMENTATION_ENABLED`    | Configuration pattern for enabling or disabling a specific log instrumentation, where `{0}` is the case-sensitive name of the instrumentation you want to enable. Overrides `OTEL_DOTNET_AUTO_LOGS_INSTRUMENTATION_ENABLED`.                                    | Same as `OTEL_DOTNET_AUTO_LOGS_INSTRUMENTATION_ENABLED`    |
 
 ### Traces instrumentations
 

@@ -180,6 +180,7 @@
     </Link>
   </ItemDefinitionGroup>
   <ItemGroup>
+    <ClInclude Include="bytecode_instrumentations.h" />
     <ClInclude Include="calltarget_tokens.h" />
     <ClInclude Include="class_factory.h" />
     <ClInclude Include="com_ptr.h" />
@@ -199,6 +200,7 @@
     <ClInclude Include="miniutf.hpp" />
     <ClInclude Include="miniutfdata.h" />
     <ClInclude Include="module_metadata.h" />
+    <ClInclude Include="netfx_assembly_redirection.h" />
     <ClInclude Include="otel_profiler_constants.h" />
     <ClInclude Include="pal.h" />
     <ClInclude Include="rejit_handler.h" />

@@ -0,0 +1,13 @@
+// Auto-generated file, do not change it - generated by the IntegrationsJsonGenerator
+#ifndef BYTECODE_INSTRUMENTATIONS_H
+#define BYTECODE_INSTRUMENTATIONS_H
+
+#include "string.h"
+
+namespace trace
+{
+inline std::unordered_map<WSTRING, WSTRING> trace_integration_names = {{WStr("StrongNamedValidation"), WStr("OTEL_DOTNET_AUTO_TRACES_StrongNamedValidation_INSTRUMENTATION_ENABLED")}, {WStr("StackExchangeRedis"), WStr("OTEL_DOTNET_AUTO_TRACES_StackExchangeRedis_INSTRUMENTATION_ENABLED")}, {WStr("NServiceBus"), WStr("OTEL_DOTNET_AUTO_TRACES_NServiceBus_INSTRUMENTATION_ENABLED")}, {WStr("MySqlData"), WStr("OTEL_DOTNET_AUTO_TRACES_MySqlData_INSTRUMENTATION_ENABLED")}, {WStr("MongoDB"), WStr("OTEL_DOTNET_AUTO_TRACES_MongoDB_INSTRUMENTATION_ENABLED")}, {WStr("GraphQL"), WStr("OTEL_DOTNET_AUTO_TRACES_GraphQL_INSTRUMENTATION_ENABLED")}};
+inline std::unordered_map<WSTRING, WSTRING> metric_integration_names = {{WStr("NServiceBus"), WStr("OTEL_DOTNET_AUTO_METRICS_NServiceBus_INSTRUMENTATION_ENABLED")}};
+inline std::unordered_map<WSTRING, WSTRING> log_integration_names = {{WStr("ILogger"), WStr("OTEL_DOTNET_AUTO_LOGS_ILogger_INSTRUMENTATION_ENABLED")}};
+}
+#endif
@@ -4,6 +4,7 @@
 #include <corprof.h>
 #include <string>
 
+#include "bytecode_instrumentations.h"
 #include "clr_helpers.h"
 #include "dllmain.h"
 #include "environment_variables.h"
@@ -163,19 +164,16 @@ HRESULT STDMETHODCALLTYPE CorProfiler::Initialize(IUnknown* cor_profiler_info_un
 
     rejit_handler = new RejitHandler(this->info_, callback);
 
-
+    const bool instrumentation_enabled_by_default = AreInstrumentationsEnabledByDefault();
 
     // load all integrations from JSON files
     const LoadIntegrationConfiguration configuration(
         AreTracesEnabled(), 
-        GetEnvironmentValues(environment::enabled_traces_integrations),
-        GetEnvironmentValues(environment::disabled_traces_integrations),
+        GetEnabledEnvironmentValues(AreTracesInstrumentationsEnabledByDefault(instrumentation_enabled_by_default), trace_integration_names),
         AreMetricsEnabled(), 
-        GetEnvironmentValues(environment::enabled_metrics_integrations),
-        GetEnvironmentValues(environment::disabled_metrics_integrations),
+        GetEnabledEnvironmentValues(AreMetricsInstrumentationsEnabledByDefault(instrumentation_enabled_by_default), metric_integration_names),
         AreLogsEnabled(),
-        GetEnvironmentValues(environment::enabled_logs_integrations),
-        GetEnvironmentValues(environment::disabled_logs_integrations));
+        GetEnabledEnvironmentValues(AreLogsInstrumentationsEnabledByDefault(instrumentation_enabled_by_default), log_integration_names));
     LoadIntegrationsFromEnvironment(integration_methods_, configuration);
 
     Logger::Debug("Number of Integrations loaded: ", integration_methods_.size());

@@ -24,60 +24,33 @@ const WSTRING profiler_home_path = WStr("OTEL_DOTNET_AUTO_HOME");
 // "MyApp.exe,dotnet.exe"
 const WSTRING exclude_process_names = WStr("OTEL_DOTNET_AUTO_EXCLUDE_PROCESSES");
 
+// Whether instrumentations are enabled. If not set (default), all instrumentations are enabled.
+const WSTRING instrumentation_enabled =
+    WStr("OTEL_DOTNET_AUTO_INSTRUMENTATION_ENABLED");
+
 // Whether traces are enabled or not. If not set (default), traces are enabled.
 const WSTRING traces_enabled =
     WStr("OTEL_DOTNET_AUTO_TRACES_ENABLED");
 
-// Sets a list of integrations to enable. If not set (default), all integrations are enabled.
-// Supports multiple values separated with comma, for example:
-// "ElasticsearchNet,AspNetWebApi2"
-const WSTRING enabled_traces_integrations =
-    WStr("OTEL_DOTNET_AUTO_TRACES_ENABLED_INSTRUMENTATIONS");
-
-// Sets a list of integrations to disable. Status of other integrations will remain
-// unchanged. Calculation order: OTEL_DOTNET_AUTO_TRACES_DISABLED_INSTRUMENTATIONS
-// then if instrumentation is not explicitly disabled OTEL_DOTNET_AUTO_TRACES_ENABLED_INSTRUMENTATIONS is checked.
-// Supports multiple values separated with comma, for example:
-// "ElasticsearchNet,AspNetWebApi2"
-const WSTRING disabled_traces_integrations =
-    WStr("OTEL_DOTNET_AUTO_TRACES_DISABLED_INSTRUMENTATIONS");
+// Whether traces instrumentations are enabled. If not set (default), value from OTEL_DOTNET_AUTO_INSTRUMENTATION_ENABLED is used.
+const WSTRING traces_instrumentation_enabled =
+    WStr("OTEL_DOTNET_AUTO_TRACES_INSTRUMENTATION_ENABLED");
 
 // Whether metrics are enabled or not. If not set (default), traces are enabled.
 const WSTRING metrics_enabled =
     WStr("OTEL_DOTNET_AUTO_METRICS_ENABLED");
 
-// Sets a list of integrations to enable. If not set (default), all integrations are enabled.
-// Supports multiple values separated with comma, for example:
-// "ElasticsearchNet,AspNetWebApi2"
-const WSTRING enabled_metrics_integrations =
-    WStr("OTEL_DOTNET_AUTO_METRICS_ENABLED_INSTRUMENTATIONS");
-
-// Sets a list of integrations to disable. Status of other integrations will remain
-// unchanged. Calculation order: OTEL_DOTNET_AUTO_METRICS_DISABLED_INSTRUMENTATIONS
-// then if instrumentation is not explicitly disabled OTEL_DOTNET_AUTO_METRICS_ENABLED_INSTRUMENTATIONS is checked.
-// Supports multiple values separated with comma, for example:
-// "ElasticsearchNet,AspNetWebApi2"
-const WSTRING disabled_metrics_integrations =
-    WStr("OTEL_DOTNET_AUTO_METRICS_DISABLED_INSTRUMENTATIONS");
+// Whether metrics instrumentations are enabled. If not set (default), value from OTEL_DOTNET_AUTO_INSTRUMENTATION_ENABLED is used.
+const WSTRING metrics_instrumentation_enabled =
+    WStr("OTEL_DOTNET_AUTO_METRICS_INSTRUMENTATION_ENABLED");
 
 // Whether logs are enabled or not. If not set (default), logs are enabled.
 const WSTRING logs_enabled =
     WStr("OTEL_DOTNET_AUTO_LOGS_ENABLED");
 
-// Sets a list of integrations to enable. If not set (default), all integrations
-// are enabled. Supports multiple values separated with comma, for example:
-// "ElasticsearchNet,AspNetWebApi2"
-const WSTRING enabled_logs_integrations =
-    WStr("OTEL_DOTNET_AUTO_LOGS_ENABLED_INSTRUMENTATIONS");
-
-// Sets a list of integrations to disable. Status of other integrations will
-// remain unchanged. Calculation order:
-// OTEL_DOTNET_AUTO_LOGS_DISABLED_INSTRUMENTATIONS then if instrumentation is
-// not explicitly disabled OTEL_DOTNET_AUTO_LOGS_ENABLED_INSTRUMENTATIONS is
-// checked. Supports multiple values separated with comma, for example:
-// "ElasticsearchNet,AspNetWebApi2"
-const WSTRING disabled_logs_integrations =
-    WStr("OTEL_DOTNET_AUTO_LOGS_DISABLED_INSTRUMENTATIONS");
+// Whether logs instrumentations are enabled. If not set (default), value from OTEL_DOTNET_AUTO_INSTRUMENTATION_ENABLED is used.
+const WSTRING logs_instrumentation_enabled =
+    WStr("OTEL_DOTNET_AUTO_LOGS_INSTRUMENTATION_ENABLED");
 
 // Sets the directory for the profiler's log file.
 // If not set, default is

@@ -78,6 +78,22 @@ bool IsNetFxAssemblyRedirectionEnabled() {
   ToBooleanWithDefault(GetEnvironmentValue(environment::netfx_assembly_redirection_enabled), true);
 }
 
+bool AreInstrumentationsEnabledByDefault() {
+  ToBooleanWithDefault(GetEnvironmentValue(environment::instrumentation_enabled), true);
+}
+
+bool AreTracesInstrumentationsEnabledByDefault(const bool enabled_if_not_configured) {
+  ToBooleanWithDefault(GetEnvironmentValue(environment::traces_instrumentation_enabled), enabled_if_not_configured);
+}
+
+bool AreMetricsInstrumentationsEnabledByDefault(const bool enabled_if_not_configured) {
+  ToBooleanWithDefault(GetEnvironmentValue(environment::metrics_instrumentation_enabled), enabled_if_not_configured);
+}
+
+bool AreLogsInstrumentationsEnabledByDefault(const bool enabled_if_not_configured) {
+  ToBooleanWithDefault(GetEnvironmentValue(environment::logs_instrumentation_enabled), enabled_if_not_configured);
+}
+
 }  // namespace trace
 
 #endif  // OTEL_CLR_PROFILER_ENVIRONMENT_VARIABLES_UTIL_H_
@@ -119,23 +119,8 @@ namespace
 {
     bool InstrumentationEnabled(
         const WSTRING name,
-        const std::vector<WSTRING>& enabledIntegrationNames,
-        const std::vector<WSTRING>& disabledIntegrationNames)
+        const std::vector<WSTRING>& enabledIntegrationNames)
     {
-        // check if the integration is disabled
-        for (const WSTRING& disabledName : disabledIntegrationNames)
-        {
-            if (name == disabledName) 
-            {
-                return false;
-            }
-        }
-
-        if (enabledIntegrationNames.empty())
-        {
-            return true;
-        }
-
         // check if the integration is enabled
         for (const WSTRING& enabledName : enabledIntegrationNames)
         {
@@ -178,7 +163,7 @@ namespace
                   return;
             }
 
-            if (!InstrumentationEnabled(name, configuration.enabledTraceIntegrationNames, configuration.disabledTraceIntegrationNames)) 
+            if (!InstrumentationEnabled(name, configuration.enabledTraceIntegrationNames)) 
             {
                 return;
             }
@@ -189,7 +174,7 @@ namespace
             {
                 return;
             }
-            if (!InstrumentationEnabled(name, configuration.enabledMetricIntegrationNames, configuration.disabledMetricIntegrationNames))
+            if (!InstrumentationEnabled(name, configuration.enabledMetricIntegrationNames))
             {
                 return;
             }
@@ -200,7 +185,7 @@ namespace
             {
                 return;
             }
-            if (!InstrumentationEnabled(name, configuration.enabledLogIntegrationNames, configuration.disabledLogIntegrationNames))
+            if (!InstrumentationEnabled(name, configuration.enabledLogIntegrationNames))
             {
                 return;
             }