diff --git a/src/OpenTelemetry.Extensions.Hosting/README.md b/src/OpenTelemetry.Extensions.Hosting/README.md index 6b907b55792..7be08606c52 100644 --- a/src/OpenTelemetry.Extensions.Hosting/README.md +++ b/src/OpenTelemetry.Extensions.Hosting/README.md @@ -21,8 +21,6 @@ and metrics (`MeterProvider`) in [ASP.NET ## Extension method reference -### Current OpenTelemetry SDK v1.4.0 and newer extensions - Targeting `Microsoft.Extensions.DependencyInjection.IServiceCollection`: * `AddOpenTelemetry`: Registers an @@ -59,35 +57,6 @@ Targeting `Microsoft.Extensions.DependencyInjection.IServiceCollection`: * `WithMetrics`: Enables metrics and optionally configures the `MeterProvider`. -### Obsolete OpenTelemetry SDK pre-1.4.0 extensions - -> **Note** -> The below extension methods should be called by application host code -only. Library authors see: [Registration extension method guidance for library -authors](../../docs/trace/extending-the-sdk/README.md#registration-extension-method-guidance-for-library-authors). - -> **Note** -> Multiple calls to the below extensions will **NOT** result in multiple -providers. To establish multiple providers use the -`Sdk.CreateTracerProviderBuilder()` and/or `Sdk.CreateMeterProviderBuilder()` -methods. See [TracerProvider -configuration](../../docs/trace/customizing-the-sdk/README.md#tracerprovider-configuration) -and [Building a -MeterProvider](../../docs/metrics/customizing-the-sdk/README.md#building-a-meterprovider) -for more details. - -Targeting `Microsoft.Extensions.DependencyInjection.IServiceCollection`: - -* `AddOpenTelemetryTracing`: Configure OpenTelemetry and register an - [IHostedService](https://learn.microsoft.com/dotnet/api/microsoft.extensions.hosting.ihostedservice) - to automatically start tracing services in the supplied - [IServiceCollection](https://learn.microsoft.com/dotnet/api/microsoft.extensions.dependencyinjection.iservicecollection). - -* `AddOpenTelemetryMetrics`: Configure OpenTelemetry and register an - [IHostedService](https://learn.microsoft.com/dotnet/api/microsoft.extensions.hosting.ihostedservice) - to automatically start metric services in the supplied - [IServiceCollection](https://learn.microsoft.com/dotnet/api/microsoft.extensions.dependencyinjection.iservicecollection). - ## Usage The following example shows how to register OpenTelemetry tracing & metrics in @@ -111,6 +80,32 @@ var app = appBuilder.Build(); app.Run(); ``` +A fully functional example can be found +[here](https://github.com/open-telemetry/opentelemetry-dotnet/tree/main/examples/AspNetCore). + +## Migrating from pre-release versions of OpenTelemetry.Extensions.Hosting + +Pre-release versions (all versions prior to 1.4.0) of +`OpenTelemetry.Extenions.Hosting` contained signal-specific methods for +configuring tracing and metrics: + +* `AddOpenTelemetryTracing`: Configure OpenTelemetry and register an + [IHostedService](https://learn.microsoft.com/dotnet/api/microsoft.extensions.hosting.ihostedservice) + to automatically start tracing services in the supplied + [IServiceCollection](https://learn.microsoft.com/dotnet/api/microsoft.extensions.dependencyinjection.iservicecollection). + +* `AddOpenTelemetryMetrics`: Configure OpenTelemetry and register an + [IHostedService](https://learn.microsoft.com/dotnet/api/microsoft.extensions.hosting.ihostedservice) + to automatically start metric services in the supplied + [IServiceCollection](https://learn.microsoft.com/dotnet/api/microsoft.extensions.dependencyinjection.iservicecollection). + +These methods were marked obsolete and later removed. You should migrate your +code to the new `AddOpenTelemetry` method documented above. Refer the +[old](https://github.com/open-telemetry/opentelemetry-dotnet/blob/core-1.3.2/examples/AspNetCore/Program.cs) +and +[new](https://github.com/open-telemetry/opentelemetry-dotnet/tree/main/examples/AspNetCore) +versions of the example application to assist you in your migration. + ## References * [OpenTelemetry Project](https://opentelemetry.io/)