Add fix for whitespace in exporter settings and metrics URL

andrewlock · andrewlock · commit 59d3f61df51c · 2025-10-31T17:46:09.000Z
This manifested in a different test where an empty string passed as the DogStatsD socket was causing us to use UDS even through it's not available and not _really_ set
diff --git a/tracer/src/Datadog.Trace.Tools.dd_dotnet/ExporterSettings.cs b/tracer/src/Datadog.Trace.Tools.dd_dotnet/ExporterSettings.cs
@@ -89,7 +89,7 @@ internal enum TelemetryErrorCode
     {
         foreach (var key in keys)
         {
-            var value = configuration?.GetString(key);
+            var value = configuration?.GetString(key)?.Trim();
 
             if (value != null)
             {
diff --git a/tracer/src/Datadog.Trace/Configuration/ExporterSettings.Shared.cs b/tracer/src/Datadog.Trace/Configuration/ExporterSettings.Shared.cs
@@ -46,15 +46,15 @@ private TraceTransportSettings GetTraceTransport(string? agentUri, string? trace
             // Check the parameters in order of precedence
             // For some cases, we allow falling back on another configuration (eg invalid url as the application will need to be restarted to fix it anyway).
             // For other cases (eg a configured unix domain socket path not found), we don't fallback as the problem could be fixed outside the application.
-            if (!string.IsNullOrWhiteSpace(agentUri))
+            if (!string.IsNullOrEmpty(agentUri))
             {
                 if (TryGetAgentUriAndTransport(agentUri!, origin, out var settings))
                 {
                     return settings;
                 }
             }
 
-            if (!string.IsNullOrWhiteSpace(tracesPipeName))
+            if (!string.IsNullOrEmpty(tracesPipeName))
             {
                 RecordTraceTransport(nameof(TracesTransportType.WindowsNamedPipe), origin);
 
@@ -73,7 +73,7 @@ private TraceTransportSettings GetTraceTransport(string? agentUri, string? trace
 
             // This property shouldn't have been introduced. We need to remove it as part of 3.0
             // But while it's here, we need to handle it properly
-            if (!string.IsNullOrWhiteSpace(tracesUnixDomainSocketPath))
+            if (!string.IsNullOrEmpty(tracesUnixDomainSocketPath))
             {
 #if NETCOREAPP3_1_OR_GREATER
                 if (TryGetAgentUriAndTransport(UnixDomainSocketPrefix + tracesUnixDomainSocketPath, origin, out var settings))
diff --git a/tracer/src/Datadog.Trace/Configuration/ExporterSettings.cs b/tracer/src/Datadog.Trace/Configuration/ExporterSettings.cs
@@ -234,7 +234,7 @@ private static string GetMetricsHostNameFromAgentUri(Uri agentUri)
 
         private MetricsTransportSettings ConfigureMetricsTransport(string? metricsUrl, string? traceAgentUrl, string? agentHost, int dogStatsdPort, string? metricsPipeName, string? metricsUnixDomainSocketPath)
         {
-            if (!string.IsNullOrWhiteSpace(metricsUrl) && TryGetMetricsUriAndTransport(metricsUrl!, out var settingsFromUri))
+            if (!string.IsNullOrEmpty(metricsUrl) && TryGetMetricsUriAndTransport(metricsUrl!, out var settingsFromUri))
             {
                 return settingsFromUri;
             }
@@ -252,7 +252,7 @@ private MetricsTransportSettings ConfigureMetricsTransport(string? metricsUrl, s
 
             MetricsTransportSettings settings;
 
-            if (!string.IsNullOrWhiteSpace(traceAgentUrl)
+            if (!string.IsNullOrEmpty(traceAgentUrl)
              && !traceAgentUrl!.StartsWith(UnixDomainSocketPrefix)
              && Uri.TryCreate(traceAgentUrl, UriKind.Absolute, out var tcpUri))
             {
@@ -273,11 +273,11 @@ private MetricsTransportSettings ConfigureMetricsTransport(string? metricsUrl, s
                     portSource: dogStatsDPortSource,
                     out settings);
             }
-            else if (!string.IsNullOrWhiteSpace(metricsPipeName))
+            else if (!string.IsNullOrEmpty(metricsPipeName))
             {
                 settings = new MetricsTransportSettings(TransportType.NamedPipe, PipeName: metricsPipeName);
             }
-            else if (metricsUnixDomainSocketPath != null)
+            else if (!string.IsNullOrEmpty(metricsUnixDomainSocketPath))
             {
 #if NETCOREAPP3_1_OR_GREATER
                 SetUds(metricsUnixDomainSocketPath, metricsUnixDomainSocketPath, metricsUnixDomainSocketPath, ConfigurationKeys.MetricsUnixDomainSocketPath, out settings);
@@ -447,22 +447,22 @@ public Raw(IConfigurationSource source, IConfigurationTelemetry telemetry)
                 // Get values from the config
                 var config = new ConfigurationBuilder(source, telemetry);
                 // NOTE: Keep this in sync with CreateUpdatedFromManualConfig below
-                TraceAgentUri = config.WithKeys(ConfigurationKeys.AgentUri).AsString();
-                TracesPipeName = config.WithKeys(ConfigurationKeys.TracesPipeName).AsString();
-                TracesUnixDomainSocketPath = config.WithKeys(ConfigurationKeys.TracesUnixDomainSocketPath).AsString();
+                TraceAgentUri = config.WithKeys(ConfigurationKeys.AgentUri).AsString()?.Trim();
+                TracesPipeName = config.WithKeys(ConfigurationKeys.TracesPipeName).AsString()?.Trim();
+                TracesUnixDomainSocketPath = config.WithKeys(ConfigurationKeys.TracesUnixDomainSocketPath).AsString()?.Trim();
 
                 TraceAgentHost = config
                                .WithKeys(ConfigurationKeys.AgentHost, "DD_TRACE_AGENT_HOSTNAME", "DATADOG_TRACE_AGENT_HOSTNAME")
-                               .AsString();
+                               .AsString()?.Trim();
 
                 TraceAgentPort = config
                                .WithKeys(ConfigurationKeys.AgentPort, "DATADOG_TRACE_AGENT_PORT")
                                .AsInt32();
 
-                MetricsUrl = config.WithKeys(ConfigurationKeys.MetricsUri).AsString();
+                MetricsUrl = config.WithKeys(ConfigurationKeys.MetricsUri).AsString()?.Trim();
                 DogStatsdPort = config.WithKeys(ConfigurationKeys.DogStatsdPort).AsInt32(0);
-                MetricsPipeName = config.WithKeys(ConfigurationKeys.MetricsPipeName).AsString();
-                MetricsUnixDomainSocketPath = config.WithKeys(ConfigurationKeys.MetricsUnixDomainSocketPath).AsString();
+                MetricsPipeName = config.WithKeys(ConfigurationKeys.MetricsPipeName).AsString()?.Trim();
+                MetricsUnixDomainSocketPath = config.WithKeys(ConfigurationKeys.MetricsUnixDomainSocketPath).AsString()?.Trim();
 
                 TracesPipeTimeoutMs = config
                                      .WithKeys(ConfigurationKeys.TracesPipeTimeoutMs)
diff --git a/tracer/test/Datadog.Trace.Tests/Configuration/ExporterSettingsTests.cs b/tracer/test/Datadog.Trace.Tests/Configuration/ExporterSettingsTests.cs
@@ -92,6 +92,43 @@ public void Metrics_DogStatsdUrl_UdsOnLinux()
             AssertMetricsUdsIsConfigured(settingsFromSource, socketPath);
             settingsFromSource.ValidationWarnings.Should().BeEmpty();
         }
+
+        [Theory]
+        [InlineData("""C:\Users\andrew.lock\AppData\Local\Temp\nltdjakv.cbs""")]
+        [InlineData("/some/socket.soc")]
+        public void Metrics_UdsTraceAgent_UsesDefaultUdp(string socket)
+        {
+            var config = Setup(FileExistsMock(socket.Replace('\\', '/')), $"DD_TRACE_AGENT_URL:{ExporterSettings.UnixDomainSocketPrefix}{socket}");
+            AssertUdsIsConfigured(config, socket.Replace('\\', '/'));
+            AssertMetricsUdpIsConfigured(config);
+            config.ValidationWarnings.Should().BeEmpty();
+        }
+
+        [Theory]
+        [InlineData(null)]
+        [InlineData("")]
+        [InlineData(" ")]
+        public void Metrics_UdsTraceAgent_EmptyDogStatsdUrl_UsesDefaultUdp(string metricsSocket)
+        {
+            var socket = "/some/socket.soc";
+            var config = Setup(FileExistsMock(socket.Replace('\\', '/')), $"DD_DOGSTATSD_URL:{metricsSocket}", $"DD_TRACE_AGENT_URL:{ExporterSettings.UnixDomainSocketPrefix}{socket}");
+            AssertUdsIsConfigured(config, socket);
+            AssertMetricsUdpIsConfigured(config);
+            config.ValidationWarnings.Should().BeEmpty();
+        }
+
+        [Theory]
+        [InlineData(null)]
+        [InlineData("")]
+        [InlineData(" ")]
+        public void Metrics_UdsTraceAgent_EmptyDogStatsdSocket_UsesDefaultUdp(string metricsSocket)
+        {
+            var socket = "/some/socket.soc";
+            var config = Setup(FileExistsMock(socket.Replace('\\', '/')), $"DD_DOGSTATSD_SOCKET:{metricsSocket}", $"DD_TRACE_AGENT_URL:{ExporterSettings.UnixDomainSocketPrefix}{socket}");
+            AssertUdsIsConfigured(config, socket);
+            AssertMetricsUdpIsConfigured(config);
+            config.ValidationWarnings.Should().BeEmpty();
+        }
 #else
         [Fact]
         public void Metrics_DogStatsdUrl_UdsUnsupported_UsesDefaultUdpOnWindows()
@@ -104,7 +141,7 @@ public void Metrics_DogStatsdUrl_UdsUnsupported_UsesDefaultUdpOnWindows()
         }
 
         [Fact]
-        public void Metrics_DogStatsdUrl_UdsUnsupported_UsesDefaultUdsOnLinux()
+        public void Metrics_DogStatsdUrl_UdsUnsupported_UsesDefaultUdpOnLinux()
         {
             var socketPath = @"/some/socket.soc";
             var settings = Setup(FileExistsMock(socketPath), $"DD_DOGSTATSD_URL:unix://{socketPath}", "DD_TRACE_AGENT_URL:http://localhost:8126");

Original file line number	Diff line number	Diff line change
`@@ -89,7 +89,7 @@ internal enum TelemetryErrorCode`
`89`	`89`	`{`
`90`	`90`	`foreach (var key in keys)`
`91`	`91`	`{`
`92`		`- var value = configuration?.GetString(key);`
	`92`	`+ var value = configuration?.GetString(key)?.Trim();`
`93`	`93`
`94`	`94`	`if (value != null)`
`95`	`95`	`{`
Original file line number	Diff line number	Diff line change
`@@ -46,15 +46,15 @@ private TraceTransportSettings GetTraceTransport(string? agentUri, string? trace`
`46`	`46`	`// Check the parameters in order of precedence`
`47`	`47`	`// For some cases, we allow falling back on another configuration (eg invalid url as the application will need to be restarted to fix it anyway).`
`48`	`48`	`// For other cases (eg a configured unix domain socket path not found), we don't fallback as the problem could be fixed outside the application.`
`49`		`- if (!string.IsNullOrWhiteSpace(agentUri))`
	`49`	`+ if (!string.IsNullOrEmpty(agentUri))`
`50`	`50`	`{`
`51`	`51`	`if (TryGetAgentUriAndTransport(agentUri!, origin, out var settings))`
`52`	`52`	`{`
`53`	`53`	`return settings;`
`54`	`54`	`}`
`55`	`55`	`}`
`56`	`56`
`57`		`- if (!string.IsNullOrWhiteSpace(tracesPipeName))`
	`57`	`+ if (!string.IsNullOrEmpty(tracesPipeName))`
`58`	`58`	`{`
`59`	`59`	`RecordTraceTransport(nameof(TracesTransportType.WindowsNamedPipe), origin);`
`60`	`60`
`@@ -73,7 +73,7 @@ private TraceTransportSettings GetTraceTransport(string? agentUri, string? trace`
`73`	`73`
`74`	`74`	`// This property shouldn't have been introduced. We need to remove it as part of 3.0`
`75`	`75`	`// But while it's here, we need to handle it properly`
`76`		`- if (!string.IsNullOrWhiteSpace(tracesUnixDomainSocketPath))`
	`76`	`+ if (!string.IsNullOrEmpty(tracesUnixDomainSocketPath))`
`77`	`77`	`{`
`78`	`78`	`#if NETCOREAPP3_1_OR_GREATER`
`79`	`79`	`if (TryGetAgentUriAndTransport(UnixDomainSocketPrefix + tracesUnixDomainSocketPath, origin, out var settings))`