Rename UseExporter to AddExporter (#1066)

* Rename UseZipkinExporter to AddZipkinExporter

* Rename ZPages exporter extension

* rename jaeger to AddJaeger

* Otlp Exporter rename

* rename extension helper class

* Rename zpages

* comments adressed

* markdwonlint ix
This commit is contained in:
Cijo Thomas 2020-08-13 09:27:00 -07:00 committed by GitHub
parent 4907f69a6d
commit 7f2e672dfa
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
31 changed files with 128 additions and 48 deletions

View File

@ -28,18 +28,18 @@ namespace Examples.AspNet
public class WebApiApplication : HttpApplication
#pragma warning restore SA1649 // File name should match first type name
{
private IDisposable openTelemetry;
private IDisposable tracerProvider;
protected void Application_Start()
{
this.openTelemetry = Sdk.CreateTracerProviderBuilder()
this.tracerProvider = Sdk.CreateTracerProviderBuilder()
.AddHttpClientInstrumentation()
.AddAspNetInstrumentation()
.UseJaegerExporter(c =>
{
c.AgentHost = "localhost";
c.AgentPort = 6831;
})
.AddJaegerExporter(jaegerOptions =>
{
jaegerOptions.AgentHost = "localhost";
jaegerOptions.AgentPort = 6831;
})
.Build();
GlobalConfiguration.Configure(WebApiConfig.Register);
@ -50,7 +50,7 @@ namespace Examples.AspNet
protected void Application_End()
{
this.openTelemetry?.Dispose();
this.tracerProvider?.Dispose();
}
}
}

View File

@ -60,21 +60,21 @@ namespace Examples.AspNetCore
services.AddOpenTelemetry((builder) => builder
.AddAspNetCoreInstrumentation()
.AddHttpClientInstrumentation()
.UseJaegerExporter(o =>
.AddJaegerExporter(jaegerOptions =>
{
o.ServiceName = this.Configuration.GetValue<string>("Jaeger:ServiceName");
o.AgentHost = this.Configuration.GetValue<string>("Jaeger:Host");
o.AgentPort = this.Configuration.GetValue<int>("Jaeger:Port");
jaegerOptions.ServiceName = this.Configuration.GetValue<string>("Jaeger:ServiceName");
jaegerOptions.AgentHost = this.Configuration.GetValue<string>("Jaeger:Host");
jaegerOptions.AgentPort = this.Configuration.GetValue<int>("Jaeger:Port");
}));
break;
case "zipkin":
services.AddOpenTelemetry((builder) => builder
.AddAspNetCoreInstrumentation()
.AddHttpClientInstrumentation()
.UseZipkinExporter(o =>
.AddZipkinExporter(zipkinOptions =>
{
o.ServiceName = this.Configuration.GetValue<string>("Zipkin:ServiceName");
o.Endpoint = new Uri(this.Configuration.GetValue<string>("Zipkin:Endpoint"));
zipkinOptions.ServiceName = this.Configuration.GetValue<string>("Zipkin:ServiceName");
zipkinOptions.Endpoint = new Uri(this.Configuration.GetValue<string>("Zipkin:Endpoint"));
}));
break;
default:

View File

@ -31,7 +31,7 @@ namespace Examples.Console
// and use the Jaeger exporter.
using var openTelemetry = Sdk.CreateTracerProviderBuilder()
.AddSource("Samples.SampleClient", "Samples.SampleServer")
.UseJaegerExporter(o =>
.AddJaegerExporter(o =>
{
o.ServiceName = "jaeger-test";
o.AgentHost = host;

View File

@ -32,7 +32,7 @@ namespace Examples.Console
// and use OTLP exporter.
using var openTelemetry = Sdk.CreateTracerProviderBuilder()
.AddSource("Samples.SampleClient", "Samples.SampleServer")
.UseOtlpExporter(opt => opt.Endpoint = endpoint)
.AddOtlpExporter(opt => opt.Endpoint = endpoint)
.Build();
// The above line is required only in Applications

View File

@ -43,7 +43,7 @@ namespace Examples.Console
// Configure exporter to export traces to Zipkin
using var openTelemetry = Sdk.CreateTracerProviderBuilder()
.UseZipkinExporter(o =>
.AddZipkinExporter(o =>
{
o.ServiceName = "redis-test";
o.Endpoint = new Uri(zipkinUri);

View File

@ -37,7 +37,7 @@ namespace Examples.Console
using var openTelemetry = Sdk.CreateTracerProviderBuilder()
.AddSource("zpages-test")
.AddProcessor(zpagesProcessor)
.UseZPagesExporter()
.AddZPagesExporter()
.Build();
ActivitySource activitySource = new ActivitySource("zpages-test");

View File

@ -35,7 +35,7 @@ namespace Examples.Console
// and use the Zipkin exporter.
using var openTelemetry = Sdk.CreateTracerProviderBuilder()
.AddSource("Samples.SampleClient", "Samples.SampleServer")
.UseZipkinExporter(o =>
.AddZipkinExporter(o =>
{
o.ServiceName = "test-zipkin";
o.Endpoint = new Uri(zipkinUri);

View File

@ -43,7 +43,7 @@ namespace WebApi
services.AddOpenTelemetry((builder) => builder
.AddAspNetCoreInstrumentation()
.AddSource(nameof(MessageSender))
.UseZipkinExporter(b =>
.AddZipkinExporter(b =>
{
var zipkinHostName = Environment.GetEnvironmentVariable("ZIPKIN_HOSTNAME") ?? "localhost";
b.ServiceName = nameof(WebApi);

View File

@ -41,7 +41,7 @@ namespace WorkerService
{
builder
.AddSource(nameof(MessageReceiver))
.UseZipkinExporter(b =>
.AddZipkinExporter(b =>
{
var zipkinHostName = Environment.GetEnvironmentVariable("ZIPKIN_HOSTNAME") ?? "localhost";
b.ServiceName = nameof(WorkerService);

View File

@ -22,7 +22,7 @@ namespace OpenTelemetry.Trace
public static class ConsoleExporterHelperExtensions
{
/// <summary>
/// Registers a ConsoleActivity exporter to a processing pipeline.
/// Adds Console exporter to the TracerProvider.
/// </summary>
/// <param name="builder"><see cref="TracerProviderBuilder"/> builder to use.</param>
/// <param name="configure">Exporter configuration options.</param>

View File

@ -6,6 +6,14 @@
were sent as `CHILD_OF`.
([#970](https://github.com/open-telemetry/opentelemetry-dotnet/pull/970))
* Renamed extension method from `UseJaegerExporter` to `AddJaegerExporter`.
## 0.4.0-beta.2
Released 2020-07-24
* First beta release
## 0.3.0-beta
Released 2020-07-23

View File

@ -1,4 +1,4 @@
// <copyright file="TracerProviderBuilderExtensions.cs" company="OpenTelemetry Authors">
// <copyright file="JaegerExporterHelperExtensions.cs" company="OpenTelemetry Authors">
// Copyright The OpenTelemetry Authors
//
// Licensed under the Apache License, Version 2.0 (the "License");
@ -22,15 +22,15 @@ namespace OpenTelemetry.Trace
/// <summary>
/// Extension methods to simplify registering a Jaeger exporter.
/// </summary>
public static class TracerProviderBuilderExtensions
public static class JaegerExporterHelperExtensions
{
/// <summary>
/// Registers a Jaeger exporter that will receive <see cref="System.Diagnostics.Activity"/> instances.
/// Adds Jaeger exporter to the TracerProvider.
/// </summary>
/// <param name="builder"><see cref="TracerProviderBuilder"/> builder to use.</param>
/// <param name="configure">Exporter configuration options.</param>
/// <returns>The instance of <see cref="TracerProviderBuilder"/> to chain the calls.</returns>
public static TracerProviderBuilder UseJaegerExporter(this TracerProviderBuilder builder, Action<JaegerExporterOptions> configure = null)
public static TracerProviderBuilder AddJaegerExporter(this TracerProviderBuilder builder, Action<JaegerExporterOptions> configure = null)
{
if (builder == null)
{

View File

@ -5,6 +5,14 @@
* Allow configurable gRPC channel options
([#1033](https://github.com/open-telemetry/opentelemetry-dotnet/pull/1033))
* Renamed extension method from `UseOtlpExporter` to `AddOtlpExporter`.
## 0.4.0-beta.2
Released 2020-07-24
* First beta release
## 0.3.0-beta
Released 2020-07-23

View File

@ -1,4 +1,4 @@
// <copyright file="TracerProviderBuilderExtensions.cs" company="OpenTelemetry Authors">
// <copyright file="OtlpExporterHelperExtensions.cs" company="OpenTelemetry Authors">
// Copyright The OpenTelemetry Authors
//
// Licensed under the Apache License, Version 2.0 (the "License");
@ -22,15 +22,15 @@ namespace OpenTelemetry.Trace
/// <summary>
/// Extension methods to simplify registering of the OpenTelemetry Protocol (OTLP) exporter.
/// </summary>
public static class TracerProviderBuilderExtensions
public static class OtlpExporterHelperExtensions
{
/// <summary>
/// Enables the OpenTelemetry Protocol (OTLP) exporter.
/// Adds OpenTelemetry Protocol (OTLP) exporter to the TracerProvider.
/// </summary>
/// <param name="builder">Open Telemetry builder to use.</param>
/// <param name="configure">Exporter configuration options.</param>
/// <returns>The instance of <see cref="TracerProviderBuilder"/> to chain the calls.</returns>
public static TracerProviderBuilder UseOtlpExporter(this TracerProviderBuilder builder, Action<OtlpExporterOptions> configure = null)
public static TracerProviderBuilder AddOtlpExporter(this TracerProviderBuilder builder, Action<OtlpExporterOptions> configure = null)
{
if (builder == null)
{

View File

@ -2,6 +2,12 @@
## Unreleased
## 0.4.0-beta.2
Released 2020-07-24
* First beta release
## 0.3.0-beta
Released 2020-07-23

View File

@ -2,6 +2,14 @@
## Unreleased
Renamed extension method from `UseZPagesExporter` to `AddZPagesExporter`.
## 0.4.0-beta.2
Released 2020-07-24
* First beta release
## 0.3.0-beta
Released 2020-07-23

View File

@ -1,4 +1,4 @@
// <copyright file="TracerProviderBuilderExtensions.cs" company="OpenTelemetry Authors">
// <copyright file="ZPagesExporterHelperExtensions.cs" company="OpenTelemetry Authors">
// Copyright The OpenTelemetry Authors
//
// Licensed under the Apache License, Version 2.0 (the "License");
@ -23,7 +23,7 @@ namespace OpenTelemetry.Trace
/// <summary>
/// Extension methods to simplify registering of Zipkin exporter.
/// </summary>
public static class TracerProviderBuilderExtensions
public static class ZPagesExporterHelperExtensions
{
/// <summary>
/// Registers a Zipkin exporter that will receive <see cref="System.Diagnostics.Activity"/> instances.
@ -31,7 +31,7 @@ namespace OpenTelemetry.Trace
/// <param name="builder"><see cref="TracerProviderBuilder"/> builder to use.</param>
/// <param name="configure">Exporter configuration options.</param>
/// <returns>The instance of <see cref="TracerProviderBuilder"/> to chain the calls.</returns>
public static TracerProviderBuilder UseZPagesExporter(
public static TracerProviderBuilder AddZPagesExporter(
this TracerProviderBuilder builder,
Action<ZPagesExporterOptions> configure = null)
{

View File

@ -2,6 +2,14 @@
## Unreleased
Renamed extension method from `UseZipkinExporter` to `AddZipkinExporter`.
## 0.4.0-beta.2
Released 2020-07-24
* First beta release
## 0.3.0-beta
Released 2020-07-23

View File

@ -1,4 +1,4 @@
// <copyright file="TracerProviderBuilderExtensions.cs" company="OpenTelemetry Authors">
// <copyright file="ZipkinExporterHelperExtensions.cs" company="OpenTelemetry Authors">
// Copyright The OpenTelemetry Authors
//
// Licensed under the Apache License, Version 2.0 (the "License");
@ -22,15 +22,15 @@ namespace OpenTelemetry.Trace
/// <summary>
/// Extension methods to simplify registering of Zipkin exporter.
/// </summary>
public static class TracerProviderBuilderExtensions
public static class ZipkinExporterHelperExtensions
{
/// <summary>
/// Registers a Zipkin exporter that will receive <see cref="System.Diagnostics.Activity"/> instances.
/// Adds Zipkin exporter to the TracerProvider.
/// </summary>
/// <param name="builder"><see cref="TracerProviderBuilder"/> builder to use.</param>
/// <param name="configure">Exporter configuration options.</param>
/// <returns>The instance of <see cref="TracerProviderBuilder"/> to chain the calls.</returns>
public static TracerProviderBuilder UseZipkinExporter(this TracerProviderBuilder builder, Action<ZipkinExporterOptions> configure = null)
public static TracerProviderBuilder AddZipkinExporter(this TracerProviderBuilder builder, Action<ZipkinExporterOptions> configure = null)
{
if (builder == null)
{

View File

@ -2,6 +2,12 @@
## Unreleased
## 0.4.0-beta.2
Released 2020-07-24
* First beta release
## 0.3.0-beta
Released 2020-07-23

View File

@ -2,6 +2,12 @@
## Unreleased
## 0.4.0-beta.2
Released 2020-07-24
* First beta release
## 0.3.0-beta
Released 2020-07-23

View File

@ -10,6 +10,12 @@
is created for the underlying HTTP call in the event both gRPC and HTTP
instrumentation are enabled.
## 0.4.0-beta.2
Released 2020-07-24
* First beta release
## 0.3.0-beta
Released 2020-07-23

View File

@ -2,6 +2,12 @@
## Unreleased
## 0.4.0-beta.2
Released 2020-07-24
* First beta release
## 0.3.0-beta
Released 2020-07-23

View File

@ -4,6 +4,12 @@
* Renamed from `AddSqlClientDependencyInstrumentation` to `AddSqlClientInstrumentation`
## 0.4.0-beta.2
Released 2020-07-24
* First beta release
## 0.3.0-beta
Released 2020-07-23

View File

@ -2,6 +2,12 @@
## Unreleased
## 0.4.0-beta.2
Released 2020-07-24
* First beta release
## 0.3.0-beta
Released 2020-07-23

View File

@ -21,7 +21,7 @@ using var connection = ConnectionMultiplexer.Connect("localhost:6379");
// Pass the connection to AddRedisInstrumentation.
using var openTelemetry = Sdk.CreateTracerProvider(b => b
.AddRedisInstrumentation(connection)
.UseZipkinExporter()
.AddZipkinExporter()
.SetResource(Resources.CreateServiceResource("my-service"));
```

View File

@ -2,6 +2,12 @@
## Unreleased
## 0.4.0-beta.2
Released 2020-07-24
* First beta release
## 0.3.0-beta
Released 2020-07-23

View File

@ -30,7 +30,7 @@ namespace OpenTelemetry.Exporter.Jaeger.Tests
public void JaegerExporter_BadArgs()
{
TracerProviderBuilder builder = null;
Assert.Throws<ArgumentNullException>(() => builder.UseJaegerExporter());
Assert.Throws<ArgumentNullException>(() => builder.AddJaegerExporter());
}
[Fact]
@ -57,7 +57,7 @@ namespace OpenTelemetry.Exporter.Jaeger.Tests
var openTelemetrySdk = Sdk.CreateTracerProviderBuilder()
.AddSource(ActivitySourceName)
.AddProcessor(testActivityProcessor)
.UseJaegerExporter()
.AddJaegerExporter()
.Build();
var source = new ActivitySource(ActivitySourceName);

View File

@ -52,7 +52,7 @@ namespace OpenTelemetry.Exporter.OpenTelemetryProtocol.Tests
public void OtlpExporter_BadArgs()
{
TracerProviderBuilder builder = null;
Assert.Throws<ArgumentNullException>(() => builder.UseOtlpExporter());
Assert.Throws<ArgumentNullException>(() => builder.AddOtlpExporter());
}
[Fact]
@ -262,7 +262,7 @@ namespace OpenTelemetry.Exporter.OpenTelemetryProtocol.Tests
var openTelemetrySdk = Sdk.CreateTracerProviderBuilder()
.AddSource(ActivitySourceName)
.AddProcessor(testActivityProcessor)
.UseOtlpExporter()
.AddOtlpExporter()
.Build();
var source = new ActivitySource(ActivitySourceName);

View File

@ -49,7 +49,7 @@ namespace OpenTelemetry.Exporter.ZPages.Tests
public void ZPagesExporter_BadArgs()
{
TracerProviderBuilder builder = null;
Assert.Throws<ArgumentNullException>(() => builder.UseZPagesExporter());
Assert.Throws<ArgumentNullException>(() => builder.AddZPagesExporter());
}
[Fact]
@ -90,7 +90,7 @@ namespace OpenTelemetry.Exporter.ZPages.Tests
var openTelemetrySdk = Sdk.CreateTracerProviderBuilder()
.AddSource(ActivitySourceName)
.AddProcessor(testActivityProcessor)
.UseZPagesExporter()
.AddZPagesExporter()
.Build();
var source = new ActivitySource(ActivitySourceName);
@ -132,7 +132,7 @@ namespace OpenTelemetry.Exporter.ZPages.Tests
using var openTelemetrySdk = Sdk.CreateTracerProviderBuilder()
.AddSource(ActivitySourceName)
.AddProcessor(zpagesProcessor)
.UseZPagesExporter()
.AddZPagesExporter()
.Build();
var source = new ActivitySource(ActivitySourceName);

View File

@ -88,7 +88,7 @@ namespace OpenTelemetry.Exporter.Zipkin.Tests
public void ZipkinExporter_BadArgs()
{
TracerProviderBuilder builder = null;
Assert.Throws<ArgumentNullException>(() => builder.UseZipkinExporter());
Assert.Throws<ArgumentNullException>(() => builder.AddZipkinExporter());
}
[Theory]
@ -160,7 +160,7 @@ namespace OpenTelemetry.Exporter.Zipkin.Tests
var openTelemetrySdk = Sdk.CreateTracerProviderBuilder()
.AddSource(ActivitySourceName)
.AddProcessor(testActivityProcessor)
.UseZipkinExporter(o =>
.AddZipkinExporter(o =>
{
o.ServiceName = "test-zipkin";
o.Endpoint = new Uri($"http://{this.testServerHost}:{this.testServerPort}/api/v2/spans?requestId={requestId}");