[sdk+hosting] Move AddOpenTelemetry & OpenTelemetryBuilder into Hosting package

docs/trace/getting-started-aspnetcore/Program.cs

@@ -15,7 +15,6 @@
 // </copyright>
 
 using System.Diagnostics;
-using OpenTelemetry;
 using OpenTelemetry.Resources;
 using OpenTelemetry.Trace;
 
@@ -27,8 +26,7 @@
         .AddService(serviceName: "OTel.NET Getting Started"))
     .WithTracing(builder => builder
         .AddAspNetCoreInstrumentation()
-        .AddConsoleExporter())
-    .StartWithHost();
+        .AddConsoleExporter());
 
 var app = appBuilder.Build();
 

examples/AspNetCore/Program.cs

@@ -15,7 +15,6 @@
 // </copyright>
 
 using Examples.AspNetCore;
-using OpenTelemetry;
 using OpenTelemetry.Exporter;
 using OpenTelemetry.Instrumentation.AspNetCore;
 using OpenTelemetry.Logs;
@@ -127,8 +126,7 @@
                 builder.AddConsoleExporter();
                 break;
         }
-    })
-    .StartWithHost();
+    });
 
 // Clear default logging providers used by WebApplication host.
 appBuilder.Logging.ClearProviders();

examples/GrpcService/Startup.cs

@@ -14,7 +14,6 @@
 // limitations under the License.
 // </copyright>
 
-using OpenTelemetry;
 using OpenTelemetry.Resources;
 using OpenTelemetry.Trace;
 
@@ -61,8 +60,7 @@ public void ConfigureServices(IServiceCollection services)
                             builder.AddConsoleExporter();
                             break;
                     }
-                })
-                .StartWithHost();
+                });
         }
 
         public void Configure(IApplicationBuilder app, IWebHostEnvironment env)

examples/MicroserviceExample/WebApi/Startup.cs

@@ -14,7 +14,6 @@
 // limitations under the License.
 // </copyright>
 
-using OpenTelemetry;
 using OpenTelemetry.Trace;
 using Utils.Messaging;
 
@@ -43,8 +42,7 @@ public void ConfigureServices(IServiceCollection services)
                     {
                         var zipkinHostName = Environment.GetEnvironmentVariable("ZIPKIN_HOSTNAME") ?? "localhost";
                         b.Endpoint = new Uri($"http://{zipkinHostName}:9411/api/v2/spans");
-                    }))
-                .StartWithHost();
+                    }));
         }
 
         public void Configure(IApplicationBuilder app, IWebHostEnvironment env)

examples/MicroserviceExample/WorkerService/Program.cs

@@ -14,7 +14,6 @@
 // limitations under the License.
 // </copyright>
 
-using OpenTelemetry;
 using OpenTelemetry.Trace;
 using Utils.Messaging;
 
@@ -42,8 +41,7 @@ public static IHostBuilder CreateHostBuilder(string[] args) =>
                             {
                                 var zipkinHostName = Environment.GetEnvironmentVariable("ZIPKIN_HOSTNAME") ?? "localhost";
                                 b.Endpoint = new Uri($"http://{zipkinHostName}:9411/api/v2/spans");
-                            }))
-                        .StartWithHost();
+                            }));
                 });
     }
 }

src/OpenTelemetry.Extensions.Hosting/.publicApi/netstandard2.0/PublicAPI.Shipped.txt

@@ -0,0 +1 @@
+#nullable enable

src/OpenTelemetry.Extensions.Hosting/.publicApi/netstandard2.0/PublicAPI.Unshipped.txt

@@ -1,13 +1,19 @@
 Microsoft.Extensions.DependencyInjection.OpenTelemetryServicesExtensions
 OpenTelemetry.Metrics.MeterProviderBuilderExtensions
