[otlp] Move spec envvar key definitions to a single spot (#5428)

CodeBlanch · web-flow · commit 9adb088e0653 · 2024-03-08T12:01:18.000-08:00
diff --git a/src/OpenTelemetry.Exporter.OpenTelemetryProtocol/Implementation/OtlpExporterSpecEnvVarKeyDefinitions.cs b/src/OpenTelemetry.Exporter.OpenTelemetryProtocol/Implementation/OtlpExporterSpecEnvVarKeyDefinitions.cs
@@ -0,0 +1,20 @@
+// Copyright The OpenTelemetry Authors
+// SPDX-License-Identifier: Apache-2.0
+
+namespace OpenTelemetry.Exporter;
+
+/// <summary>
+/// Contains spec environment variable key definitions for OpenTelemetry Protocol (OTLP) exporter.
+/// </summary>
+/// <remarks>
+/// Specification: <see href="https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/protocol/exporter.md"/>.
+/// </remarks>
+internal static class OtlpExporterSpecEnvVarKeyDefinitions
+{
+    public const string DefaultEndpointEnvVarName = "OTEL_EXPORTER_OTLP_ENDPOINT";
+    public const string DefaultHeadersEnvVarName = "OTEL_EXPORTER_OTLP_HEADERS";
+    public const string DefaultTimeoutEnvVarName = "OTEL_EXPORTER_OTLP_TIMEOUT";
+    public const string DefaultProtocolEnvVarName = "OTEL_EXPORTER_OTLP_PROTOCOL";
+
+    public const string MetricsTemporalityPreferenceEnvVarName = "OTEL_EXPORTER_OTLP_METRICS_TEMPORALITY_PREFERENCE";
+}
diff --git a/src/OpenTelemetry.Exporter.OpenTelemetryProtocol/OtlpExporterOptions.cs b/src/OpenTelemetry.Exporter.OpenTelemetryProtocol/OtlpExporterOptions.cs
@@ -22,11 +22,6 @@ namespace OpenTelemetry.Exporter;
 /// </summary>
 public class OtlpExporterOptions
 {
-    internal const string EndpointEnvVarName = "OTEL_EXPORTER_OTLP_ENDPOINT";
-    internal const string HeadersEnvVarName = "OTEL_EXPORTER_OTLP_HEADERS";
-    internal const string TimeoutEnvVarName = "OTEL_EXPORTER_OTLP_TIMEOUT";
-    internal const string ProtocolEnvVarName = "OTEL_EXPORTER_OTLP_PROTOCOL";
-
     internal static readonly KeyValuePair<string, string>[] StandardHeaders = new KeyValuePair<string, string>[]
     {
         new KeyValuePair<string, string>("User-Agent", GetUserAgentString()),
@@ -56,23 +51,23 @@ internal OtlpExporterOptions(
         Debug.Assert(configuration != null, "configuration was null");
         Debug.Assert(defaultBatchOptions != null, "defaultBatchOptions was null");
 
-        if (configuration.TryGetUriValue(EndpointEnvVarName, out var endpoint))
+        if (configuration.TryGetUriValue(OtlpExporterSpecEnvVarKeyDefinitions.DefaultEndpointEnvVarName, out var endpoint))
         {
             this.endpoint = endpoint;
         }
 
-        if (configuration.TryGetStringValue(HeadersEnvVarName, out var headers))
+        if (configuration.TryGetStringValue(OtlpExporterSpecEnvVarKeyDefinitions.DefaultHeadersEnvVarName, out var headers))
         {
             this.Headers = headers;
         }
 
-        if (configuration.TryGetIntValue(TimeoutEnvVarName, out var timeout))
+        if (configuration.TryGetIntValue(OtlpExporterSpecEnvVarKeyDefinitions.DefaultTimeoutEnvVarName, out var timeout))
         {
             this.TimeoutMilliseconds = timeout;
         }
 
         if (configuration.TryGetValue<OtlpExportProtocol>(
-            ProtocolEnvVarName,
+            OtlpExporterSpecEnvVarKeyDefinitions.DefaultProtocolEnvVarName,
             OtlpExportProtocolParser.TryParse,
             out var protocol))
         {
diff --git a/src/OpenTelemetry.Exporter.OpenTelemetryProtocol/OtlpMetricExporterExtensions.cs b/src/OpenTelemetry.Exporter.OpenTelemetryProtocol/OtlpMetricExporterExtensions.cs
@@ -16,8 +16,6 @@ namespace OpenTelemetry.Metrics;
 /// </summary>
 public static class OtlpMetricExporterExtensions
 {
-    internal const string OtlpMetricExporterTemporalityPreferenceEnvVarKey = "OTEL_EXPORTER_OTLP_METRICS_TEMPORALITY_PREFERENCE";
-
     /// <summary>
     /// Adds <see cref="OtlpMetricExporter"/> to the <see cref="MeterProviderBuilder"/> using default options.
     /// </summary>
@@ -65,7 +63,7 @@ public static MeterProviderBuilder AddOtlpExporter(
             services.AddOptions<MetricReaderOptions>(finalOptionsName).Configure<IConfiguration>(
                 (readerOptions, config) =>
                 {
-                    var otlpTemporalityPreference = config[OtlpMetricExporterTemporalityPreferenceEnvVarKey];
+                    var otlpTemporalityPreference = config[OtlpExporterSpecEnvVarKeyDefinitions.MetricsTemporalityPreferenceEnvVarName];
                     if (!string.IsNullOrWhiteSpace(otlpTemporalityPreference)
                         && Enum.TryParse<MetricReaderTemporalityPreference>(otlpTemporalityPreference, ignoreCase: true, out var enumValue))
                     {
@@ -142,7 +140,7 @@ public static MeterProviderBuilder AddOtlpExporter(
             services.AddOptions<MetricReaderOptions>(finalOptionsName).Configure<IConfiguration>(
                 (readerOptions, config) =>
                 {
-                    var otlpTemporalityPreference = config[OtlpMetricExporterTemporalityPreferenceEnvVarKey];
+                    var otlpTemporalityPreference = config[OtlpExporterSpecEnvVarKeyDefinitions.MetricsTemporalityPreferenceEnvVarName];
                     if (!string.IsNullOrWhiteSpace(otlpTemporalityPreference)
                         && Enum.TryParse<MetricReaderTemporalityPreference>(otlpTemporalityPreference, ignoreCase: true, out var enumValue))
                     {
diff --git a/test/OpenTelemetry.Exporter.OpenTelemetryProtocol.Tests/BaseOtlpHttpExportClientTests.cs b/test/OpenTelemetry.Exporter.OpenTelemetryProtocol.Tests/BaseOtlpHttpExportClientTests.cs
@@ -21,7 +21,7 @@ public void ValidateOtlpHttpExportClientEndpoint(string optionEndpoint, string e
     {
         try
         {
-            Environment.SetEnvironmentVariable(OtlpExporterOptions.EndpointEnvVarName, endpointEnvVar);
+            Environment.SetEnvironmentVariable(OtlpExporterSpecEnvVarKeyDefinitions.DefaultEndpointEnvVarName, endpointEnvVar);
 
             OtlpExporterOptions options = new() { Protocol = OtlpExportProtocol.HttpProtobuf };
 
@@ -35,7 +35,7 @@ public void ValidateOtlpHttpExportClientEndpoint(string optionEndpoint, string e
         }
         finally
         {
-            Environment.SetEnvironmentVariable(OtlpExporterOptions.EndpointEnvVarName, null);
+            Environment.SetEnvironmentVariable(OtlpExporterSpecEnvVarKeyDefinitions.DefaultEndpointEnvVarName, null);
         }
     }
 
diff --git a/test/OpenTelemetry.Exporter.OpenTelemetryProtocol.Tests/OtlpExporterOptionsTests.cs b/test/OpenTelemetry.Exporter.OpenTelemetryProtocol.Tests/OtlpExporterOptionsTests.cs
@@ -46,10 +46,10 @@ public void OtlpExporterOptions_DefaultsForHttpProtobuf()
     [Fact]
     public void OtlpExporterOptions_EnvironmentVariableOverride()
     {
-        Environment.SetEnvironmentVariable(OtlpExporterOptions.EndpointEnvVarName, "http://test:8888");
-        Environment.SetEnvironmentVariable(OtlpExporterOptions.HeadersEnvVarName, "A=2,B=3");
-        Environment.SetEnvironmentVariable(OtlpExporterOptions.TimeoutEnvVarName, "2000");
-        Environment.SetEnvironmentVariable(OtlpExporterOptions.ProtocolEnvVarName, "http/protobuf");
+        Environment.SetEnvironmentVariable(OtlpExporterSpecEnvVarKeyDefinitions.DefaultEndpointEnvVarName, "http://test:8888");
+        Environment.SetEnvironmentVariable(OtlpExporterSpecEnvVarKeyDefinitions.DefaultHeadersEnvVarName, "A=2,B=3");
+        Environment.SetEnvironmentVariable(OtlpExporterSpecEnvVarKeyDefinitions.DefaultTimeoutEnvVarName, "2000");
+        Environment.SetEnvironmentVariable(OtlpExporterSpecEnvVarKeyDefinitions.DefaultProtocolEnvVarName, "http/protobuf");
 
         var options = new OtlpExporterOptions();
 
@@ -64,10 +64,10 @@ public void OtlpExporterOptions_UsingIConfiguration()
     {
         var values = new Dictionary<string, string>()
         {
-            [OtlpExporterOptions.EndpointEnvVarName] = "http://test:8888",
-            [OtlpExporterOptions.HeadersEnvVarName] = "A=2,B=3",
-            [OtlpExporterOptions.TimeoutEnvVarName] = "2000",
-            [OtlpExporterOptions.ProtocolEnvVarName] = "http/protobuf",
+            [OtlpExporterSpecEnvVarKeyDefinitions.DefaultEndpointEnvVarName] = "http://test:8888",
+            [OtlpExporterSpecEnvVarKeyDefinitions.DefaultHeadersEnvVarName] = "A=2,B=3",
+            [OtlpExporterSpecEnvVarKeyDefinitions.DefaultTimeoutEnvVarName] = "2000",
+            [OtlpExporterSpecEnvVarKeyDefinitions.DefaultProtocolEnvVarName] = "http/protobuf",
         };
 
         var configuration = new ConfigurationBuilder()
@@ -85,9 +85,9 @@ public void OtlpExporterOptions_UsingIConfiguration()
     [Fact]
     public void OtlpExporterOptions_InvalidEnvironmentVariableOverride()
     {
-        Environment.SetEnvironmentVariable(OtlpExporterOptions.EndpointEnvVarName, "invalid");
-        Environment.SetEnvironmentVariable(OtlpExporterOptions.TimeoutEnvVarName, "invalid");
-        Environment.SetEnvironmentVariable(OtlpExporterOptions.ProtocolEnvVarName, "invalid");
+        Environment.SetEnvironmentVariable(OtlpExporterSpecEnvVarKeyDefinitions.DefaultEndpointEnvVarName, "invalid");
+        Environment.SetEnvironmentVariable(OtlpExporterSpecEnvVarKeyDefinitions.DefaultTimeoutEnvVarName, "invalid");
+        Environment.SetEnvironmentVariable(OtlpExporterSpecEnvVarKeyDefinitions.DefaultProtocolEnvVarName, "invalid");
 
         var options = new OtlpExporterOptions();
 
@@ -99,10 +99,10 @@ public void OtlpExporterOptions_InvalidEnvironmentVariableOverride()
     [Fact]
     public void OtlpExporterOptions_SetterOverridesEnvironmentVariable()
     {
-        Environment.SetEnvironmentVariable(OtlpExporterOptions.EndpointEnvVarName, "http://test:8888");
-        Environment.SetEnvironmentVariable(OtlpExporterOptions.HeadersEnvVarName, "A=2,B=3");
-        Environment.SetEnvironmentVariable(OtlpExporterOptions.TimeoutEnvVarName, "2000");
-        Environment.SetEnvironmentVariable(OtlpExporterOptions.ProtocolEnvVarName, "grpc");
+        Environment.SetEnvironmentVariable(OtlpExporterSpecEnvVarKeyDefinitions.DefaultEndpointEnvVarName, "http://test:8888");
+        Environment.SetEnvironmentVariable(OtlpExporterSpecEnvVarKeyDefinitions.DefaultHeadersEnvVarName, "A=2,B=3");
+        Environment.SetEnvironmentVariable(OtlpExporterSpecEnvVarKeyDefinitions.DefaultTimeoutEnvVarName, "2000");
+        Environment.SetEnvironmentVariable(OtlpExporterSpecEnvVarKeyDefinitions.DefaultProtocolEnvVarName, "grpc");
 
         var options = new OtlpExporterOptions
         {
@@ -121,7 +121,7 @@ public void OtlpExporterOptions_SetterOverridesEnvironmentVariable()
     [Fact]
     public void OtlpExporterOptions_ProtocolSetterDoesNotOverrideCustomEndpointFromEnvVariables()
     {
-        Environment.SetEnvironmentVariable(OtlpExporterOptions.EndpointEnvVarName, "http://test:8888");
+        Environment.SetEnvironmentVariable(OtlpExporterSpecEnvVarKeyDefinitions.DefaultEndpointEnvVarName, "http://test:8888");
 
         var options = new OtlpExporterOptions { Protocol = OtlpExportProtocol.Grpc };
 
@@ -141,17 +141,17 @@ public void OtlpExporterOptions_ProtocolSetterDoesNotOverrideCustomEndpointFromS
     [Fact]
     public void OtlpExporterOptions_EnvironmentVariableNames()
     {
-        Assert.Equal("OTEL_EXPORTER_OTLP_ENDPOINT", OtlpExporterOptions.EndpointEnvVarName);
-        Assert.Equal("OTEL_EXPORTER_OTLP_HEADERS", OtlpExporterOptions.HeadersEnvVarName);
-        Assert.Equal("OTEL_EXPORTER_OTLP_TIMEOUT", OtlpExporterOptions.TimeoutEnvVarName);
-        Assert.Equal("OTEL_EXPORTER_OTLP_PROTOCOL", OtlpExporterOptions.ProtocolEnvVarName);
+        Assert.Equal("OTEL_EXPORTER_OTLP_ENDPOINT", OtlpExporterSpecEnvVarKeyDefinitions.DefaultEndpointEnvVarName);
+        Assert.Equal("OTEL_EXPORTER_OTLP_HEADERS", OtlpExporterSpecEnvVarKeyDefinitions.DefaultHeadersEnvVarName);
+        Assert.Equal("OTEL_EXPORTER_OTLP_TIMEOUT", OtlpExporterSpecEnvVarKeyDefinitions.DefaultTimeoutEnvVarName);
+        Assert.Equal("OTEL_EXPORTER_OTLP_PROTOCOL", OtlpExporterSpecEnvVarKeyDefinitions.DefaultProtocolEnvVarName);
     }
 
     private static void ClearEnvVars()
     {
-        Environment.SetEnvironmentVariable(OtlpExporterOptions.EndpointEnvVarName, null);
-        Environment.SetEnvironmentVariable(OtlpExporterOptions.HeadersEnvVarName, null);
-        Environment.SetEnvironmentVariable(OtlpExporterOptions.TimeoutEnvVarName, null);
-        Environment.SetEnvironmentVariable(OtlpExporterOptions.ProtocolEnvVarName, null);
+        Environment.SetEnvironmentVariable(OtlpExporterSpecEnvVarKeyDefinitions.DefaultEndpointEnvVarName, null);
+        Environment.SetEnvironmentVariable(OtlpExporterSpecEnvVarKeyDefinitions.DefaultHeadersEnvVarName, null);
+        Environment.SetEnvironmentVariable(OtlpExporterSpecEnvVarKeyDefinitions.DefaultTimeoutEnvVarName, null);
+        Environment.SetEnvironmentVariable(OtlpExporterSpecEnvVarKeyDefinitions.DefaultProtocolEnvVarName, null);
     }
 }
diff --git a/test/OpenTelemetry.Exporter.OpenTelemetryProtocol.Tests/OtlpLogExporterTests.cs b/test/OpenTelemetry.Exporter.OpenTelemetryProtocol.Tests/OtlpLogExporterTests.cs
@@ -1517,7 +1517,7 @@ private static void RunVerifyEnvironmentVariablesTakenFromIConfigurationTest(
     {
         var values = new Dictionary<string, string>()
         {
-            [OtlpExporterOptions.EndpointEnvVarName] = "http://test:8888",
+            [OtlpExporterSpecEnvVarKeyDefinitions.DefaultEndpointEnvVarName] = "http://test:8888",
         };
 
         var configuration = new ConfigurationBuilder()

Original file line number	Diff line number	Diff line change
`@@ -22,11 +22,6 @@ namespace OpenTelemetry.Exporter;`
`22`	`22`	`/// </summary>`
`23`	`23`	`public class OtlpExporterOptions`
`24`	`24`	`{`
`25`		`- internal const string EndpointEnvVarName = "OTEL_EXPORTER_OTLP_ENDPOINT";`
`26`		`- internal const string HeadersEnvVarName = "OTEL_EXPORTER_OTLP_HEADERS";`
`27`		`- internal const string TimeoutEnvVarName = "OTEL_EXPORTER_OTLP_TIMEOUT";`
`28`		`- internal const string ProtocolEnvVarName = "OTEL_EXPORTER_OTLP_PROTOCOL";`
`29`		`-`
`30`	`25`	`internal static readonly KeyValuePair<string, string>[] StandardHeaders = new KeyValuePair<string, string>[]`
`31`	`26`	`{`
`32`	`27`	`new KeyValuePair<string, string>("User-Agent", GetUserAgentString()),`
`@@ -56,23 +51,23 @@ internal OtlpExporterOptions(`
`56`	`51`	`Debug.Assert(configuration != null, "configuration was null");`
`57`	`52`	`Debug.Assert(defaultBatchOptions != null, "defaultBatchOptions was null");`
`58`	`53`
`59`		`- if (configuration.TryGetUriValue(EndpointEnvVarName, out var endpoint))`
	`54`	`+ if (configuration.TryGetUriValue(OtlpExporterSpecEnvVarKeyDefinitions.DefaultEndpointEnvVarName, out var endpoint))`
`60`	`55`	`{`
`61`	`56`	`this.endpoint = endpoint;`
`62`	`57`	`}`
`63`	`58`
`64`		`- if (configuration.TryGetStringValue(HeadersEnvVarName, out var headers))`
	`59`	`+ if (configuration.TryGetStringValue(OtlpExporterSpecEnvVarKeyDefinitions.DefaultHeadersEnvVarName, out var headers))`
`65`	`60`	`{`
`66`	`61`	`this.Headers = headers;`
`67`	`62`	`}`
`68`	`63`
`69`		`- if (configuration.TryGetIntValue(TimeoutEnvVarName, out var timeout))`
	`64`	`+ if (configuration.TryGetIntValue(OtlpExporterSpecEnvVarKeyDefinitions.DefaultTimeoutEnvVarName, out var timeout))`
`70`	`65`	`{`
`71`	`66`	`this.TimeoutMilliseconds = timeout;`
`72`	`67`	`}`
`73`	`68`
`74`	`69`	`if (configuration.TryGetValue<OtlpExportProtocol>(`
`75`		`- ProtocolEnvVarName,`
	`70`	`+ OtlpExporterSpecEnvVarKeyDefinitions.DefaultProtocolEnvVarName,`
`76`	`71`	`OtlpExportProtocolParser.TryParse,`
`77`	`72`	`out var protocol))`
`78`	`73`	`{`
Original file line number	Diff line number	Diff line change
`@@ -16,8 +16,6 @@ namespace OpenTelemetry.Metrics;`
`16`	`16`	`/// </summary>`
`17`	`17`	`public static class OtlpMetricExporterExtensions`
`18`	`18`	`{`
`19`		`- internal const string OtlpMetricExporterTemporalityPreferenceEnvVarKey = "OTEL_EXPORTER_OTLP_METRICS_TEMPORALITY_PREFERENCE";`
`20`		`-`
`21`	`19`	`/// <summary>`
`22`	`20`	`/// Adds <see cref="OtlpMetricExporter"/> to the <see cref="MeterProviderBuilder"/> using default options.`
`23`	`21`	`/// </summary>`
`@@ -65,7 +63,7 @@ public static MeterProviderBuilder AddOtlpExporter(`
`65`	`63`	`services.AddOptions<MetricReaderOptions>(finalOptionsName).Configure<IConfiguration>(`
`66`	`64`	`(readerOptions, config) =>`
`67`	`65`	`{`
`68`		`- var otlpTemporalityPreference = config[OtlpMetricExporterTemporalityPreferenceEnvVarKey];`
	`66`	`+ var otlpTemporalityPreference = config[OtlpExporterSpecEnvVarKeyDefinitions.MetricsTemporalityPreferenceEnvVarName];`
`69`	`67`	`if (!string.IsNullOrWhiteSpace(otlpTemporalityPreference)`
`70`	`68`	`&& Enum.TryParse<MetricReaderTemporalityPreference>(otlpTemporalityPreference, ignoreCase: true, out var enumValue))`
`71`	`69`	`{`
`@@ -142,7 +140,7 @@ public static MeterProviderBuilder AddOtlpExporter(`
`142`	`140`	`services.AddOptions<MetricReaderOptions>(finalOptionsName).Configure<IConfiguration>(`
`143`	`141`	`(readerOptions, config) =>`
`144`	`142`	`{`
`145`		`- var otlpTemporalityPreference = config[OtlpMetricExporterTemporalityPreferenceEnvVarKey];`
	`143`	`+ var otlpTemporalityPreference = config[OtlpExporterSpecEnvVarKeyDefinitions.MetricsTemporalityPreferenceEnvVarName];`
`146`	`144`	`if (!string.IsNullOrWhiteSpace(otlpTemporalityPreference)`
`147`	`145`	`&& Enum.TryParse<MetricReaderTemporalityPreference>(otlpTemporalityPreference, ignoreCase: true, out var enumValue))`
`148`	`146`	`{`
Original file line number	Diff line number	Diff line change
`@@ -21,7 +21,7 @@ public void ValidateOtlpHttpExportClientEndpoint(string optionEndpoint, string e`
`21`	`21`	`{`
`22`	`22`	`try`
`23`	`23`	`{`
`24`		`- Environment.SetEnvironmentVariable(OtlpExporterOptions.EndpointEnvVarName, endpointEnvVar);`
	`24`	`+ Environment.SetEnvironmentVariable(OtlpExporterSpecEnvVarKeyDefinitions.DefaultEndpointEnvVarName, endpointEnvVar);`
`25`	`25`
`26`	`26`	`OtlpExporterOptions options = new() { Protocol = OtlpExportProtocol.HttpProtobuf };`
`27`	`27`
`@@ -35,7 +35,7 @@ public void ValidateOtlpHttpExportClientEndpoint(string optionEndpoint, string e`
`35`	`35`	`}`
`36`	`36`	`finally`
`37`	`37`	`{`
`38`		`- Environment.SetEnvironmentVariable(OtlpExporterOptions.EndpointEnvVarName, null);`
	`38`	`+ Environment.SetEnvironmentVariable(OtlpExporterSpecEnvVarKeyDefinitions.DefaultEndpointEnvVarName, null);`
`39`	`39`	`}`
`40`	`40`	`}`
`41`	`41`
Original file line number	Diff line number	Diff line change
`@@ -1517,7 +1517,7 @@ private static void RunVerifyEnvironmentVariablesTakenFromIConfigurationTest(`
`1517`	`1517`	`{`
`1518`	`1518`	`var values = new Dictionary<string, string>()`
`1519`	`1519`	`{`
`1520`		`- [OtlpExporterOptions.EndpointEnvVarName] = "http://test:8888",`
	`1520`	`+ [OtlpExporterSpecEnvVarKeyDefinitions.DefaultEndpointEnvVarName] = "http://test:8888",`
`1521`	`1521`	`};`
`1522`	`1522`
`1523`	`1523`	`var configuration = new ConfigurationBuilder()`