[AzureMonitorOpenTelemetryDistro] AddAzureMonitorOpenTelemetry extension methods and AzureMonitorOpenTelemetryOptions

eng/Packages.Data.props

@@ -117,6 +117,8 @@
 
     <!-- OpenTelemetry dependency approved for Azure.Monitor.OpenTelemetry.Exporter package only -->
     <PackageReference Update="OpenTelemetry" Version="[1.4.0-rc.4]"  Condition="'$(MSBuildProjectName)' == 'Azure.Monitor.OpenTelemetry.Exporter'" />
+    <PackageReference Update="OpenTelemetry.Extensions.Hosting" Version="1.4.0-rc.4" />
+    <PackageReference Update="OpenTelemetry.Instrumentation.AspNetCore" Version="1.0.0-rc9.13" />
     <PackageReference Update="OpenTelemetry.Extensions.PersistentStorage" Version="1.0.0-beta.1" Condition="'$(MSBuildProjectName)' == 'Azure.Monitor.OpenTelemetry.Exporter'" />
   </ItemGroup>
 

sdk/monitor/Azure.Monitor.OpenTelemetry/Azure.Monitor.OpenTelemetry.sln

@@ -16,6 +16,8 @@ Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Dependent Projects", "Depen
 EndProject
 Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Azure.Monitor.OpenTelemetry.Exporter", "..\Azure.Monitor.OpenTelemetry.Exporter\src\Azure.Monitor.OpenTelemetry.Exporter.csproj", "{4158B8A7-971D-4A57-B4C8-5077BFD10AE6}"
 EndProject
+Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Azure.Monitor.OpenTelemetry.Demo", "tests\Azure.Monitor.OpenTelemetry.Demo\Azure.Monitor.OpenTelemetry.Demo.csproj", "{6F094CAA-F6BB-4A9C-9D1F-1165F0758C99}"
+EndProject
 Global
 	GlobalSection(SolutionConfigurationPlatforms) = preSolution
 		Debug|Any CPU = Debug|Any CPU
@@ -30,6 +32,10 @@ Global
 		{4158B8A7-971D-4A57-B4C8-5077BFD10AE6}.Debug|Any CPU.Build.0 = Debug|Any CPU
 		{4158B8A7-971D-4A57-B4C8-5077BFD10AE6}.Release|Any CPU.ActiveCfg = Release|Any CPU
 		{4158B8A7-971D-4A57-B4C8-5077BFD10AE6}.Release|Any CPU.Build.0 = Release|Any CPU
+		{6F094CAA-F6BB-4A9C-9D1F-1165F0758C99}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{6F094CAA-F6BB-4A9C-9D1F-1165F0758C99}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{6F094CAA-F6BB-4A9C-9D1F-1165F0758C99}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{6F094CAA-F6BB-4A9C-9D1F-1165F0758C99}.Release|Any CPU.Build.0 = Release|Any CPU
 	EndGlobalSection
 	GlobalSection(SolutionProperties) = preSolution
 		HideSolutionNode = FALSE

sdk/monitor/Azure.Monitor.OpenTelemetry/api/Azure.Monitor.OpenTelemetry.netstandard2.0.cs

@@ -0,0 +1,16 @@
+namespace Azure.Monitor.OpenTelemetry
+{
+    public static partial class AzureMonitorOpenTelemetryExtensions
+    {
+        public static Microsoft.Extensions.DependencyInjection.IServiceCollection AddAzureMonitorOpenTelemetry(this Microsoft.Extensions.DependencyInjection.IServiceCollection services, Azure.Monitor.OpenTelemetry.AzureMonitorOpenTelemetryOptions? options = null) { throw null; }
+        public static Microsoft.Extensions.DependencyInjection.IServiceCollection AddAzureMonitorOpenTelemetry(this Microsoft.Extensions.DependencyInjection.IServiceCollection services, Microsoft.Extensions.Configuration.IConfiguration configuration) { throw null; }
+        public static Microsoft.Extensions.DependencyInjection.IServiceCollection AddAzureMonitorOpenTelemetry(this Microsoft.Extensions.DependencyInjection.IServiceCollection services, System.Action<Azure.Monitor.OpenTelemetry.AzureMonitorOpenTelemetryOptions> configureAzureMonitorOpenTelemetry, string? name = null) { throw null; }
+    }
+    public partial class AzureMonitorOpenTelemetryOptions : Azure.Monitor.OpenTelemetry.Exporter.AzureMonitorExporterOptions
+    {
+        public AzureMonitorOpenTelemetryOptions() { }
+        public bool EnableLogs { get { throw null; } set { } }
+        public bool EnableMetrics { get { throw null; } set { } }
+        public bool EnableTraces { get { throw null; } set { } }
+    }
+}

sdk/monitor/Azure.Monitor.OpenTelemetry/src/Azure.Monitor.OpenTelemetry.csproj

