fix: change Environment Var parsing to not throw FormatException (par…

…t1) (#4095)
open-telemetry · Jan 21, 2023 · 9e00b8f · 9e00b8f
1 parent 10389e3
commit 9e00b8f
Show file tree

Hide file tree

Showing 7 changed files with 22 additions and 9 deletions.
diff --git a/src/OpenTelemetry.Exporter.Zipkin/CHANGELOG.md b/src/OpenTelemetry.Exporter.Zipkin/CHANGELOG.md
@@ -2,6 +2,10 @@
 
 ## Unreleased
 
+* Changed EnvironmentVariable parsing to not throw a `FormatException` and
+  instead log a warning.
+  ([#4095](https://github.com/open-telemetry/opentelemetry-dotnet/pull/4095))
+
 ## 1.4.0-rc.2
 
 Released 2023-Jan-09

diff --git a/src/OpenTelemetry/Internal/ConfigurationExtensions.cs b/src/OpenTelemetry/Internal/ConfigurationExtensions.cs
@@ -66,7 +66,8 @@ public static bool TryGetUriValue(
 
         if (!Uri.TryCreate(stringValue, UriKind.Absolute, out value))
         {
-            throw new FormatException($"{key} environment variable has an invalid value: '{stringValue}'");
+            OpenTelemetrySdkEventSource.Log.InvalidEnvironmentVariable(key, stringValue);
+            return false;
         }
 
         return true;
@@ -85,7 +86,8 @@ public static bool TryGetIntValue(
 
         if (!int.TryParse(stringValue, NumberStyles.None, CultureInfo.InvariantCulture, out value))
         {
-            throw new FormatException($"{key} environment variable has an invalid value: '{stringValue}'");
+            OpenTelemetrySdkEventSource.Log.InvalidEnvironmentVariable(key, stringValue);
+            return false;
         }
 
         return true;
@@ -108,7 +110,8 @@ public static bool TryGetValue<T>(
 
         if (!tryParseFunc(stringValue!, out value))
         {
-            throw new FormatException($"{key} environment variable has an invalid value: '{stringValue}'");
+            OpenTelemetrySdkEventSource.Log.InvalidEnvironmentVariable(key, stringValue);
+            return false;
         }
 
         return true;

diff --git a/src/OpenTelemetry/Internal/OpenTelemetrySdkEventSource.cs b/src/OpenTelemetry/Internal/OpenTelemetrySdkEventSource.cs
@@ -409,6 +409,12 @@ public void TracerProviderSdkEvent(string message)
             this.WriteEvent(46, message);
         }
 
+        [Event(47, Message = "{0} environment variable has an invalid value: '{1}'", Level = EventLevel.Warning)]
+        public void InvalidEnvironmentVariable(string key, string value)
+        {
+            this.WriteEvent(47, key, value);
+        }
+
 #if DEBUG
         public class OpenTelemetryEventListener : EventListener
         {

diff --git a/test/OpenTelemetry.Exporter.Jaeger.Tests/JaegerExporterOptionsTests.cs b/test/OpenTelemetry.Exporter.Jaeger.Tests/JaegerExporterOptionsTests.cs
@@ -64,7 +64,7 @@ public void JaegerExporterOptions_EnvironmentVariableOverride()
             Assert.Equal(new Uri("http://custom-endpoint:12345"), options.Endpoint);
         }
 
-        [Theory]
+        [Theory(Skip = "https://github.com/open-telemetry/opentelemetry-dotnet/issues/3690")]
         [InlineData(JaegerExporterOptions.OTelAgentPortEnvVarKey)]
         [InlineData(JaegerExporterOptions.OTelProtocolEnvVarKey)]
         public void JaegerExporterOptions_InvalidEnvironmentVariableOverride(string envVar)

diff --git a/test/OpenTelemetry.Exporter.OpenTelemetryProtocol.Tests/OtlpExporterOptionsTests.cs b/test/OpenTelemetry.Exporter.OpenTelemetryProtocol.Tests/OtlpExporterOptionsTests.cs
@@ -95,23 +95,23 @@ public void OtlpExporterOptions_UsingIConfiguration()
             Assert.Equal(OtlpExportProtocol.HttpProtobuf, options.Protocol);
         }
 
-        [Fact]
+        [Fact(Skip = "https://github.com/open-telemetry/opentelemetry-dotnet/issues/3690")]
         public void OtlpExporterOptions_InvalidEndpointVariableOverride()
         {
             Environment.SetEnvironmentVariable(OtlpExporterOptions.EndpointEnvVarName, "invalid");
 
             Assert.Throws<FormatException>(() => new OtlpExporterOptions());
         }
 
-        [Fact]
+        [Fact(Skip = "https://github.com/open-telemetry/opentelemetry-dotnet/issues/3690")]
         public void OtlpExporterOptions_InvalidTimeoutVariableOverride()
         {
             Environment.SetEnvironmentVariable(OtlpExporterOptions.TimeoutEnvVarName, "invalid");
 
             Assert.Throws<FormatException>(() => new OtlpExporterOptions());
         }
 
-        [Fact]
+        [Fact(Skip = "https://github.com/open-telemetry/opentelemetry-dotnet/issues/3690")]
         public void OtlpExporterOptions_InvalidProtocolVariableOverride()
         {
             Environment.SetEnvironmentVariable(OtlpExporterOptions.ProtocolEnvVarName, "invalid");

diff --git a/test/OpenTelemetry.Exporter.Zipkin.Tests/ZipkinExporterTests.cs b/test/OpenTelemetry.Exporter.Zipkin.Tests/ZipkinExporterTests.cs
@@ -189,7 +189,7 @@ public void IncodeEndpointConfigTakesPrecedenceOverEnvironmentVariable()
             }
         }
 
-        [Fact]
+        [Fact(Skip = "https://github.com/open-telemetry/opentelemetry-dotnet/issues/3690")]
         public void ErrorGettingUriFromEnvVarSetsDefaultEndpointValue()
         {
             try

diff --git a/test/OpenTelemetry.Tests/Trace/BatchExportActivityProcessorOptionsTest.cs b/test/OpenTelemetry.Tests/Trace/BatchExportActivityProcessorOptionsTest.cs
@@ -82,7 +82,7 @@ public void BatchExportProcessorOptions_UsingIConfiguration()
             Assert.Equal(4, options.ScheduledDelayMilliseconds);
         }
 
-        [Fact]
+        [Fact(Skip = "https://github.com/open-telemetry/opentelemetry-dotnet/issues/3690")]
         public void BatchExportProcessorOptions_InvalidPortEnvironmentVariableOverride()
         {
             Environment.SetEnvironmentVariable(BatchExportActivityProcessorOptions.ExporterTimeoutEnvVarKey, "invalid");
-Original file line number
+Diff line change
@@ Expand Up @@
                 }
             }
-            [Fact]
+            [Fact(Skip = "https://github.com/open-telemetry/opentelemetry-dotnet/issues/3690")]
             public void ErrorGettingUriFromEnvVarSetsDefaultEndpointValue()
             {
                 try
@@ Expand Down @@