[SDK + Jaeger] Support loading environment variables from IConfiguration in Traces & Metrics

build/Common.props

@@ -31,10 +31,11 @@
     <MicrosoftAspNetCoreHttpFeaturesPkgVer>[2.1.1,6.0)</MicrosoftAspNetCoreHttpFeaturesPkgVer>
     <MicrosoftCodeAnalysisAnalyzersPkgVer>[3.3.3]</MicrosoftCodeAnalysisAnalyzersPkgVer>
     <MicrosoftCodeCoveragePkgVer>[17.3.0]</MicrosoftCodeCoveragePkgVer>
+    <MicrosoftExtensionsConfigurationEnvironmentVariablesPkgVer>[3.1.0,)</MicrosoftExtensionsConfigurationEnvironmentVariablesPkgVer>
     <MicrosoftExtensionsHostingAbstractionsPkgVer>[2.1.0,)</MicrosoftExtensionsHostingAbstractionsPkgVer>
     <MicrosoftExtensionsLoggingPkgVer>[3.1.0,)</MicrosoftExtensionsLoggingPkgVer>
     <MicrosoftExtensionsLoggingConfigurationPkgVer>[3.1.0,)</MicrosoftExtensionsLoggingConfigurationPkgVer>
-    <MicrosoftExtensionsOptionsPkgVer>[3.1.0,)</MicrosoftExtensionsOptionsPkgVer>
+    <MicrosoftExtensionsOptionsPkgVer>[5.0.0,)</MicrosoftExtensionsOptionsPkgVer>
     <MicrosoftNETFrameworkReferenceAssembliesPkgVer>[1.0.0,2.0)</MicrosoftNETFrameworkReferenceAssembliesPkgVer>
     <MicrosoftSourceLinkGitHubPkgVer>[1.0.0,2.0)</MicrosoftSourceLinkGitHubPkgVer>
     <OpenTracingPkgVer>[0.12.1,0.13)</OpenTracingPkgVer>

src/OpenTelemetry.Exporter.Jaeger/CHANGELOG.md

@@ -2,6 +2,10 @@
 
 ## Unreleased
 