@@ -8,6 +8,11 @@
     <IncludeOperationsSharedSource>true</IncludeOperationsSharedSource>
   </PropertyGroup>
 
+  <ItemGroup>
+    <PackageReference Include="OpenTelemetry.Extensions.Hosting" />
+    <PackageReference Include="OpenTelemetry.Instrumentation.AspNetCore" />
+  </ItemGroup>
+
   <ItemGroup>
     <ProjectReference Include="..\..\Azure.Monitor.OpenTelemetry.Exporter\src\Azure.Monitor.OpenTelemetry.Exporter.csproj" />
   </ItemGroup>

sdk/monitor/Azure.Monitor.OpenTelemetry/src/AzureMonitorOpenTelemetryExtensions.cs

@@ -0,0 +1,51 @@
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT License.
+
+using System;
+using Microsoft.Extensions.Configuration;
+using Microsoft.Extensions.DependencyInjection;
+
+namespace Azure.Monitor.OpenTelemetry
+{
+    /// <summary>
+    /// Extension methods for setting up Azure Monitor OpenTelemetry in an <see cref="IServiceCollection" />.
+    /// </summary>
+    public static class AzureMonitorOpenTelemetryExtensions
+    {
+        /// <summary>
+        /// Adds Azure Monitor OpenTelemetry into service collection.
+        /// </summary>
+        /// <param name="services">The <see cref="IServiceCollection" /> to add services to.</param>
+        /// <param name="options">The <see cref="AzureMonitorOpenTelemetryOptions" /> instance for configuration.</param>
+        /// <returns>The <see cref="IServiceCollection"/> so that additional calls can be chained.</returns>
+        public static IServiceCollection AddAzureMonitorOpenTelemetry(this IServiceCollection services, AzureMonitorOpenTelemetryOptions? options = null)
+        {
+            return AzureMonitorOpenTelemetryImplementations.AddAzureMonitorOpenTelemetryWithOptions(services, options);
+        }
+
+        /// <summary>
+        /// Adds Azure Monitor OpenTelemetry into service collection.
+        /// </summary>
+        /// <param name="services">The <see cref="IServiceCollection" /> to add services to.</param>
+        /// <param name="configuration"><see cref="IConfiguration"/>.</param>
+        /// <returns>The <see cref="IServiceCollection"/> so that additional calls can be chained.</returns>
+        public static IServiceCollection AddAzureMonitorOpenTelemetry(this IServiceCollection services, IConfiguration configuration)
+        {
+            var options = new AzureMonitorOpenTelemetryOptions();
+            configuration.Bind(options);
+            return services.AddAzureMonitorOpenTelemetry(options);
+        }
+
+        /// <summary>
+        /// Adds Azure Monitor OpenTelemetry into service collection.
+        /// </summary>
+        /// <param name="services"><see cref="IServiceCollection"/>.</param>
+        /// <param name="configureAzureMonitorOpenTelemetry">Callback action for configuring <see cref="AzureMonitorOpenTelemetryOptions"/>.</param>
+        /// <param name="name">Name which is used when retrieving options.</param>
+        /// <returns><see cref="IServiceCollection"/>.</returns>
+        public static IServiceCollection AddAzureMonitorOpenTelemetry(this IServiceCollection services, Action<AzureMonitorOpenTelemetryOptions> configureAzureMonitorOpenTelemetry, string? name = null)
+        {
+            return AzureMonitorOpenTelemetryImplementations.AddAzureMonitorOpenTelemetryWithAction(services, configureAzureMonitorOpenTelemetry, name);
+        }
+    }
+}

sdk/monitor/Azure.Monitor.OpenTelemetry/src/AzureMonitorOpenTelemetryImplementations.cs

