Renaming to AddOpenTelemetryTracing (#1209)

* AspNet Instrumentation docs

* Renaming to AddOpenTelemetryTracing

* Revert "AspNet Instrumentation docs"

This reverts commit 4cbb620533.

* typo

* changelog entry
This commit is contained in:
Cijo Thomas 2020-08-31 17:32:29 -07:00 committed by GitHub
parent f679960e03
commit fd7876416f
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
8 changed files with 26 additions and 24 deletions

View File

@ -57,7 +57,7 @@ namespace Examples.AspNetCore
switch (exporter)
{
case "jaeger":
services.AddOpenTelemetryTracerProvider((builder) => builder
services.AddOpenTelemetryTracing((builder) => builder
.AddAspNetCoreInstrumentation()
.AddHttpClientInstrumentation()
.AddJaegerExporter(jaegerOptions =>
@ -68,7 +68,7 @@ namespace Examples.AspNetCore
}));
break;
case "zipkin":
services.AddOpenTelemetryTracerProvider((builder) => builder
services.AddOpenTelemetryTracing((builder) => builder
.AddAspNetCoreInstrumentation()
.AddHttpClientInstrumentation()
.AddZipkinExporter(zipkinOptions =>
@ -78,7 +78,7 @@ namespace Examples.AspNetCore
}));
break;
default:
services.AddOpenTelemetryTracerProvider((builder) => builder
services.AddOpenTelemetryTracing((builder) => builder
.AddAspNetCoreInstrumentation()
.AddHttpClientInstrumentation()
.AddConsoleExporter());

View File

@ -40,7 +40,7 @@ namespace WebApi
services.AddSingleton<MessageSender>();
services.AddOpenTelemetryTracerProvider((builder) => builder
services.AddOpenTelemetryTracing((builder) => builder
.AddAspNetCoreInstrumentation()
.AddSource(nameof(MessageSender))
.AddZipkinExporter(b =>

View File

@ -37,7 +37,7 @@ namespace WorkerService
services.AddSingleton<MessageReceiver>();
services.AddOpenTelemetryTracerProvider((builder) =>
services.AddOpenTelemetryTracing((builder) =>
{
builder
.AddSource(nameof(MessageReceiver))

View File

@ -2,6 +2,8 @@
## Unreleased
* Renamed all extension methods from AddOpenTelemetryTracerProvider to AddOpenTelemetryTracing
## 0.5.0-beta.2
Released 2020-08-28

View File

@ -46,13 +46,13 @@ namespace OpenTelemetry.Extensions.Hosting.Implementation
}
}
[Event(1, Message = "Failed to initialize: '{0}'. OpenTelemetry will not work.", Level = EventLevel.Error)]
[Event(1, Message = "An exception occurred while adding OpenTelemetry Tracing to ServiceCollection. OpenTelemetry tracing will not work. Exception: '{0}'.", Level = EventLevel.Error)]
public void FailedInitialize(string exception)
{
this.WriteEvent(1, exception);
}
[Event(2, Message = "Failed to get OpenTelemetrySDK: '{0}'. OpenTelemetry will not work.", Level = EventLevel.Error)]
[Event(2, Message = "An exception occurred while retrieving OpenTelemetry Tracer from Service Provider. OpenTelemetry tracing will not work. Exception: '{0}'.", Level = EventLevel.Error)]
public void FailedOpenTelemetrySDK(string exception)
{
this.WriteEvent(2, exception);

View File

@ -33,9 +33,9 @@ namespace Microsoft.Extensions.DependencyInjection
/// </summary>
/// <param name="services">The <see cref="IServiceCollection" /> to add services to.</param>
/// <returns>The <see cref="IServiceCollection"/> so that additional calls can be chained.</returns>
public static IServiceCollection AddOpenTelemetryTracerProvider(this IServiceCollection services)
public static IServiceCollection AddOpenTelemetryTracing(this IServiceCollection services)
{
services.AddOpenTelemetryTracerProvider(builder => { });
services.AddOpenTelemetryTracing(builder => { });
return services;
}
@ -45,7 +45,7 @@ namespace Microsoft.Extensions.DependencyInjection
/// <param name="services">The <see cref="IServiceCollection" /> to add services to.</param>
/// <param name="configure">The <see cref="TracerProviderBuilder"/> action to configure TracerProviderBuilder.</param>
/// <returns>The <see cref="IServiceCollection"/> so that additional calls can be chained.</returns>
public static IServiceCollection AddOpenTelemetryTracerProvider(this IServiceCollection services, Action<TracerProviderBuilder> configure)
public static IServiceCollection AddOpenTelemetryTracing(this IServiceCollection services, Action<TracerProviderBuilder> configure)
{
if (configure is null)
{
@ -54,7 +54,7 @@ namespace Microsoft.Extensions.DependencyInjection
var builder = Sdk.CreateTracerProviderBuilder();
configure(builder);
services.AddOpenTelemetryTracerProvider(() => builder.Build());
services.AddOpenTelemetryTracing(() => builder.Build());
return services;
}
@ -64,7 +64,7 @@ namespace Microsoft.Extensions.DependencyInjection
/// <param name="services">The <see cref="IServiceCollection" /> to add services to.</param>
/// <param name="configure">The <see cref="TracerProviderBuilder"/> action to configure TracerProviderBuilder.</param>
/// <returns>The <see cref="IServiceCollection"/> so that additional calls can be chained.</returns>
public static IServiceCollection AddOpenTelemetryTracerProvider(this IServiceCollection services, Action<IServiceProvider, TracerProviderBuilder> configure)
public static IServiceCollection AddOpenTelemetryTracing(this IServiceCollection services, Action<IServiceProvider, TracerProviderBuilder> configure)
{
if (configure is null)
{
@ -72,7 +72,7 @@ namespace Microsoft.Extensions.DependencyInjection
}
var builder = Sdk.CreateTracerProviderBuilder();
services.AddOpenTelemetryTracerProvider((sp) =>
services.AddOpenTelemetryTracing((sp) =>
{
configure(sp, builder);
return builder.Build();
@ -86,7 +86,7 @@ namespace Microsoft.Extensions.DependencyInjection
/// <param name="services">The <see cref="IServiceCollection" /> to add services to.</param>
/// <param name="createTracerProvider">A delegate that provides the tracer provider to be registered.</param>
/// <returns>The <see cref="IServiceCollection"/> so that additional calls can be chained.</returns>
public static IServiceCollection AddOpenTelemetryTracerProvider(this IServiceCollection services, Func<TracerProvider> createTracerProvider)
public static IServiceCollection AddOpenTelemetryTracing(this IServiceCollection services, Func<TracerProvider> createTracerProvider)
{
if (services is null)
{
@ -101,7 +101,7 @@ namespace Microsoft.Extensions.DependencyInjection
try
{
services.AddSingleton(s => createTracerProvider());
AddOpenTelemetryInternal(services);
AddOpenTelemetryTracingInternal(services);
}
catch (Exception ex)
{
@ -117,7 +117,7 @@ namespace Microsoft.Extensions.DependencyInjection
/// <param name="services">The <see cref="IServiceCollection" /> to add services to.</param>
/// <param name="createTracerProvider">A delegate that provides the tracer provider to be registered.</param>
/// <returns>The <see cref="IServiceCollection"/> so that additional calls can be chained.</returns>
public static IServiceCollection AddOpenTelemetryTracerProvider(this IServiceCollection services, Func<IServiceProvider, TracerProvider> createTracerProvider)
public static IServiceCollection AddOpenTelemetryTracing(this IServiceCollection services, Func<IServiceProvider, TracerProvider> createTracerProvider)
{
if (services is null)
{
@ -132,7 +132,7 @@ namespace Microsoft.Extensions.DependencyInjection
try
{
services.AddSingleton(s => createTracerProvider(s));
AddOpenTelemetryInternal(services);
AddOpenTelemetryTracingInternal(services);
}
catch (Exception ex)
{
@ -142,7 +142,7 @@ namespace Microsoft.Extensions.DependencyInjection
return services;
}
private static void AddOpenTelemetryInternal(IServiceCollection services)
private static void AddOpenTelemetryTracingInternal(IServiceCollection services)
{
services.TryAddEnumerable(ServiceDescriptor.Singleton<IHostedService, TelemetryHostedService>());
}

View File

@ -33,7 +33,7 @@ namespace OpenTelemetry.Extensions.Hosting
var builder = new HostBuilder().ConfigureServices(services =>
{
services.AddOpenTelemetryTracerProvider(builder =>
services.AddOpenTelemetryTracing(builder =>
{
builder.AddInstrumentation((activitySource) =>
{
@ -70,7 +70,7 @@ namespace OpenTelemetry.Extensions.Hosting
{
var builder = new HostBuilder().ConfigureServices(services =>
{
services.AddOpenTelemetryTracerProvider();
services.AddOpenTelemetryTracing();
});
var host = builder.Build();
@ -88,7 +88,7 @@ namespace OpenTelemetry.Extensions.Hosting
var services = new ServiceCollection();
services.AddSingleton(testInstrumentation);
services.AddOpenTelemetryTracerProvider((provider, builder) =>
services.AddOpenTelemetryTracing((provider, builder) =>
{
builder.AddInstrumentation((activitySource) => provider.GetRequiredService<TestInstrumentation>());
});
@ -109,9 +109,9 @@ namespace OpenTelemetry.Extensions.Hosting
public void AddOpenTelemetryTracerProvider_BadArgs_NullServiceCollection()
{
ServiceCollection services = null;
Assert.Throws<ArgumentNullException>(() => services.AddOpenTelemetryTracerProvider());
Assert.Throws<ArgumentNullException>(() => services.AddOpenTelemetryTracing());
Assert.Throws<ArgumentNullException>(() =>
services.AddOpenTelemetryTracerProvider((provider, builder) =>
services.AddOpenTelemetryTracing((provider, builder) =>
{
builder.AddInstrumentation((activitySource) => provider.GetRequiredService<TestInstrumentation>());
}));

View File

@ -61,7 +61,7 @@ namespace OpenTelemetry.Instrumentation.AspNetCore.Tests
builder.ConfigureTestServices((IServiceCollection services) =>
{
services.AddSingleton<CallbackMiddleware.CallbackMiddlewareImpl>(new TestCallbackMiddlewareImpl(statusCode, reasonPhrase));
services.AddOpenTelemetryTracerProvider((builder) => builder.AddAspNetCoreInstrumentation()
services.AddOpenTelemetryTracing((builder) => builder.AddAspNetCoreInstrumentation()
.AddProcessor(processor.Object));
}))
.CreateClient())