Enable zipkin endpoint configuration via environment variable

src/OpenTelemetry.Exporter.Zipkin/CHANGELOG.md

@@ -2,6 +2,10 @@
 
 ## Unreleased
 
+* Enabling endpoint configuration in ZipkinExporterOptions via
+  `OTEL_EXPORTER_ZIPKIN_ENDPOINT` environment variable.
+  ([#1453](https://github.com/open-telemetry/opentelemetry-dotnet/issues/1453))
+
 ## 1.2.0-alpha1
 
 Released 2021-Jul-23

src/OpenTelemetry.Exporter.Zipkin/Implementation/ZipkinExporterEventSource.cs

@@ -37,10 +37,25 @@ public void FailedExport(Exception ex)
             }
         }
 
+        [NonEvent]
+        public void FailedEndpointInitialization(Exception ex)
+        {
+            if (this.IsEnabled(EventLevel.Error, (EventKeywords)(-1)))
+            {
+                this.FailedEndpointInitialization(ex.ToInvariantString());
+            }
+        }
+
         [Event(1, Message = "Failed to export activities: '{0}'", Level = EventLevel.Error)]
         public void FailedExport(string exception)
         {
             this.WriteEvent(1, exception);
         }
+
+        [Event(2, Message = "Error initializing Zipkin endpoint, falling back to default value: '{0}'", Level = EventLevel.Error)]
+        public void FailedEndpointInitialization(string exception)
+        {
+            this.WriteEvent(2, exception);
+        }
     }
 }

src/OpenTelemetry.Exporter.Zipkin/README.md

@@ -20,8 +20,11 @@ method on `TracerProviderBuilder`.
 
 ## Configuration
 
-You can configure the `ZipkinExporter` through
-`ZipkinExporterOptions` properties:
+You can configure the `ZipkinExporter` through `ZipkinExporterOptions`
+and environment variables. The `ZipkinExporterOptions` setters
+take precedence over the environment variables.
+
+### Configuration using Properties
 
 * `ServiceName`: Name of the service reporting telemetry. If the `Resource`
    associated with the telemetry has "service.name" defined, then it'll be
@@ -41,7 +44,7 @@ See
 [`TestZipkinExporter.cs`](../../examples/Console/TestZipkinExporter.cs)
 for example use.
 
-## Configuration using Dependency Injection
+### Configuration using Dependency Injection
 
 This exporter allows easy configuration of `ZipkinExporterOptions` from
 dependency injection container, when used in conjunction with
@@ -50,6 +53,15 @@ dependency injection container, when used in conjunction with
 See the [Startup](../../examples/AspNetCore/Startup.cs) class of the ASP.NET
 Core application for example use.
 
+### Configuration using Environment Variables
+
+The following environment variables can be used to override the default
+values of the `ZipkinExporterOptions`.
+
+| Environment variable            | `ZipkinExporterOptions` property |
+| --------------------------------| -------------------------------- |
+| `OTEL_EXPORTER_ZIPKIN_ENDPOINT` | `Endpoint`                       |
+
 ## References
 
 * [OpenTelemetry Project](https://opentelemetry.io/)

src/OpenTelemetry.Exporter.Zipkin/ZipkinExporterOptions.cs

@@ -16,6 +16,7 @@
 
 using System;
 using System.Diagnostics;
+using OpenTelemetry.Exporter.Zipkin.Implementation;
 
 namespace OpenTelemetry.Exporter
 {
@@ -25,12 +26,31 @@ namespace OpenTelemetry.Exporter
     public sealed class ZipkinExporterOptions
     {
         internal const int DefaultMaxPayloadSizeInBytes = 4096;
+        internal const string ZipkinEndpointEnvVar = "OTEL_EXPORTER_ZIPKIN_ENDPOINT";
+        internal const string DefaultZipkinEndpoint = "http://localhost:9411/api/v2/spans";
+
+        /// <summary>
+        /// Initializes a new instance of the <see cref="ZipkinExporterOptions"/> class.
+        /// Initializes zipkin endpoint.
+        /// </summary>
+        public ZipkinExporterOptions()
+        {
+            try
+            {
+                this.Endpoint = new Uri(Environment.GetEnvironmentVariable(ZipkinEndpointEnvVar) ?? DefaultZipkinEndpoint);
+            }
+            catch (Exception ex)
+            {
+                this.Endpoint = new Uri(DefaultZipkinEndpoint);
+                ZipkinExporterEventSource.Log.FailedEndpointInitialization(ex);
+            }
+        }
 
         /// <summary>
         /// Gets or sets Zipkin endpoint address. See https://zipkin.io/zipkin-api/#/default/post_spans.
         /// Typically https://zipkin-server-name:9411/api/v2/spans.
         /// </summary>
-        public Uri Endpoint { get; set; } = new Uri("http://localhost:9411/api/v2/spans");
+        public Uri Endpoint { get; set; }
 
         /// <summary>
         /// Gets or sets a value indicating whether short trace id should be used.

test/OpenTelemetry.Exporter.Zipkin.Tests/ZipkinExporterTests.cs

@@ -131,6 +131,60 @@ public void SuppresssesInstrumentation()
             Assert.Equal(1, endCalledCount);
         }
 
+        [Fact]
+        public void EndpointConfigurationUsingEnvironmentVariable()
+        {
+            try
+            {
+                Environment.SetEnvironmentVariable(ZipkinExporterOptions.ZipkinEndpointEnvVar, "http://urifromenvironmentvariable");
+
+                var exporterOptions = new ZipkinExporterOptions();
+
+                Assert.Equal(new Uri(Environment.GetEnvironmentVariable(ZipkinExporterOptions.ZipkinEndpointEnvVar)).AbsoluteUri, exporterOptions.Endpoint.AbsoluteUri);
+            }
+            finally
+            {
+                Environment.SetEnvironmentVariable(ZipkinExporterOptions.ZipkinEndpointEnvVar, null);
+            }
+        }
+
+        [Fact]
+        public void IncodeEndpointConfigTakesPrecedenceOverEnvironmentVariable()
+        {
+            try
+            {
+                Environment.SetEnvironmentVariable(ZipkinExporterOptions.ZipkinEndpointEnvVar, "http://urifromenvironmentvariable");
+
+                var exporterOptions = new ZipkinExporterOptions
+                {
+                    Endpoint = new Uri("http://urifromcode"),
+                };
+
+                Assert.Equal(new Uri("http://urifromcode").AbsoluteUri, exporterOptions.Endpoint.AbsoluteUri);
+            }
+            finally
+            {
+                Environment.SetEnvironmentVariable(ZipkinExporterOptions.ZipkinEndpointEnvVar, null);
+            }
+        }
+
+        [Fact]
+        public void ErrorGettingUriFromEnvVarSetsDefaultEndpointValue()
+        {
+            try
+            {
+                Environment.SetEnvironmentVariable(ZipkinExporterOptions.ZipkinEndpointEnvVar, "InvalidUri");
+
+                var exporterOptions = new ZipkinExporterOptions();
+
+                Assert.Equal(new Uri(ZipkinExporterOptions.DefaultZipkinEndpoint).AbsoluteUri, exporterOptions.Endpoint.AbsoluteUri);
+            }
+            finally
+            {
+                Environment.SetEnvironmentVariable(ZipkinExporterOptions.ZipkinEndpointEnvVar, null);
+            }
+        }
+
         [Theory]
         [InlineData(true, false, false)]
         [InlineData(false, false, false)]