+* Added support for loading environment variables from `IConfiguration` when
+  using the `AddJaegerExporter` extension
+  ([#3720](https://github.com/open-telemetry/opentelemetry-dotnet/pull/3720))
+
 ## 1.4.0-beta.1
 
 Released 2022-Sep-29

src/OpenTelemetry.Exporter.Jaeger/JaegerExporterHelperExtensions.cs

@@ -62,10 +62,15 @@ public static TracerProviderBuilder AddJaegerExporter(
 
             name ??= Options.DefaultName;
 
-            if (configure != null)
+            builder.ConfigureServices(services =>
             {
-                builder.ConfigureServices(services => services.Configure(name, configure));
-            }
+                if (configure != null)
+                {
+                    services.Configure(name, configure);
+                }
+
+                services.RegisterOptionsFactory(configuration => new JaegerExporterOptions(configuration));
+            });
 
             return builder.ConfigureBuilder((sp, builder) =>
             {

src/OpenTelemetry.Exporter.Jaeger/JaegerExporterOptions.cs

@@ -17,6 +17,7 @@
 using System;
 using System.Diagnostics;
 using System.Net.Http;
+using Microsoft.Extensions.Configuration;
 using OpenTelemetry.Internal;
 using OpenTelemetry.Trace;
 
@@ -43,37 +44,45 @@ public class JaegerExporterOptions
 
         internal static readonly Func<HttpClient> DefaultHttpClientFactory = () => new HttpClient();
 
+        /// <summary>
+        /// Initializes a new instance of the <see cref="JaegerExporterOptions"/> class.
+        /// </summary>
         public JaegerExporterOptions()
+            : this(new ConfigurationBuilder().AddEnvironmentVariables().Build())
         {
-            if (EnvironmentVariableHelper.LoadString(OTelProtocolEnvVarKey, out string protocolEnvVar))
+        }
+
+        internal JaegerExporterOptions(IConfiguration configuration)
+        {
+            if (configuration.TryGetValue<JaegerExportProtocol>(
+                OTelProtocolEnvVarKey,
+                JaegerExporterProtocolParser.TryParse,
+                out var protocol))
             {
-                if (JaegerExporterProtocolParser.TryParse(protocolEnvVar, out var protocol))
-                {
-                    this.Protocol = protocol;
-                }
-                else
-                {
-                    throw new FormatException($"{OTelProtocolEnvVarKey} environment variable has an invalid value: '{protocolEnvVar}'");
-                }
+                this.Protocol = protocol;
             }
 
-            if (EnvironmentVariableHelper.LoadString(OTelAgentHostEnvVarKey, out string agentHostEnvVar))
+            if (configuration.TryGetStringValue(OTelAgentHostEnvVarKey, out var agentHost))
             {
-                this.AgentHost = agentHostEnvVar;
+                this.AgentHost = agentHost;
             }
 
-            if (EnvironmentVariableHelper.LoadNumeric(OTelAgentPortEnvVarKey, out int agentPortEnvVar))
+            if (configuration.TryGetIntValue(OTelAgentPortEnvVarKey, out var agentPort))
             {
-                this.AgentPort = agentPortEnvVar;
+                this.AgentPort = agentPort;
             }
 
-            if (EnvironmentVariableHelper.LoadString(OTelEndpointEnvVarKey, out string endpointEnvVar)
-                && Uri.TryCreate(endpointEnvVar, UriKind.Absolute, out Uri endpoint))
+            if (configuration.TryGetUriValue(OTelEndpointEnvVarKey, out var endpoint))
             {
                 this.Endpoint = endpoint;
             }
         }
 
+        /// <summary>
+        /// Gets or sets the <see cref="JaegerExportProtocol"/> to use when
+        /// communicating to Jaeger. Default value: <see
+        /// cref="JaegerExportProtocol.UdpCompactThrift"/>.
+        /// </summary>
         public JaegerExportProtocol Protocol { get; set; } = JaegerExportProtocol.UdpCompactThrift;
 
         /// <summary>

src/OpenTelemetry.Exporter.Jaeger/JaegerExporterProtocolParser.cs

@@ -20,7 +20,7 @@ internal static class JaegerExporterProtocolParser
 {
     public static bool TryParse(string value, out JaegerExportProtocol result)
     {
-        switch (value?.Trim())
+        switch (value.Trim().ToLower())
         {
             case "udp/thrift.compact":
                 result = JaegerExportProtocol.UdpCompactThrift;

src/OpenTelemetry.Exporter.Jaeger/OpenTelemetry.Exporter.Jaeger.csproj

@@ -19,7 +19,7 @@
     <Compile Include="$(RepoRoot)\src\OpenTelemetry.Api\Internal\ActivityHelperExtensions.cs" Link="Includes\ActivityHelperExtensions.cs" />
     <Compile Include="$(RepoRoot)\src\OpenTelemetry.Api\Internal\StatusHelper.cs" Link="Includes\StatusHelper.cs" />
     <Compile Include="$(RepoRoot)\src\OpenTelemetry.Api\Internal\Guard.cs" Link="Includes\Guard.cs" />
-    <Compile Include="$(RepoRoot)\src\OpenTelemetry\Internal\EnvironmentVariableHelper.cs" Link="Includes\EnvironmentVariableHelper.cs" />
+    <Compile Include="$(RepoRoot)\src\OpenTelemetry\Internal\ConfigurationExtensions.cs" Link="Includes\ConfigurationExtensions.cs" />
     <Compile Include="$(RepoRoot)\src\OpenTelemetry\Internal\OpenTelemetrySdkEventSource.cs" Link="Includes\OpenTelemetrySdkEventSource.cs" />
     <Compile Include="$(RepoRoot)\src\OpenTelemetry\Internal\PooledList.cs" Link="Includes\PooledList.cs" />
     <Compile Include="$(RepoRoot)\src\OpenTelemetry\Internal\PeerServiceResolver.cs" Link="Includes\PeerServiceResolver.cs" />

src/OpenTelemetry/CHANGELOG.md

@@ -7,6 +7,10 @@
   `BatchLogRecordExportProcessor.OnEnd` is fired.
   ([#3731](https://github.com/open-telemetry/opentelemetry-dotnet/pull/3731))
 
+* Added support for loading environment variables from `IConfiguration` when
+  using `TracerProviderBuilder` or `MeterProviderBuilder`
+  ([#3720](https://github.com/open-telemetry/opentelemetry-dotnet/pull/3720))
+
 ## 1.4.0-beta.1
 
 Released 2022-Sep-29

src/OpenTelemetry/Internal/Builder/ProviderBuilderServiceCollectionExtensions.cs

@@ -0,0 +1,42 @@
+// <copyright file="ProviderBuilderServiceCollectionExtensions.cs" company="OpenTelemetry Authors">
+// Copyright The OpenTelemetry Authors
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+// </copyright>
+
+#nullable enable
+
+using System.Diagnostics;
+using Microsoft.Extensions.Configuration;
+using Microsoft.Extensions.DependencyInjection.Extensions;
+
+namespace Microsoft.Extensions.DependencyInjection;
+
+internal static class ProviderBuilderServiceCollectionExtensions
+{
+    public static IServiceCollection AddOpenTelemetryProviderBuilderServices(this IServiceCollection services)
+    {
+        Debug.Assert(services != null, "services was null");
+
+        services.AddOptions();
+
+        // Note: When using a host builder IConfiguration is automatically
+        // registered and this registration will no-op. This only runs for
+        // Sdk.Create* style or when manually creating a ServiceCollection. The
+        // point of this registration is to make IConfiguration available in
+        // those cases.
+        services!.TryAddSingleton<IConfiguration>(sp => new ConfigurationBuilder().AddEnvironmentVariables().Build());
+
+        return services!;
+    }
+}

src/OpenTelemetry/Internal/ConfigurationExtensions.cs

@@ -0,0 +1,164 @@
+// <copyright file="ConfigurationExtensions.cs" company="OpenTelemetry Authors">
+// Copyright The OpenTelemetry Authors
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+// </copyright>
+
+#nullable enable
+
+using System;
+using System.Collections.Generic;
+using System.Diagnostics;
+#if !NETFRAMEWORK && !NETSTANDARD2_0
+using System.Diagnostics.CodeAnalysis;
+#endif
+using System.Globalization;
+using Microsoft.Extensions.Configuration;
+using Microsoft.Extensions.DependencyInjection;
+using Microsoft.Extensions.DependencyInjection.Extensions;
+using Microsoft.Extensions.Options;
+
+namespace OpenTelemetry.Internal;
+
+internal static class ConfigurationExtensions
+{
+    public delegate bool TryParseFunc<T>(
+        string value,
+#if !NETFRAMEWORK && !NETSTANDARD2_0
+        [NotNullWhen(true)]
+#endif
+        out T? parsedValue);
+
+    public static bool TryGetStringValue(
+        this IConfiguration configuration,
+        string key,
+#if !NETFRAMEWORK && !NETSTANDARD2_0
+        [NotNullWhen(true)]
+#endif
+        out string? value)
+    {
+        value = configuration.GetValue<string?>(key, null);
+
+        return !string.IsNullOrWhiteSpace(value);
+    }
+
+    public static bool TryGetUriValue(
+        this IConfiguration configuration,
+        string key,
+#if !NETFRAMEWORK && !NETSTANDARD2_0
+        [NotNullWhen(true)]
+#endif
+        out Uri? value)
+    {
+        if (!configuration.TryGetStringValue(key, out var stringValue))
+        {
+            value = null;
+            return false;
+        }
+
+        if (!Uri.TryCreate(stringValue, UriKind.Absolute, out value))
+        {
+            throw new FormatException($"{key} environment variable has an invalid value: '{stringValue}'");
+        }
+
+        return true;
+    }
+
+    public static bool TryGetIntValue(
+        this IConfiguration configuration,
+        string key,
+        out int value)
+    {
+        if (!configuration.TryGetStringValue(key, out var stringValue))
+        {
+            value = default;
+            return false;
+        }
+
+        if (!int.TryParse(stringValue, NumberStyles.None, CultureInfo.InvariantCulture, out value))
+        {
+            throw new FormatException($"{key} environment variable has an invalid value: '{stringValue}'");
+        }
+
+        return true;
+    }
+
+    public static bool TryGetValue<T>(
+        this IConfiguration configuration,
+        string key,
+        TryParseFunc<T> tryParseFunc,
+#if !NETFRAMEWORK && !NETSTANDARD2_0
+        [NotNullWhen(true)]
+#endif
+        out T? value)
+    {
+        if (!configuration.TryGetStringValue(key, out var stringValue))
+        {
+            value = default;
+            return false;
+        }
+
+        if (!tryParseFunc(stringValue!, out value))
+        {
+            throw new FormatException($"{key} environment variable has an invalid value: '{stringValue}'");
+        }
+
+        return true;
+    }
+
+    public static IServiceCollection RegisterOptionsFactory<T>(
+        this IServiceCollection services,
+        Func<IConfiguration, T> optionsFactoryFunc)
+        where T : class
+    {
+        Debug.Assert(services != null, "services was null");
+        Debug.Assert(optionsFactoryFunc != null, "optionsFactoryFunc was null");
+
+        services!.TryAddSingleton<IOptionsFactory<T>>(sp =>
+        {
+            return new DelegatingOptionsFactory<T>(
+                optionsFactoryFunc!,
+                sp.GetRequiredService<IConfiguration>(),
+                sp.GetServices<IConfigureOptions<T>>(),
+                sp.GetServices<IPostConfigureOptions<T>>(),
+                sp.GetServices<IValidateOptions<T>>());
+        });
+
+        return services!;
+    }
+
+    private sealed class DelegatingOptionsFactory<T> : OptionsFactory<T>
+        where T : class
+    {
+        private readonly Func<IConfiguration, T> optionsFactoryFunc;
+        private readonly IConfiguration configuration;
+
+        public DelegatingOptionsFactory(
+            Func<IConfiguration, T> optionsFactoryFunc,
+            IConfiguration configuration,
+            IEnumerable<IConfigureOptions<T>> setups,
+            IEnumerable<IPostConfigureOptions<T>> postConfigures,
+            IEnumerable<IValidateOptions<T>> validations)
+            : base(setups, postConfigures, validations)
+        {
+            Debug.Assert(optionsFactoryFunc != null, "optionsFactoryFunc was null");
+            Debug.Assert(configuration != null, "configuration was null");
+
+            this.optionsFactoryFunc = optionsFactoryFunc!;
+            this.configuration = configuration!;
+        }
+
+        protected override T CreateInstance(string name)
+            => this.optionsFactoryFunc(this.configuration);
+    }
+}

src/OpenTelemetry/Internal/EnvironmentVariableHelper.cs

@@ -76,6 +76,25 @@ public static bool LoadNumeric(string envVarKey, out int result)
                 return false;
             }
 
+            return LoadNumeric(envVarKey, value, out result);
+        }
+
+        /// <summary>
+        /// Reads an environment variable and parses is as a
+        /// <a href="https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/sdk-environment-variables.md#numeric-value">
+        /// numeric value</a> - a non-negative decimal integer.
+        /// </summary>
+        /// <param name="envVarKey">The name of the environment variable.</param>
+        /// <param name="value">The value of the environment variable.</param>
+        /// <param name="result">The parsed value of the environment variable.</param>
+        /// <returns>
+        /// Returns <c>true</c> when a non-empty value was read; otherwise, <c>false</c>.
+        /// </returns>
+        /// <exception cref="FormatException">
+        /// Thrown when failed to parse the non-empty value.
+        /// </exception>
+        public static bool LoadNumeric(string envVarKey, string value, out int result)
+        {
             if (!int.TryParse(value, NumberStyles.None, CultureInfo.InvariantCulture, out result))
             {
                 throw new FormatException($"{envVarKey} environment variable has an invalid value: '{value}'");

src/OpenTelemetry/Metrics/Builder/MeterProviderBuilderBase.cs

@@ -52,7 +52,7 @@ internal MeterProviderBuilderBase(IServiceCollection services)
         {
             Guard.ThrowIfNull(services);
 
-            services.AddOptions();
+            services.AddOpenTelemetryProviderBuilderServices();
             services.TryAddSingleton<MeterProvider>(sp => new MeterProviderSdk(sp, ownsServiceProvider: false));
 
             this.services = services;
@@ -65,7 +65,7 @@ protected MeterProviderBuilderBase()
         {
             var services = new ServiceCollection();
 
-            services.AddOptions();
+            services.AddOpenTelemetryProviderBuilderServices();
 
             this.services = services;
             this.ownsServices = true;