rename AddActivitySource to AddSource, use params (#1036)

open-telemetry · Aug 11, 2020 · ce0bf3f · ce0bf3f
1 parent 8af9b32
commit ce0bf3f
Show file tree

Hide file tree

Showing 31 changed files with 102 additions and 111 deletions.
diff --git a/docs/trace/building-your-own-exporter/Program.cs b/docs/trace/building-your-own-exporter/Program.cs
@@ -25,7 +25,7 @@ public class Program
     public static void Main()
     {
         using var tracerProvider = Sdk.CreateTracerProviderBuilder()
-            .AddActivitySource("MyCompany.MyProduct.MyLibrary")
+            .AddSource("MyCompany.MyProduct.MyLibrary")
             .AddMyExporter()
             .Build();
 

diff --git a/docs/trace/building-your-own-processor/Program.cs b/docs/trace/building-your-own-processor/Program.cs
@@ -26,7 +26,7 @@ public class Program
     public static void Main()
     {
         using var tracerProvider = Sdk.CreateTracerProviderBuilder()
-            .AddActivitySource("MyCompany.MyProduct.MyLibrary")
+            .AddSource("MyCompany.MyProduct.MyLibrary")
             .AddProcessor(new MyActivityProcessor("A"))
             .AddProcessor(new MyActivityProcessor("B"))
             .Build();

diff --git a/docs/trace/building-your-own-sampler/Program.cs b/docs/trace/building-your-own-sampler/Program.cs
@@ -27,7 +27,7 @@ public class Program
     public static void Main()
     {
         using var tracerProvider = Sdk.CreateTracerProviderBuilder()
-            .AddActivitySource("MyCompany.MyProduct.MyLibrary")
+            .AddSource("MyCompany.MyProduct.MyLibrary")
             .SetSampler(new MySampler())
             .AddProcessor(new SimpleActivityProcessor(new ConsoleExporter(new ConsoleExporterOptions())))
             .Build();

diff --git a/docs/trace/getting-started/Program.cs b/docs/trace/getting-started/Program.cs
@@ -27,7 +27,7 @@ public class Program
     public static void Main()
     {
         using var tracerProvider = Sdk.CreateTracerProviderBuilder()
-            .AddActivitySource("MyCompany.MyProduct.MyLibrary")
+            .AddSource("MyCompany.MyProduct.MyLibrary")
             .AddProcessor(new SimpleActivityProcessor(new ConsoleExporter(new ConsoleExporterOptions())))
             .Build();
 

diff --git a/examples/Console/TestConsoleExporter.cs b/examples/Console/TestConsoleExporter.cs
@@ -30,7 +30,8 @@ internal static object Run(ConsoleOptions options)
         {
             // Enable TracerProvider for the source "MyCompany.MyProduct.MyWebServer"
             // and use a custom MyProcessor, along with Console exporter.
-            using var tracerProvider = Sdk.CreateTracerProviderBuilder().AddActivitySource("MyCompany.MyProduct.MyWebServer")
+            using var tracerProvider = Sdk.CreateTracerProviderBuilder()
+                .AddSource("MyCompany.MyProduct.MyWebServer")
                 .SetResource(Resources.CreateServiceResource("MyServiceName"))
                 .AddProcessor(new MyProcessor()) // This must be added before ConsoleExporter
                 .UseConsoleExporter(opt => opt.DisplayAsJson = options.DisplayAsJson)

diff --git a/examples/Console/TestHttpClient.cs b/examples/Console/TestHttpClient.cs
@@ -30,7 +30,7 @@ internal static object Run()
             using var openTelemetry = Sdk.CreateTracerProviderBuilder()
                 .AddHttpClientInstrumentation()
                 .SetResource(Resources.CreateServiceResource("http-service-example"))
-                .AddActivitySource("http-client-test")
+                .AddSource("http-client-test")
                 .UseConsoleExporter(opt => opt.DisplayAsJson = false)
                 .Build();
 

diff --git a/examples/Console/TestJaegerExporter.cs b/examples/Console/TestJaegerExporter.cs
@@ -30,8 +30,7 @@ internal static object RunWithActivity(string host, int port)
             // Enable OpenTelemetry for the sources "Samples.SampleServer" and "Samples.SampleClient"
             // and use the Jaeger exporter.
             using var openTelemetry = Sdk.CreateTracerProviderBuilder()
-                    .AddActivitySource("Samples.SampleServer")
-                    .AddActivitySource("Samples.SampleClient")
+                    .AddSource("Samples.SampleClient", "Samples.SampleServer")
                     .UseJaegerExporter(o =>
                     {
                         o.ServiceName = "jaeger-test";

diff --git a/examples/Console/TestOTelShimWithConsoleExporter.cs b/examples/Console/TestOTelShimWithConsoleExporter.cs
@@ -27,7 +27,7 @@ internal static object Run(OpenTelemetryShimOptions options)
             // Enable OpenTelemetry for the source "MyCompany.MyProduct.MyWebServer"
             // and use a single pipeline with a custom MyProcessor, and Console exporter.
             using var tracerProvider = Sdk.CreateTracerProviderBuilder()
-                    .AddActivitySource("MyCompany.MyProduct.MyWebServer")
+                    .AddSource("MyCompany.MyProduct.MyWebServer")
                     .SetResource(Resources.CreateServiceResource("MyServiceName"))
                     .UseConsoleExporter(opt => opt.DisplayAsJson = options.DisplayAsJson)
                     .Build();

diff --git a/examples/Console/TestOpenTracingWithConsoleExporter.cs b/examples/Console/TestOpenTracingWithConsoleExporter.cs
@@ -30,7 +30,7 @@ internal static object Run(OpenTracingShimOptions options)
             // Enable OpenTelemetry for the source "MyCompany.MyProduct.MyWebServer"
             // and use Console exporter.
             using var openTelemetry = Sdk.CreateTracerProviderBuilder()
-                    .AddActivitySource("MyCompany.MyProduct.MyWebServer")
+                    .AddSource("MyCompany.MyProduct.MyWebServer")
                     .SetResource(Resources.CreateServiceResource("MyServiceName"))
                     .UseConsoleExporter(opt => opt.DisplayAsJson = options.DisplayAsJson)
                     .Build();

diff --git a/examples/Console/TestOtlpExporter.cs b/examples/Console/TestOtlpExporter.cs
@@ -31,8 +31,7 @@ private static object RunWithActivitySource(string endpoint)
             // Enable OpenTelemetry for the sources "Samples.SampleServer" and "Samples.SampleClient"
             // and use OTLP exporter.
             using var openTelemetry = Sdk.CreateTracerProviderBuilder()
-                    .AddActivitySource("Samples.SampleServer")
-                    .AddActivitySource("Samples.SampleClient")
+                    .AddSource("Samples.SampleClient", "Samples.SampleServer")
                     .UseOtlpExporter(opt => opt.Endpoint = endpoint)
                     .Build();
 

diff --git a/examples/Console/TestRedis.cs b/examples/Console/TestRedis.cs
@@ -53,7 +53,7 @@ internal static object Run(string zipkinUri)
                         // changing flushinterval from 10s to 5s
                         options.FlushInterval = TimeSpan.FromSeconds(5);
                     })
-                    .AddActivitySource("redis-test")
+                    .AddSource("redis-test")
                     .Build();
 
             ActivitySource activitySource = new ActivitySource("redis-test");

diff --git a/examples/Console/TestZPagesExporter.cs b/examples/Console/TestZPagesExporter.cs
@@ -35,7 +35,7 @@ internal static object Run()
             httpServer.Start();
 
             using var openTelemetry = Sdk.CreateTracerProviderBuilder()
-                    .AddActivitySource("zpages-test")
+                    .AddSource("zpages-test")
                     .AddProcessor(zpagesProcessor)
                     .UseZPagesExporter()
                     .Build();

diff --git a/examples/Console/TestZipkinExporter.cs b/examples/Console/TestZipkinExporter.cs
@@ -34,8 +34,7 @@ internal static object Run(string zipkinUri)
             // Enable OpenTelemetry for the sources "Samples.SampleServer" and "Samples.SampleClient"
             // and use the Zipkin exporter.
             using var openTelemetry = Sdk.CreateTracerProviderBuilder()
-                    .AddActivitySource("Samples.SampleServer")
-                    .AddActivitySource("Samples.SampleClient")
+                    .AddSource("Samples.SampleClient", "Samples.SampleServer")
                     .UseZipkinExporter(o =>
                     {
                         o.ServiceName = "test-zipkin";

diff --git a/examples/MicroserviceExample/WebApi/Startup.cs b/examples/MicroserviceExample/WebApi/Startup.cs
@@ -42,7 +42,7 @@ public void ConfigureServices(IServiceCollection services)
 
             services.AddOpenTelemetry((builder) => builder
                 .AddAspNetCoreInstrumentation()
-                .AddActivitySource(nameof(MessageSender))
+                .AddSource(nameof(MessageSender))
                 .UseZipkinExporter(b =>
                 {
                     var zipkinHostName = Environment.GetEnvironmentVariable("ZIPKIN_HOSTNAME") ?? "localhost";

diff --git a/examples/MicroserviceExample/WorkerService/Program.cs b/examples/MicroserviceExample/WorkerService/Program.cs
@@ -40,7 +40,7 @@ public static IHostBuilder CreateHostBuilder(string[] args) =>
                     services.AddOpenTelemetry((builder) =>
                     {
                         builder
-                            .AddActivitySource(nameof(MessageReceiver))
+                            .AddSource(nameof(MessageReceiver))
                             .UseZipkinExporter(b =>
                             {
                                 var zipkinHostName = Environment.GetEnvironmentVariable("ZIPKIN_HOSTNAME") ?? "localhost";

diff --git a/src/OpenTelemetry.Instrumentation.Http/TracerProviderBuilderExtensions.cs b/src/OpenTelemetry.Instrumentation.Http/TracerProviderBuilderExtensions.cs
@@ -79,7 +79,7 @@ internal static TracerProviderBuilder AddHttpWebRequestInstrumentation(
 
             HttpWebRequestActivitySource.Options = options;
 
-            builder.AddActivitySource(HttpWebRequestActivitySource.ActivitySourceName);
+            builder.AddSource(HttpWebRequestActivitySource.ActivitySourceName);
 
             return builder;
         }

diff --git a/src/OpenTelemetry.Instrumentation.SqlClient/TracerProviderBuilderExtensions.cs b/src/OpenTelemetry.Instrumentation.SqlClient/TracerProviderBuilderExtensions.cs
@@ -44,7 +44,7 @@ public static TracerProviderBuilder AddSqlClientInstrumentation(
             configureSqlClientInstrumentationOptions?.Invoke(sqlOptions);
 
             builder.AddInstrumentation((activitySource) => new SqlClientInstrumentation(sqlOptions));
-            builder.AddActivitySource(SqlClientDiagnosticListener.ActivitySourceName);
+            builder.AddSource(SqlClientDiagnosticListener.ActivitySourceName);
 
             return builder;
         }

diff --git a/src/OpenTelemetry.Instrumentation.StackExchangeRedis/TracerProviderBuilderExtensions.cs b/src/OpenTelemetry.Instrumentation.StackExchangeRedis/TracerProviderBuilderExtensions.cs
@@ -47,7 +47,7 @@ public static TracerProviderBuilder AddRedisInstrumentation(
 
             return builder
                 .AddInstrumentation((activitySourceAdapter) => new StackExchangeRedisCallsInstrumentation(connection, options))
-                .AddActivitySource(StackExchangeRedisCallsInstrumentation.ActivitySourceName);
+                .AddSource(StackExchangeRedisCallsInstrumentation.ActivitySourceName);
         }
     }
 }
diff --git a/src/OpenTelemetry/Trace/TracerProviderBuilder.cs b/src/OpenTelemetry/Trace/TracerProviderBuilder.cs
@@ -61,40 +61,28 @@ public TracerProviderBuilder SetResource(Resource resource)
             return this;
         }
 
-        /// <summary>
-        /// Adds given activitysource name to the list of subscribed sources.
-        /// </summary>
-        /// <param name="name">Activity source name.</param>
-        /// <returns>Returns <see cref="TracerProviderBuilder"/> for chaining.</returns>
-        public TracerProviderBuilder AddActivitySource(string name)
-        {
-            if (string.IsNullOrWhiteSpace(name))
-            {
-                throw new ArgumentException($"{nameof(name)} is null or whitespace.");
-            }
-
-            // TODO: We need to fix the listening model.
-            // Today it ignores version.
-            this.sources.Add(name);
-
-            return this;
-        }
-
         /// <summary>
         /// Adds given activitysource names to the list of subscribed sources.
         /// </summary>
         /// <param name="names">Activity source names.</param>
         /// <returns>Returns <see cref="TracerProviderBuilder"/> for chaining.</returns>
-        public TracerProviderBuilder AddActivitySource(IEnumerable<string> names)
+        public TracerProviderBuilder AddSource(params string[] names)
         {
             if (names == null)
             {
                 throw new ArgumentNullException(nameof(names));
             }
 
             foreach (var name in names)
-            {
-                this.AddActivitySource(name);
+            {
+                if (string.IsNullOrWhiteSpace(name))
+                {
+                    throw new ArgumentException($"{nameof(names)} contains null or whitespace string.");
+                }
+
+                // TODO: We need to fix the listening model.
+                // Today it ignores version.
+                this.sources.Add(name);
             }
 
             return this;

diff --git a/test/Benchmarks/OpenTelemetrySdkBenchmarks.cs b/test/Benchmarks/OpenTelemetrySdkBenchmarks.cs
@@ -31,11 +31,15 @@ public class OpenTelemetrySdkBenchmarks
 
         public OpenTelemetrySdkBenchmarks()
         {
-            using var openTelemetryAlwaysOnSample = Sdk.CreateTracerProviderBuilder().AddActivitySource("AlwaysOnSample")
-                .SetSampler(new AlwaysOnSampler()).Build();
-
-            using var openTelemetryAlwaysOffSample = Sdk.CreateTracerProviderBuilder().AddActivitySource("AlwaysOffSample")
-                .SetSampler(new AlwaysOffSampler()).Build();
+            using var openTelemetryAlwaysOnSample = Sdk.CreateTracerProviderBuilder()
+                .AddSource("AlwaysOnSample")
+                .SetSampler(new AlwaysOnSampler())
+                .Build();
+
+            using var openTelemetryAlwaysOffSample = Sdk.CreateTracerProviderBuilder()
+                .AddSource("AlwaysOffSample")
+                .SetSampler(new AlwaysOffSampler())
+                .Build();
 
             using var openTelemetryNoop = Sdk.CreateTracerProviderBuilder().Build();
 

diff --git a/test/Benchmarks/OpenTelemetrySdkBenchmarksActivity.cs b/test/Benchmarks/OpenTelemetrySdkBenchmarksActivity.cs
@@ -31,7 +31,9 @@ public class OpenTelemetrySdkBenchmarksActivity
         public OpenTelemetrySdkBenchmarksActivity()
         {
             // Not configuring pipeline, which will result in default NoopActivityProcessor.
-            var openTel = Sdk.CreateTracerProviderBuilder().AddActivitySource("BenchMark");
+            var openTel = Sdk.CreateTracerProviderBuilder()
+                .AddSource("BenchMark")
+                .Build();
         }
 
         [Benchmark]

diff --git a/test/OpenTelemetry.Exporter.Jaeger.Tests/JaegerExporterTests.cs b/test/OpenTelemetry.Exporter.Jaeger.Tests/JaegerExporterTests.cs
@@ -55,7 +55,7 @@ public void UseJaegerExporterWithCustomActivityProcessor()
                 };
 
             var openTelemetrySdk = Sdk.CreateTracerProviderBuilder()
-                .AddActivitySource(ActivitySourceName)
+                .AddSource(ActivitySourceName)
                 .AddProcessor(testActivityProcessor)
                 .UseJaegerExporter()
                 .Build();

diff --git a/test/OpenTelemetry.Exporter.OpenTelemetryProtocol.Tests/OtlpExporterTest.cs b/test/OpenTelemetry.Exporter.OpenTelemetryProtocol.Tests/OtlpExporterTest.cs
@@ -74,8 +74,8 @@ public void ToOtlpResourceSpansTest()
 
             // This following is done just to set Resource to Activity.
             using var openTelemetrySdk = Sdk.CreateTracerProviderBuilder()
-                .AddActivitySource(sources[0].Name)
-                .AddActivitySource(sources[1].Name)
+                .AddSource(sources[0].Name)
+                .AddSource(sources[1].Name)
                 .SetResource(resource)
                 .Build();
 
@@ -260,7 +260,7 @@ public void UseOpenTelemetryProtocolActivityExporterWithCustomActivityProcessor(
                 };
 
             var openTelemetrySdk = Sdk.CreateTracerProviderBuilder()
-                            .AddActivitySource(ActivitySourceName)
+                            .AddSource(ActivitySourceName)
                             .AddProcessor(testActivityProcessor)
                             .UseOtlpExporter()
                             .Build();

diff --git a/test/OpenTelemetry.Exporter.ZPages.Tests/ZPagesExporterTests.cs b/test/OpenTelemetry.Exporter.ZPages.Tests/ZPagesExporterTests.cs
@@ -88,10 +88,10 @@ public void ZPagesExporter_CustomActivityProcessor()
                 };
 
             var openTelemetrySdk = Sdk.CreateTracerProviderBuilder()
-                            .AddActivitySource(ActivitySourceName)
-                            .AddProcessor(testActivityProcessor)
-                            .UseZPagesExporter()
-                            .Build();
+                .AddSource(ActivitySourceName)
+                .AddProcessor(testActivityProcessor)
+                .UseZPagesExporter()
+                .Build();
 
             var source = new ActivitySource(ActivitySourceName);
             var activity = source.StartActivity("Test Zipkin Activity");
@@ -130,7 +130,7 @@ public void ZPagesExporter_ZPagesProcessor()
             var zpagesProcessor = new ZPagesProcessor(exporter);
 
             using var openTelemetrySdk = Sdk.CreateTracerProviderBuilder()
-                            .AddActivitySource(ActivitySourceName)
+                            .AddSource(ActivitySourceName)
                             .AddProcessor(zpagesProcessor)
                             .UseZPagesExporter()
                             .Build();

diff --git a/test/OpenTelemetry.Exporter.Zipkin.Tests/ZipkinExporterTests.cs b/test/OpenTelemetry.Exporter.Zipkin.Tests/ZipkinExporterTests.cs
@@ -158,15 +158,14 @@ public void UseZipkinExporterWithCustomActivityProcessor()
                 };
 
             var openTelemetrySdk = Sdk.CreateTracerProviderBuilder()
-                            .AddActivitySource(ActivitySourceName)
-                            .AddProcessor(testActivityProcessor)
-                            .UseZipkinExporter(
-                                o =>
-                            {
-                                o.ServiceName = "test-zipkin";
-                                o.Endpoint = new Uri($"http://{this.testServerHost}:{this.testServerPort}/api/v2/spans?requestId={requestId}");
-                            })
-                            .Build();
+                .AddSource(ActivitySourceName)
+                .AddProcessor(testActivityProcessor)
+                .UseZipkinExporter(o =>
+                {
+                    o.ServiceName = "test-zipkin";
+                    o.Endpoint = new Uri($"http://{this.testServerHost}:{this.testServerPort}/api/v2/spans?requestId={requestId}");
+                })
+                .Build();
 
             var source = new ActivitySource(ActivitySourceName);
             var activity = source.StartActivity("Test Zipkin Activity");

diff --git a/test/OpenTelemetry.Tests/Implementation/Trace/ActivityExtensionsTest.cs b/test/OpenTelemetry.Tests/Implementation/Trace/ActivityExtensionsTest.cs
@@ -28,7 +28,7 @@ public class ActivityExtensionsTest
         public void SetStatus()
         {
             using var openTelemetrySdk = Sdk.CreateTracerProviderBuilder()
-                .AddActivitySource(ActivitySourceName)
+                .AddSource(ActivitySourceName)
                 .Build();
 
             using var source = new ActivitySource(ActivitySourceName);
@@ -43,7 +43,7 @@ public void SetStatus()
         public void SetStatusWithDescription()
         {
             using var openTelemetrySdk = Sdk.CreateTracerProviderBuilder()
-                .AddActivitySource(ActivitySourceName)
+                .AddSource(ActivitySourceName)
                 .Build();
 
             using var source = new ActivitySource(ActivitySourceName);
@@ -60,7 +60,7 @@ public void SetStatusWithDescription()
         public void SetCancelledStatus()
         {
             using var openTelemetrySdk = Sdk.CreateTracerProviderBuilder()
-                .AddActivitySource(ActivitySourceName)
+                .AddSource(ActivitySourceName)
                 .Build();
 
             using var source = new ActivitySource(ActivitySourceName);
@@ -75,7 +75,7 @@ public void SetCancelledStatus()
         public void GetStatusWithNoStatusInActivity()
         {
             using var openTelemetrySdk = Sdk.CreateTracerProviderBuilder()
-                .AddActivitySource(ActivitySourceName)
+                .AddSource(ActivitySourceName)
                 .Build();
 
             using var source = new ActivitySource(ActivitySourceName);
@@ -89,7 +89,7 @@ public void GetStatusWithNoStatusInActivity()
         public void LastSetStatusWins()
         {
             using var openTelemetrySdk = Sdk.CreateTracerProviderBuilder()
-                .AddActivitySource(ActivitySourceName)
+                .AddSource(ActivitySourceName)
                 .Build();
 
             using var source = new ActivitySource(ActivitySourceName);