@@ -0,0 +1,177 @@
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT License.
+
+using System;
+using Azure.Monitor.OpenTelemetry.Exporter;
+using Microsoft.Extensions.DependencyInjection;
+using Microsoft.Extensions.Options;
+using OpenTelemetry.Metrics;
+using OpenTelemetry.Trace;
+
+namespace Azure.Monitor.OpenTelemetry
+{
+    internal class AzureMonitorOpenTelemetryImplementations
+    {
+        internal static IServiceCollection AddAzureMonitorOpenTelemetryWithOptions(IServiceCollection services, AzureMonitorOpenTelemetryOptions? options)
+        {
+            if (services == null)
+            {
+                throw new ArgumentNullException(nameof(services));
+            }
+
+            options ??= new AzureMonitorOpenTelemetryOptions();
+            var builder = services.AddOpenTelemetry();
+
+            if (options.EnableTraces)
+            {
+                builder.WithTracing(b => b
+                             .AddAspNetCoreInstrumentation()
+                             .AddAzureMonitorTraceExporter(o =>
+                             {
+                                 o.ConnectionString = options.ConnectionString;
+                                 o.DisableOfflineStorage = options.DisableOfflineStorage;
+                                 o.StorageDirectory = options.StorageDirectory;
+                             }));
+            }
+
+            if (options.EnableMetrics)
+            {
+                builder.WithMetrics(b => b
+                             .AddAspNetCoreInstrumentation()
+                             .AddAzureMonitorMetricExporter(o =>
+                             {
+                                 o.ConnectionString = options.ConnectionString;
+                                 o.DisableOfflineStorage = options.DisableOfflineStorage;
+                                 o.StorageDirectory = options.StorageDirectory;
+                             }));
+            }
+
+            return services;
+        }
+
+        internal static IServiceCollection AddAzureMonitorOpenTelemetryWithAction(IServiceCollection services, Action<AzureMonitorOpenTelemetryOptions> configureAzureMonitorOpenTelemetry, string? name)
+        {
+            if (services == null)
+            {
+                throw new ArgumentNullException(nameof(services));
+            }
+
+            name ??= Options.DefaultName;
+
+            if (configureAzureMonitorOpenTelemetry != null)
+            {
+                services.Configure(name, configureAzureMonitorOpenTelemetry);
+            }
+
+            var builder = services.AddOpenTelemetry();
+
+            builder.WithTracing(b => b
+                            .AddAspNetCoreInstrumentation()
+                            .AddAzureMonitorTraceExporter());
+
+            builder.WithMetrics(b => b
+                            .AddAspNetCoreInstrumentation()
+                            .AddAzureMonitorMetricExporter());
+
+            ServiceDescriptor? sdkTracerProviderServiceRegistration = null;
+            ServiceDescriptor? sdkMeterProviderServiceRegistration = null;
+
+            foreach (var service in services)
+            {
+                if (service.ServiceType == typeof(TracerProvider))
+                {
+                    sdkTracerProviderServiceRegistration = service;
+                }
+                else if (service.ServiceType == typeof(MeterProvider))
+                {
+                    sdkMeterProviderServiceRegistration = service;
+                }
+            }
+
+            if (sdkTracerProviderServiceRegistration?.ImplementationFactory == null ||
+                sdkMeterProviderServiceRegistration?.ImplementationFactory == null)
+            {
+                throw new InvalidOperationException("OpenTelemetry SDK has changed its registration mechanism.");
+            }
+
+            // We looped through the registered services so that we can take over
+            // the SDK registrations.
+
+            services.Remove(sdkTracerProviderServiceRegistration);
+            services.Remove(sdkMeterProviderServiceRegistration);
+
+            // Now we register our own services for TracerProvider & MeterProvider
+            // so that we can return no-op versions when it isn't enabled.
+
+            services.AddSingleton(sp =>
+            {
+                var options = sp.GetRequiredService<IOptionsMonitor<AzureMonitorOpenTelemetryOptions>>().Get(name);
+                if (!options.EnableTraces)
+                {
+                    return new NoopTracerProvider();
+                }
+                else
+                {
+                    SetValueToExporterOptions(sp, options);
+                    var sdkProviderWrapper = sp.GetRequiredService<SdkProviderWrapper>();
+                    sdkProviderWrapper.SdkTracerProvider = (TracerProvider)sdkTracerProviderServiceRegistration.ImplementationFactory(sp);
+                    return sdkProviderWrapper.SdkTracerProvider;
+                }
+            });
+
+            services.AddSingleton(sp =>
+            {
+                var options = sp.GetRequiredService<IOptionsMonitor<AzureMonitorOpenTelemetryOptions>>().Get(name);
+                if (!options.EnableMetrics)
+                {
+                    return new NoopMeterProvider();
+                }
+                else
+                {
+                    SetValueToExporterOptions(sp, options);
+                    var sdkProviderWrapper = sp.GetRequiredService<SdkProviderWrapper>();
+                    sdkProviderWrapper.SdkMeterProvider = (MeterProvider)sdkMeterProviderServiceRegistration.ImplementationFactory(sp);
+                    return sdkProviderWrapper.SdkMeterProvider;
+                }
+            });
+
+            // SdkProviderWrapper is here to make sure the SDK services get properly
+            // shutdown when the service provider is disposed.
+            services.AddSingleton<SdkProviderWrapper>();
+
+            return services;
+        }
+
+        private static void SetValueToExporterOptions(IServiceProvider sp, AzureMonitorOpenTelemetryOptions options)
+        {
+            var exporterOptions = sp.GetRequiredService<IOptionsMonitor<AzureMonitorExporterOptions>>().Get("");
+
+            // TODO: Remove the hard-coded ConnectionString.
+            // If ConnectionString is not provided in config, exporter will throw.
+            // Modify exporter to include environment variable.
+            exporterOptions.ConnectionString = options.ConnectionString ?? "InstrumentationKey=00000000-0000-0000-0000-000000000000";
+            exporterOptions.DisableOfflineStorage = options.DisableOfflineStorage;
+            exporterOptions.StorageDirectory = options.StorageDirectory;
+        }
+
+        private sealed class NoopTracerProvider : TracerProvider
+        {
+        }
+
+        private sealed class NoopMeterProvider : MeterProvider
+        {
+        }
+
+        private sealed class SdkProviderWrapper : IDisposable
+        {
+            public TracerProvider? SdkTracerProvider;
+            public MeterProvider? SdkMeterProvider;
+
+            public void Dispose()
+            {
+                this.SdkTracerProvider?.Dispose();
+                this.SdkMeterProvider?.Dispose();
+            }
+        }
+    }
+}