-OpenTelemetry.OpenTelemetryBuilderHostingExtensions
+OpenTelemetry.OpenTelemetryBuilder
+OpenTelemetry.OpenTelemetryBuilder.ConfigureResource(System.Action<OpenTelemetry.Resources.ResourceBuilder!>! configure) -> OpenTelemetry.OpenTelemetryBuilder!
+OpenTelemetry.OpenTelemetryBuilder.Services.get -> Microsoft.Extensions.DependencyInjection.IServiceCollection!
+OpenTelemetry.OpenTelemetryBuilder.WithMetrics() -> OpenTelemetry.OpenTelemetryBuilder!
+OpenTelemetry.OpenTelemetryBuilder.WithMetrics(System.Action<OpenTelemetry.Metrics.MeterProviderBuilder!>! configure) -> OpenTelemetry.OpenTelemetryBuilder!
+OpenTelemetry.OpenTelemetryBuilder.WithTracing() -> OpenTelemetry.OpenTelemetryBuilder!
+OpenTelemetry.OpenTelemetryBuilder.WithTracing(System.Action<OpenTelemetry.Trace.TracerProviderBuilder!>! configure) -> OpenTelemetry.OpenTelemetryBuilder!
 OpenTelemetry.Trace.TracerProviderBuilderExtensions
-static Microsoft.Extensions.DependencyInjection.OpenTelemetryServicesExtensions.AddOpenTelemetryMetrics(this Microsoft.Extensions.DependencyInjection.IServiceCollection services) -> Microsoft.Extensions.DependencyInjection.IServiceCollection
-static Microsoft.Extensions.DependencyInjection.OpenTelemetryServicesExtensions.AddOpenTelemetryMetrics(this Microsoft.Extensions.DependencyInjection.IServiceCollection services, System.Action<OpenTelemetry.Metrics.MeterProviderBuilder> configure) -> Microsoft.Extensions.DependencyInjection.IServiceCollection
-static Microsoft.Extensions.DependencyInjection.OpenTelemetryServicesExtensions.AddOpenTelemetryTracing(this Microsoft.Extensions.DependencyInjection.IServiceCollection services) -> Microsoft.Extensions.DependencyInjection.IServiceCollection
-static Microsoft.Extensions.DependencyInjection.OpenTelemetryServicesExtensions.AddOpenTelemetryTracing(this Microsoft.Extensions.DependencyInjection.IServiceCollection services, System.Action<OpenTelemetry.Trace.TracerProviderBuilder> configure) -> Microsoft.Extensions.DependencyInjection.IServiceCollection
-static OpenTelemetry.Metrics.MeterProviderBuilderExtensions.Configure(this OpenTelemetry.Metrics.MeterProviderBuilder meterProviderBuilder, System.Action<System.IServiceProvider, OpenTelemetry.Metrics.MeterProviderBuilder> configure) -> OpenTelemetry.Metrics.MeterProviderBuilder
-static OpenTelemetry.Metrics.MeterProviderBuilderExtensions.GetServices(this OpenTelemetry.Metrics.MeterProviderBuilder meterProviderBuilder) -> Microsoft.Extensions.DependencyInjection.IServiceCollection
-static OpenTelemetry.OpenTelemetryBuilderHostingExtensions.StartWithHost(this OpenTelemetry.OpenTelemetryBuilder builder) -> OpenTelemetry.OpenTelemetryBuilder
-static OpenTelemetry.Trace.TracerProviderBuilderExtensions.Configure(this OpenTelemetry.Trace.TracerProviderBuilder tracerProviderBuilder, System.Action<System.IServiceProvider, OpenTelemetry.Trace.TracerProviderBuilder> configure) -> OpenTelemetry.Trace.TracerProviderBuilder
-static OpenTelemetry.Trace.TracerProviderBuilderExtensions.GetServices(this OpenTelemetry.Trace.TracerProviderBuilder tracerProviderBuilder) -> Microsoft.Extensions.DependencyInjection.IServiceCollection
+static Microsoft.Extensions.DependencyInjection.OpenTelemetryServicesExtensions.AddOpenTelemetry(this Microsoft.Extensions.DependencyInjection.IServiceCollection! services) -> OpenTelemetry.OpenTelemetryBuilder!
+static Microsoft.Extensions.DependencyInjection.OpenTelemetryServicesExtensions.AddOpenTelemetryMetrics(this Microsoft.Extensions.DependencyInjection.IServiceCollection! services) -> Microsoft.Extensions.DependencyInjection.IServiceCollection!
+static Microsoft.Extensions.DependencyInjection.OpenTelemetryServicesExtensions.AddOpenTelemetryMetrics(this Microsoft.Extensions.DependencyInjection.IServiceCollection! services, System.Action<OpenTelemetry.Metrics.MeterProviderBuilder!>! configure) -> Microsoft.Extensions.DependencyInjection.IServiceCollection!
+static Microsoft.Extensions.DependencyInjection.OpenTelemetryServicesExtensions.AddOpenTelemetryTracing(this Microsoft.Extensions.DependencyInjection.IServiceCollection! services) -> Microsoft.Extensions.DependencyInjection.IServiceCollection!
+static Microsoft.Extensions.DependencyInjection.OpenTelemetryServicesExtensions.AddOpenTelemetryTracing(this Microsoft.Extensions.DependencyInjection.IServiceCollection! services, System.Action<OpenTelemetry.Trace.TracerProviderBuilder!>! configure) -> Microsoft.Extensions.DependencyInjection.IServiceCollection!
+static OpenTelemetry.Metrics.MeterProviderBuilderExtensions.Configure(this OpenTelemetry.Metrics.MeterProviderBuilder! meterProviderBuilder, System.Action<System.IServiceProvider!, OpenTelemetry.Metrics.MeterProviderBuilder!>! configure) -> OpenTelemetry.Metrics.MeterProviderBuilder!
+static OpenTelemetry.Metrics.MeterProviderBuilderExtensions.GetServices(this OpenTelemetry.Metrics.MeterProviderBuilder! meterProviderBuilder) -> Microsoft.Extensions.DependencyInjection.IServiceCollection!
+static OpenTelemetry.Trace.TracerProviderBuilderExtensions.Configure(this OpenTelemetry.Trace.TracerProviderBuilder! tracerProviderBuilder, System.Action<System.IServiceProvider!, OpenTelemetry.Trace.TracerProviderBuilder!>! configure) -> OpenTelemetry.Trace.TracerProviderBuilder!
+static OpenTelemetry.Trace.TracerProviderBuilderExtensions.GetServices(this OpenTelemetry.Trace.TracerProviderBuilder! tracerProviderBuilder) -> Microsoft.Extensions.DependencyInjection.IServiceCollection!

