Special case for IntegrationSettings.cs keys

anna-git · anna-git · commit 2824931b1830 · 2025-10-29T13:46:40.000-04:00
diff --git a/tracer/src/Datadog.Trace/Configuration/ConfigurationSources/GlobalConfigurationSource.cs b/tracer/src/Datadog.Trace/Configuration/ConfigurationSources/GlobalConfigurationSource.cs
@@ -106,7 +106,7 @@ internal static bool TryLoadJsonConfigurationFile(IConfigurationSource configura
 
             // if environment variable is not set, look for default file name in the current directory
             var configurationFileName = new ConfigurationBuilder(configurationSource, telemetry)
-                                       .WithKeys(ConfigurationKeys.ConfigurationFileName, "DD_DOTNET_TRACER_CONFIG_FILE")
+                                       .WithKeys(ConfigurationKeys.ConfigurationFileName)
                                        .AsString(
                                             getDefaultValue: () => Path.Combine(baseDirectory ?? GetCurrentDirectory(), "datadog.json"),
                                             validator: null);
diff --git a/tracer/src/Datadog.Trace/Configuration/ConfigurationSources/Telemetry/ConfigurationBuilder.cs b/tracer/src/Datadog.Trace/Configuration/ConfigurationSources/Telemetry/ConfigurationBuilder.cs
@@ -19,35 +19,46 @@ internal readonly struct ConfigurationBuilder(IConfigurationSource source, IConf
 
     public HasKeys WithKeys(string key) => new(_source, _telemetry, key);
 
-    public HasKeys WithKeys(string key, string fallbackKey) => new(_source, _telemetry, key, fallbackKey);
-
-    public HasKeys WithKeys(string key, string fallbackKey1, string fallbackKey2) => new(_source, _telemetry, key, fallbackKey1, fallbackKey2);
-
-    public HasKeys WithKeys(string key, string fallbackKey1, string fallbackKey2, string fallbackKey3) => new(_source, _telemetry, key, fallbackKey1, fallbackKey2, fallbackKey3);
-
-    internal readonly struct HasKeys
+    public HasKeys WithIntegrationKey(string integrationName) => new(
+        _source,
+        _telemetry,
+        string.Format(IntegrationSettings.IntegrationEnabledKey, integrationName.ToUpperInvariant()),
+        [
+            string.Format(IntegrationSettings.IntegrationEnabledKey, integrationName),
+            $"DD_{integrationName}_ENABLED"
+        ]);
+
+    public HasKeys WithIntegrationAnalyticsKey(string integrationName) => new(
+        _source,
+        _telemetry,
+#pragma warning disable 618 // App analytics is deprecated, but still used
+        string.Format(IntegrationSettings.AnalyticsEnabledKey, integrationName.ToUpperInvariant()),
+        [
+            string.Format(IntegrationSettings.AnalyticsEnabledKey, integrationName),
+#pragma warning restore 618
+            $"DD_{integrationName}_ANALYTICS_ENABLED"
+        ]);
+
+    public HasKeys WithIntegrationAnalyticsSampleRateKey(string integrationName) => new(
+        _source,
+        _telemetry,
+#pragma warning disable 618 // App analytics is deprecated, but still used
+        string.Format(IntegrationSettings.AnalyticsSampleRateKey, integrationName.ToUpperInvariant()),
+        [
+            string.Format(IntegrationSettings.AnalyticsSampleRateKey, integrationName),
+#pragma warning restore 618
+            $"DD_{integrationName}_ANALYTICS_SAMPLE_RATE"
+        ]);
+
+    internal readonly struct HasKeys(IConfigurationSource source, IConfigurationTelemetry telemetry, string key, string[]? providedAliases = null)
     {
-        public HasKeys(IConfigurationSource source, IConfigurationTelemetry telemetry, string key, string? fallbackKey1 = null, string? fallbackKey2 = null, string? fallbackKey3 = null)
-        {
-            Source = source;
-            Telemetry = telemetry;
-            Key = key;
-            FallbackKey1 = fallbackKey1;
-            FallbackKey2 = fallbackKey2;
-            FallbackKey3 = fallbackKey3;
-        }
-
-        private IConfigurationSource Source { get; }
-
-        private IConfigurationTelemetry Telemetry { get; }
-
-        private string Key { get; }
+        private readonly string[]? _providedAliases = providedAliases;
 
-        private string? FallbackKey1 { get; }
+        private IConfigurationSource Source { get; } = source;
 
-        private string? FallbackKey2 { get; }
+        private IConfigurationTelemetry Telemetry { get; } = telemetry;
 
-        private string? FallbackKey3 { get; }
+        private string Key { get; } = key;
 
         // ****************
         // String accessors
@@ -536,15 +547,13 @@ private ConfigurationResult<IDictionary<string, string>> GetDictionaryResult(Fun
         /// <returns>The raw <see cref="ConfigurationResult{T}"/></returns>
         private ConfigurationResult<T> GetResultWithFallback<T>(Func<string, ConfigurationResult<T>> selector)
         {
-            var hasAllKeys = _allKeys is not null;
-            var canonicalKey = hasAllKeys ? _allKeys![0] : Key;
-            var result = selector(canonicalKey);
+            var result = selector(Key);
             if (!result.ShouldFallBack)
             {
                 return result;
             }
 
-            string[] aliases = !hasAllKeys ? ConfigKeyAliasesSwitcher.GetAliases(Key) : [_allKeys![1], _allKeys[2]];
+            string[] aliases = _providedAliases ?? ConfigKeyAliasesSwitcher.GetAliases(Key);
 
             foreach (var alias in aliases)
             {
diff --git a/tracer/src/Datadog.Trace/Configuration/IntegrationSettings.cs b/tracer/src/Datadog.Trace/Configuration/IntegrationSettings.cs
@@ -6,6 +6,7 @@
 #nullable enable
 
 using System;
+using System.Collections.Generic;
 using Datadog.Trace.Configuration.Telemetry;
 
 namespace Datadog.Trace.Configuration
@@ -18,7 +19,7 @@ public class IntegrationSettings : IEquatable<IntegrationSettings>
         /// <summary>
         /// Configuration key pattern for enabling or disabling an integration.
         /// </summary>
-        public const string IntegrationEnabled = "DD_TRACE_{0}_ENABLED";
+        public const string IntegrationEnabledKey = "DD_TRACE_{0}_ENABLED";
 
         /// <summary>
         /// Configuration key pattern for enabling or disabling Analytics in an integration.
@@ -50,31 +51,19 @@ internal IntegrationSettings(string integrationName, IConfigurationSource? sourc
 
             // We don't record these in telemetry, because they're blocked anyway
             var config = new ConfigurationBuilder(source ?? NullConfigurationSource.Instance, NullConfigurationTelemetry.Instance);
-            var upperName = integrationName.ToUpperInvariant();
             Enabled = isExplicitlyDisabled
                           ? false
                           : config
-                           .WithKeys(
-                                string.Format(IntegrationEnabled, upperName),
-                                string.Format(IntegrationEnabled, integrationName),
-                                $"DD_{integrationName}_ENABLED")
-                           .AsBool()
-                         ?? fallback?.Enabled;
+                           .WithIntegrationKey(integrationName)
+                           .AsBool() ?? fallback?.Enabled;
 
 #pragma warning disable 618 // App analytics is deprecated, but still used
             AnalyticsEnabled = config
-                              .WithKeys(
-                                   string.Format(AnalyticsEnabledKey, upperName),
-                                   string.Format(AnalyticsEnabledKey, integrationName),
-                                   $"DD_{integrationName}_ANALYTICS_ENABLED")
-                              .AsBool()
-                            ?? fallback?.AnalyticsEnabled;
+                              .WithIntegrationAnalyticsKey(integrationName)
+                              .AsBool() ?? fallback?.AnalyticsEnabled;
 
             AnalyticsSampleRate = config
-                                 .WithKeys(
-                                      string.Format(AnalyticsSampleRateKey, upperName),
-                                      string.Format(AnalyticsSampleRateKey, integrationName),
-                                      $"DD_{integrationName}_ANALYTICS_SAMPLE_RATE")
+                                 .WithIntegrationAnalyticsSampleRateKey(integrationName)
                                  .AsDouble(fallback?.AnalyticsSampleRate ?? 1.0);
 #pragma warning restore 618
         }
diff --git a/tracer/src/Datadog.Trace/Configuration/TracerSettings.cs b/tracer/src/Datadog.Trace/Configuration/TracerSettings.cs
@@ -132,7 +132,7 @@ internal TracerSettings(IConfigurationSource? source, IConfigurationTelemetry te
                                                                ? ParsingResult<bool>.Success(result: false)
                                                                : ParsingResult<bool>.Failure());
             IsActivityListenerEnabled = config
-                                       .WithKeys(ConfigurationKeys.FeatureFlags.OpenTelemetryEnabled, "DD_TRACE_ACTIVITY_LISTENER_ENABLED")
+                                       .WithKeys(ConfigurationKeys.FeatureFlags.OpenTelemetryEnabled)
                                        .AsBoolResult()
                                        .OverrideWith(in otelActivityListenerEnabled, ErrorLog, defaultValue: false);
 
@@ -219,7 +219,7 @@ not null when string.Equals(x, "http/protobuf", StringComparison.OrdinalIgnoreCa
                                     validator: null);
 
             OtlpMetricsProtocol = config
-                                 .WithKeys(ConfigurationKeys.OpenTelemetry.ExporterOtlpMetricsProtocol, ConfigurationKeys.OpenTelemetry.ExporterOtlpProtocol)
+                                 .WithKeys(ConfigurationKeys.OpenTelemetry.ExporterOtlpMetricsProtocol)
                                  .GetAs(
                                       defaultValue: new(OtlpProtocol.Grpc, "grpc"),
                                       converter: x => x switch
@@ -254,14 +254,14 @@ not null when string.Equals(x, "http/json", StringComparison.OrdinalIgnoreCase)
                     converter: uriString => new Uri(uriString));
 
             OtlpMetricsHeaders = config
-                            .WithKeys(ConfigurationKeys.OpenTelemetry.ExporterOtlpMetricsHeaders, ConfigurationKeys.OpenTelemetry.ExporterOtlpHeaders)
+                            .WithKeys(ConfigurationKeys.OpenTelemetry.ExporterOtlpMetricsHeaders)
                             .AsDictionaryResult(separator: '=')
                             .WithDefault(new DefaultResult<IDictionary<string, string>>(new Dictionary<string, string>(), "[]"))
                             .Where(kvp => !string.IsNullOrWhiteSpace(kvp.Key))
                             .ToDictionary(kvp => kvp.Key.Trim(), kvp => kvp.Value?.Trim() ?? string.Empty);
 
             OtlpMetricsTimeoutMs = config
-                            .WithKeys(ConfigurationKeys.OpenTelemetry.ExporterOtlpMetricsTimeoutMs, ConfigurationKeys.OpenTelemetry.ExporterOtlpTimeoutMs)
+                            .WithKeys(ConfigurationKeys.OpenTelemetry.ExporterOtlpMetricsTimeoutMs)
                             .AsInt32(defaultValue: 10_000);
 
             OtlpMetricsTemporalityPreference = config
@@ -514,14 +514,14 @@ not null when string.Equals(value, "otlp", StringComparison.OrdinalIgnoreCase) =
                                  converter: otelConverter);
 
             PropagationStyleInject = config
-                                    .WithKeys(ConfigurationKeys.PropagationStyleInject, "DD_PROPAGATION_STYLE_INJECT", ConfigurationKeys.PropagationStyle)
-                                    .GetAsClassResult(
-                                         validator: injectionValidator, // invalid individual values are rejected later
-                                         converter: style => TrimSplitString(style, commaSeparator))
-                                    .OverrideWith(in otelPropagation, ErrorLog, getDefaultPropagationHeaders);
+               .WithKeys(ConfigurationKeys.PropagationStyleInject)
+               .GetAsClassResult(
+                    validator: injectionValidator, // invalid individual values are rejected later
+                    converter: style => TrimSplitString(style, commaSeparator))
+               .OverrideWith(in otelPropagation, ErrorLog, getDefaultPropagationHeaders);
 
             PropagationStyleExtract = config
-                                     .WithKeys(ConfigurationKeys.PropagationStyleExtract, "DD_PROPAGATION_STYLE_EXTRACT", ConfigurationKeys.PropagationStyle)
+                                     .WithKeys(ConfigurationKeys.PropagationStyleExtract)
                                      .GetAsClassResult(
                                           validator: injectionValidator, // invalid individual values are rejected later
                                           converter: style => TrimSplitString(style, commaSeparator))
@@ -572,7 +572,7 @@ not null when string.Equals(value, "otlp", StringComparison.OrdinalIgnoreCase) =
                                                    .Value;
 
             IpHeader = config
-                      .WithKeys(ConfigurationKeys.IpHeader, ConfigurationKeys.AppSec.CustomIpHeader)
+                      .WithKeys(ConfigurationKeys.IpHeader)
                       .AsString();
 
             IpHeaderEnabled = config
diff --git a/tracer/test/Datadog.Trace.ClrProfiler.Managed.Tests/DbScopeFactoryTests.cs b/tracer/test/Datadog.Trace.ClrProfiler.Managed.Tests/DbScopeFactoryTests.cs
@@ -102,8 +102,8 @@ public async Task CreateDbCommandScope_ReturnNullForAdoNetDisabledIntegration(Ty
 
             var tracerSettings = TracerSettings.Create(new()
             {
-                { string.Format(IntegrationSettings.IntegrationEnabled, integrationName), "true" },
-                { string.Format(IntegrationSettings.IntegrationEnabled, nameof(IntegrationId.AdoNet)), "false" },
+                { string.Format(IntegrationSettings.IntegrationEnabledKey, integrationName), "true" },
+                { string.Format(IntegrationSettings.IntegrationEnabledKey, nameof(IntegrationId.AdoNet)), "false" },
             });
             await using var tracer = TracerHelper.CreateWithFakeAgent(tracerSettings);
 
@@ -750,7 +750,7 @@ private static ScopedTracer CreateTracerWithIntegrationEnabled(string integratio
             // Set up tracer
             var tracerSettings = TracerSettings.Create(new()
             {
-                { string.Format(IntegrationSettings.IntegrationEnabled, integrationName), enabled },
+                { string.Format(IntegrationSettings.IntegrationEnabledKey, integrationName), enabled },
             });
             return TracerHelper.Create(tracerSettings);
         }
diff --git a/tracer/test/Datadog.Trace.Tests/Configuration/IntegrationSettingsTests.cs b/tracer/test/Datadog.Trace.Tests/Configuration/IntegrationSettingsTests.cs
@@ -90,7 +90,7 @@ public void SettingsRespectsOverride(bool initiallyEnabled)
             var name = nameof(IntegrationId.Kafka);
             var source = new NameValueConfigurationSource(new()
             {
-                { string.Format(IntegrationSettings.IntegrationEnabled, name), initiallyEnabled.ToString() },
+                { string.Format(IntegrationSettings.IntegrationEnabledKey, name), initiallyEnabled.ToString() },
             });
 
             var settings = new IntegrationSettings(name, source: source, isExplicitlyDisabled: true);
@@ -105,7 +105,7 @@ public void SettingsRespectsOriginalIfNotOverridden(bool initiallyEnabled)
             var name = nameof(IntegrationId.Kafka);
             var source = new NameValueConfigurationSource(new()
             {
-                { string.Format(IntegrationSettings.IntegrationEnabled, name), initiallyEnabled.ToString() },
+                { string.Format(IntegrationSettings.IntegrationEnabledKey, name), initiallyEnabled.ToString() },
             });
 
             var settings = new IntegrationSettings(name, source: source, isExplicitlyDisabled: false);
diff --git a/tracer/test/Datadog.Trace.Tests/ManualInstrumentation/ManualInstrumentationLegacyConfigurationSourceTests.cs b/tracer/test/Datadog.Trace.Tests/ManualInstrumentation/ManualInstrumentationLegacyConfigurationSourceTests.cs
@@ -31,7 +31,7 @@ public void GetIntegrationEnabled_SupportedValues_ReturnsExpectedValues(int id)
     {
         var integrationId = (IntegrationId)id;
         var name = IntegrationRegistry.GetName(integrationId).ToUpperInvariant();
-        var enabledKey = string.Format(IntegrationSettings.IntegrationEnabled, name);
+        var enabledKey = string.Format(IntegrationSettings.IntegrationEnabledKey, name);
 
         var actual = ManualInstrumentationLegacyConfigurationSource.GetIntegrationEnabled(enabledKey);
 
@@ -57,7 +57,7 @@ public void GetIntegrationEnabled_ForUnsupportedValues_ReturnsNull(int id)
     {
         var integrationId = (IntegrationId)id;
         var name = IntegrationRegistry.GetName(integrationId).ToUpperInvariant();
-        var enabledKey = string.Format(IntegrationSettings.IntegrationEnabled, name);
+        var enabledKey = string.Format(IntegrationSettings.IntegrationEnabledKey, name);
 
         var actual = ManualInstrumentationLegacyConfigurationSource.GetIntegrationEnabled(enabledKey);
 
diff --git a/tracer/test/Datadog.Trace.Tests/ManualInstrumentation/SettingsInstrumentationTests.cs b/tracer/test/Datadog.Trace.Tests/ManualInstrumentation/SettingsInstrumentationTests.cs
@@ -341,7 +341,7 @@ private static TracerSettings GetAndAssertAutomaticTracerSettings()
             { ConfigurationKeys.TraceEnabled, false },
             { ConfigurationKeys.TracerMetricsEnabled, true },
             { ConfigurationKeys.AgentUri, "http://localhost:1234" },
-            { string.Format(IntegrationSettings.IntegrationEnabled, nameof(IntegrationId.Aerospike)), "false" },
+            { string.Format(IntegrationSettings.IntegrationEnabledKey, nameof(IntegrationId.Aerospike)), "false" },
             { string.Format(IntegrationSettings.AnalyticsEnabledKey, nameof(IntegrationId.Grpc)), "true" },
             { string.Format(IntegrationSettings.AnalyticsSampleRateKey, nameof(IntegrationId.Couchbase)), 0.5 },
         });

Original file line number	Diff line number	Diff line change
`@@ -102,8 +102,8 @@ public async Task CreateDbCommandScope_ReturnNullForAdoNetDisabledIntegration(Ty`
`102`	`102`
`103`	`103`	`var tracerSettings = TracerSettings.Create(new()`
`104`	`104`	`{`
`105`		`- { string.Format(IntegrationSettings.IntegrationEnabled, integrationName), "true" },`
`106`		`- { string.Format(IntegrationSettings.IntegrationEnabled, nameof(IntegrationId.AdoNet)), "false" },`
	`105`	`+ { string.Format(IntegrationSettings.IntegrationEnabledKey, integrationName), "true" },`
	`106`	`+ { string.Format(IntegrationSettings.IntegrationEnabledKey, nameof(IntegrationId.AdoNet)), "false" },`
`107`	`107`	`});`
`108`	`108`	`await using var tracer = TracerHelper.CreateWithFakeAgent(tracerSettings);`
`109`	`109`
`@@ -750,7 +750,7 @@ private static ScopedTracer CreateTracerWithIntegrationEnabled(string integratio`
`750`	`750`	`// Set up tracer`
`751`	`751`	`var tracerSettings = TracerSettings.Create(new()`
`752`	`752`	`{`
`753`		`- { string.Format(IntegrationSettings.IntegrationEnabled, integrationName), enabled },`
	`753`	`+ { string.Format(IntegrationSettings.IntegrationEnabledKey, integrationName), enabled },`
`754`	`754`	`});`
`755`	`755`	`return TracerHelper.Create(tracerSettings);`
`756`	`756`	`}`
Original file line number	Diff line number	Diff line change
`@@ -31,7 +31,7 @@ public void GetIntegrationEnabled_SupportedValues_ReturnsExpectedValues(int id)`
`31`	`31`	`{`
`32`	`32`	`var integrationId = (IntegrationId)id;`
`33`	`33`	`var name = IntegrationRegistry.GetName(integrationId).ToUpperInvariant();`
`34`		`- var enabledKey = string.Format(IntegrationSettings.IntegrationEnabled, name);`
	`34`	`+ var enabledKey = string.Format(IntegrationSettings.IntegrationEnabledKey, name);`
`35`	`35`
`36`	`36`	`var actual = ManualInstrumentationLegacyConfigurationSource.GetIntegrationEnabled(enabledKey);`
`37`	`37`
`@@ -57,7 +57,7 @@ public void GetIntegrationEnabled_ForUnsupportedValues_ReturnsNull(int id)`
`57`	`57`	`{`
`58`	`58`	`var integrationId = (IntegrationId)id;`
`59`	`59`	`var name = IntegrationRegistry.GetName(integrationId).ToUpperInvariant();`
`60`		`- var enabledKey = string.Format(IntegrationSettings.IntegrationEnabled, name);`
	`60`	`+ var enabledKey = string.Format(IntegrationSettings.IntegrationEnabledKey, name);`
`61`	`61`
`62`	`62`	`var actual = ManualInstrumentationLegacyConfigurationSource.GetIntegrationEnabled(enabledKey);`
`63`	`63`