sdk/monitor/Azure.Monitor.OpenTelemetry/src/AzureMonitorOpenTelemetryOptions.cs

@@ -0,0 +1,30 @@
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT License.
+
+#nullable disable
+
+using Azure.Monitor.OpenTelemetry.Exporter;
+
+namespace Azure.Monitor.OpenTelemetry
+{
+    /// <summary>
+    /// Options that allow users to configure the Azure Monitor OpenTelemetry.
+    /// </summary>
+    public class AzureMonitorOpenTelemetryOptions : AzureMonitorExporterOptions
+    {
+        /// <summary>
+        /// Gets or sets a value indicating whether Traces should be enabled.
+        /// </summary>
+        public bool EnableTraces { get; set; } = true;
+
+        /// <summary>
+        /// Gets or sets a value indicating whether Metrics should be enabled.
+        /// </summary>
+        public bool EnableMetrics { get; set; } = true;
+
+        /// <summary>
+        /// Gets or sets a value indicating whether Logs should be enabled.
+        /// </summary>
+        public bool EnableLogs { get; set; } = true;
+    }
+}

sdk/monitor/Azure.Monitor.OpenTelemetry/tests/Azure.Monitor.OpenTelemetry.Demo/Azure.Monitor.OpenTelemetry.Demo.csproj

@@ -0,0 +1,11 @@
+<Project Sdk="Microsoft.NET.Sdk.Web">
+
+  <PropertyGroup>
+    <TargetFrameworks>$(RequiredTargetFrameworks)</TargetFrameworks>
+  </PropertyGroup>
+
+  <ItemGroup>
+    <ProjectReference Include="..\..\src\Azure.Monitor.OpenTelemetry.csproj" />
+  </ItemGroup>
+
+</Project>

sdk/monitor/Azure.Monitor.OpenTelemetry/tests/Azure.Monitor.OpenTelemetry.Demo/Program.cs

@@ -0,0 +1,45 @@
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT License.
+
+#if NET6_0_OR_GREATER
+using System.Diagnostics;
+using Azure.Monitor.OpenTelemetry;
+using Microsoft.AspNetCore.Builder;
+using Microsoft.Extensions.DependencyInjection;
+using OpenTelemetry.Instrumentation.AspNetCore;
+
+var builder = WebApplication.CreateBuilder(args);
+
+// Add services to the container.
+builder.Services.Configure<AspNetCoreInstrumentationOptions>(o =>
+{
+    o.EnrichWithHttpRequest = (activity, httpRequest) =>
+    {
+        activity.SetTag("requestProtocol", httpRequest.Protocol);
+    };
+    o.EnrichWithHttpResponse = (activity, httpResponse) =>
+    {
+        activity.SetTag("responseLength", httpResponse.ContentLength);
+    };
+    o.EnrichWithException = (activity, exception) =>
+    {
+        activity.SetTag("exceptionType", exception.GetType().ToString());
+    };
+});
+
+// builder.Services.AddAzureMonitorOpenTelemetry();
+
+// builder.Services.AddAzureMonitorOpenTelemetry(enableTraces: true, enableMetrics: true);
+
+// builder.Services.AddAzureMonitorOpenTelemetry(builder.Configuration.GetSection("AzureMonitorOpenTelemetry"));
+
+builder.Services.AddAzureMonitorOpenTelemetry(o =>
+{
+    o.ConnectionString = "InstrumentationKey=00000000-0000-0000-0000-000000000000";
+});
+
+var app = builder.Build();
+app.MapGet("/", () => $"Hello World! OpenTelemetry Trace: {Activity.Current?.Id}");
+
+app.Run();
+#endif

sdk/monitor/Azure.Monitor.OpenTelemetry/tests/Azure.Monitor.OpenTelemetry.Demo/ProgramNet461Compat.cs

@@ -0,0 +1,16 @@
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT License.
+
+#if NET461
+
+namespace Azure.Monitor.OpenTelemetry.Demo
+{
+    public partial class Program
+    {
+        public static void Main(string[] args)
+        {
+        }
+    }
+}
+
+#endif