src/OpenTelemetry.Extensions.Hosting/Metrics/MeterProviderBuilderExtensions.cs

@@ -15,6 +15,7 @@
 // </copyright>
 
 using Microsoft.Extensions.DependencyInjection;
+using OpenTelemetry.Internal;
 
 namespace OpenTelemetry.Metrics
 {
@@ -34,7 +35,12 @@ public static class MeterProviderBuilderExtensions
         [Obsolete("Configure has been replaced by factory extensions. This method will be removed in a future version.")]
         public static MeterProviderBuilder Configure(this MeterProviderBuilder meterProviderBuilder, Action<IServiceProvider, MeterProviderBuilder> configure)
         {
-            return (meterProviderBuilder as IDeferredMeterProviderBuilder)?.Configure(configure);
+            if (meterProviderBuilder is IDeferredMeterProviderBuilder deferredMeterProviderBuilder)
+            {
+                deferredMeterProviderBuilder.Configure(configure);
+            }
+
+            return meterProviderBuilder;
         }
 
         /// <summary>
@@ -47,8 +53,17 @@ public static MeterProviderBuilder Configure(this MeterProviderBuilder meterProv
         [Obsolete("Call ConfigureServices instead this method will be removed in a future version.")]
         public static IServiceCollection GetServices(this MeterProviderBuilder meterProviderBuilder)
         {
-            IServiceCollection services = null;
+            Guard.ThrowIfNull(meterProviderBuilder);
+
+            IServiceCollection? services = null;
+
             meterProviderBuilder.ConfigureServices(s => services = s);
+
+            if (services == null)
+            {
+                throw new NotSupportedException($"GetServices is not supported on the '{meterProviderBuilder.GetType()}' builder type.");
+            }
+
             return services;
         }
     }

src/OpenTelemetry.Extensions.Hosting/OpenTelemetry.Extensions.Hosting.csproj

@@ -1,13 +1,11 @@
-<Project Sdk="Microsoft.NET.Sdk">
+<Project Sdk="Microsoft.NET.Sdk">
   <PropertyGroup>
     <!-- OmniSharp/VS Code requires TargetFrameworks to be in descending order for IntelliSense and analysis. -->
     <TargetFrameworks>netstandard2.0</TargetFrameworks>
     <Description>Contains extensions to start OpenTelemetry in applications using Microsoft.Extensions.Hosting</Description>
     <RootNamespace>OpenTelemetry</RootNamespace>
     <MinVerTagPrefix>core-</MinVerTagPrefix>
-
-    <!-- this is temporary. will remove in future PR. -->
-    <Nullable>disable</Nullable>
+    <Nullable>enable</Nullable>
   </PropertyGroup>
 
   <!--Do not run ApiCompat for netstandard2.0 as this is newly added. Remove this property once we have released a stable version.-->

src/OpenTelemetry/OpenTelemetryBuilder.cs → src/OpenTelemetry.Extensions.Hosting/OpenTelemetryBuilder.cs

@@ -14,8 +14,6 @@
 // limitations under the License.
 // </copyright>
 
-#nullable enable
-
 using Microsoft.Extensions.DependencyInjection;
 using OpenTelemetry.Internal;
 using OpenTelemetry.Metrics;
@@ -28,7 +26,7 @@ namespace OpenTelemetry;
 /// Contains methods for configuring the OpenTelemetry SDK inside an <see
 /// cref="IServiceCollection"/>.
 /// </summary>
-public class OpenTelemetryBuilder
+public sealed class OpenTelemetryBuilder
 {
     internal OpenTelemetryBuilder(IServiceCollection services)
     {

src/OpenTelemetry.Extensions.Hosting/OpenTelemetryServicesExtensions.cs

@@ -14,8 +14,11 @@
 // limitations under the License.
 // </copyright>
 
+using Microsoft.Extensions.DependencyInjection.Extensions;
 using Microsoft.Extensions.Hosting;
 using OpenTelemetry;
+using OpenTelemetry.Extensions.Hosting.Implementation;
+using OpenTelemetry.Internal;
 using OpenTelemetry.Metrics;
 using OpenTelemetry.Trace;
 
@@ -27,6 +30,29 @@ namespace Microsoft.Extensions.DependencyInjection;
 /// </summary>
 public static class OpenTelemetryServicesExtensions
 {
+    /// <summary>
+    /// Adds OpenTelemetry SDK services into the supplied <see
+    /// cref="IServiceCollection"/>.
+    /// </summary>
+    /// <remarks>
+    /// Note: This is safe to be called multiple times and by library authors.
+    /// Only a single <see cref="TracerProvider"/> and/or <see
+    /// cref="MeterProvider"/> will be created for a given <see
+    /// cref="IServiceCollection"/>.
+    /// </remarks>
+    /// <param name="services"><see cref="IServiceCollection"/>.</param>
+    /// <returns>The supplied <see cref="OpenTelemetryBuilder"/> for chaining
+    /// calls.</returns>
+    public static OpenTelemetryBuilder AddOpenTelemetry(this IServiceCollection services)
+    {
+        Guard.ThrowIfNull(services);
+
+        services.TryAddEnumerable(
+            ServiceDescriptor.Singleton<IHostedService, TelemetryHostedService>());
+
+        return new(services);
+    }
+
     /// <summary>
     /// Configure OpenTelemetry and register a <see cref="IHostedService"/>
     /// to automatically start tracing services in the supplied <see
@@ -51,7 +77,7 @@ public static class OpenTelemetryServicesExtensions
     /// <param name="services"><see cref="IServiceCollection"/>.</param>
     /// <returns>Supplied <see cref="IServiceCollection"/> for chaining
     /// calls.</returns>
-    [Obsolete("Use the AddOpenTelemetry().WithTracing(configure).StartWithHost() pattern instead. This method will be removed in a future version.")]
+    [Obsolete("Use the AddOpenTelemetry().WithTracing(configure) pattern instead. This method will be removed in a future version.")]
     public static IServiceCollection AddOpenTelemetryTracing(this IServiceCollection services)
         => AddOpenTelemetryTracing(services, b => { });
 
@@ -68,10 +94,10 @@ public static IServiceCollection AddOpenTelemetryTracing(this IServiceCollection
     /// cref="TracerProviderBuilder"/>.</param>
     /// <returns>Supplied <see cref="IServiceCollection"/> for chaining
     /// calls.</returns>
-    [Obsolete("Use the AddOpenTelemetry().WithTracing(configure).StartWithHost() pattern instead. This method will be removed in a future version.")]
+    [Obsolete("Use the AddOpenTelemetry().WithTracing(configure) pattern instead. This method will be removed in a future version.")]
     public static IServiceCollection AddOpenTelemetryTracing(this IServiceCollection services, Action<TracerProviderBuilder> configure)
     {
-        services.AddOpenTelemetry().WithTracing(configure).StartWithHost();
+        services.AddOpenTelemetry().WithTracing(configure);
 
         return services;
     }
@@ -100,7 +126,7 @@ public static IServiceCollection AddOpenTelemetryTracing(this IServiceCollection
     /// <param name="services"><see cref="IServiceCollection"/>.</param>
     /// <returns>Supplied <see cref="IServiceCollection"/> for chaining
     /// calls.</returns>
-    [Obsolete("Use the AddOpenTelemetry().WithMetrics(configure).StartWithHost() pattern instead. This method will be removed in a future version.")]
+    [Obsolete("Use the AddOpenTelemetry().WithMetrics(configure) pattern instead. This method will be removed in a future version.")]
     public static IServiceCollection AddOpenTelemetryMetrics(this IServiceCollection services)
         => AddOpenTelemetryMetrics(services, b => { });
 
@@ -117,10 +143,10 @@ public static IServiceCollection AddOpenTelemetryMetrics(this IServiceCollection
     /// cref="TracerProviderBuilder"/>.</param>
     /// <returns>Supplied <see cref="IServiceCollection"/> for chaining
     /// calls.</returns>
-    [Obsolete("Use the AddOpenTelemetry().WithMetrics(configure).StartWithHost() pattern instead. This method will be removed in a future version.")]
+    [Obsolete("Use the AddOpenTelemetry().WithMetrics(configure) pattern instead. This method will be removed in a future version.")]
     public static IServiceCollection AddOpenTelemetryMetrics(this IServiceCollection services, Action<MeterProviderBuilder> configure)
     {
-        services.AddOpenTelemetry().WithMetrics(configure).StartWithHost();
+        services.AddOpenTelemetry().WithMetrics(configure);
 
         return services;
     }

src/OpenTelemetry.Extensions.Hosting/Trace/TracerProviderBuilderExtensions.cs

@@ -15,6 +15,7 @@
 // </copyright>
 
 using Microsoft.Extensions.DependencyInjection;
+using OpenTelemetry.Internal;
 
 namespace OpenTelemetry.Trace
 {
@@ -34,7 +35,12 @@ public static class TracerProviderBuilderExtensions
         [Obsolete("Configure has been replaced by factory extensions. This method will be removed in a future version.")]
         public static TracerProviderBuilder Configure(this TracerProviderBuilder tracerProviderBuilder, Action<IServiceProvider, TracerProviderBuilder> configure)
         {
-            return (tracerProviderBuilder as IDeferredTracerProviderBuilder)?.Configure(configure);
+            if (tracerProviderBuilder is IDeferredTracerProviderBuilder deferredTracerProviderBuilder)
+            {
+                deferredTracerProviderBuilder.Configure(configure);
+            }
+
+            return tracerProviderBuilder;
         }
 
         /// <summary>
@@ -47,8 +53,17 @@ public static TracerProviderBuilder Configure(this TracerProviderBuilder tracerP
         [Obsolete("Call ConfigureServices instead this method will be removed in a future version.")]
         public static IServiceCollection GetServices(this TracerProviderBuilder tracerProviderBuilder)
         {
-            IServiceCollection services = null;
+            Guard.ThrowIfNull(tracerProviderBuilder);
+
+            IServiceCollection? services = null;
+
             tracerProviderBuilder.ConfigureServices(s => services = s);
+
+            if (services == null)
+            {
+                throw new NotSupportedException($"GetServices is not supported on the '{tracerProviderBuilder.GetType()}' builder type.");
+            }
+
             return services;
         }
     }