Added Exporter type to Zipkin exporter options

src/OpenTelemetry.Exporter.Zipkin/.publicApi/net452/PublicAPI.Unshipped.txt

@@ -1,7 +1,11 @@
 OpenTelemetry.Exporter.Zipkin.ZipkinExporter
 OpenTelemetry.Exporter.Zipkin.ZipkinExporterOptions
+OpenTelemetry.Exporter.Zipkin.ZipkinExporterOptions.BatchExportProcessorOptions.get -> OpenTelemetry.BatchExportProcessorOptions<System.Diagnostics.Activity>
+OpenTelemetry.Exporter.Zipkin.ZipkinExporterOptions.BatchExportProcessorOptions.set -> void
 OpenTelemetry.Exporter.Zipkin.ZipkinExporterOptions.Endpoint.get -> System.Uri
 OpenTelemetry.Exporter.Zipkin.ZipkinExporterOptions.Endpoint.set -> void
+OpenTelemetry.Exporter.Zipkin.ZipkinExporterOptions.ExportProcessorType.get -> OpenTelemetry.ExportProcessorType
+OpenTelemetry.Exporter.Zipkin.ZipkinExporterOptions.ExportProcessorType.set -> void
 OpenTelemetry.Exporter.Zipkin.ZipkinExporterOptions.ServiceName.get -> string
 OpenTelemetry.Exporter.Zipkin.ZipkinExporterOptions.ServiceName.set -> void
 OpenTelemetry.Exporter.Zipkin.ZipkinExporterOptions.UseShortTraceIds.get -> bool

src/OpenTelemetry.Exporter.Zipkin/.publicApi/net461/PublicAPI.Unshipped.txt

@@ -1,7 +1,11 @@
 OpenTelemetry.Exporter.Zipkin.ZipkinExporter
 OpenTelemetry.Exporter.Zipkin.ZipkinExporterOptions
+OpenTelemetry.Exporter.Zipkin.ZipkinExporterOptions.BatchExportProcessorOptions.get -> OpenTelemetry.BatchExportProcessorOptions<System.Diagnostics.Activity>
+OpenTelemetry.Exporter.Zipkin.ZipkinExporterOptions.BatchExportProcessorOptions.set -> void
 OpenTelemetry.Exporter.Zipkin.ZipkinExporterOptions.Endpoint.get -> System.Uri
 OpenTelemetry.Exporter.Zipkin.ZipkinExporterOptions.Endpoint.set -> void
+OpenTelemetry.Exporter.Zipkin.ZipkinExporterOptions.ExportProcessorType.get -> OpenTelemetry.ExportProcessorType
+OpenTelemetry.Exporter.Zipkin.ZipkinExporterOptions.ExportProcessorType.set -> void
 OpenTelemetry.Exporter.Zipkin.ZipkinExporterOptions.MaxPayloadSizeInBytes.get -> int?
 OpenTelemetry.Exporter.Zipkin.ZipkinExporterOptions.MaxPayloadSizeInBytes.set -> void
 OpenTelemetry.Exporter.Zipkin.ZipkinExporterOptions.ServiceName.get -> string

src/OpenTelemetry.Exporter.Zipkin/.publicApi/netstandard2.0/PublicAPI.Unshipped.txt

@@ -1,7 +1,11 @@
 OpenTelemetry.Exporter.Zipkin.ZipkinExporter
 OpenTelemetry.Exporter.Zipkin.ZipkinExporterOptions
+OpenTelemetry.Exporter.Zipkin.ZipkinExporterOptions.BatchExportProcessorOptions.get -> OpenTelemetry.BatchExportProcessorOptions<System.Diagnostics.Activity>
+OpenTelemetry.Exporter.Zipkin.ZipkinExporterOptions.BatchExportProcessorOptions.set -> void
 OpenTelemetry.Exporter.Zipkin.ZipkinExporterOptions.Endpoint.get -> System.Uri
 OpenTelemetry.Exporter.Zipkin.ZipkinExporterOptions.Endpoint.set -> void
+OpenTelemetry.Exporter.Zipkin.ZipkinExporterOptions.ExportProcessorType.get -> OpenTelemetry.ExportProcessorType
+OpenTelemetry.Exporter.Zipkin.ZipkinExporterOptions.ExportProcessorType.set -> void
 OpenTelemetry.Exporter.Zipkin.ZipkinExporterOptions.MaxPayloadSizeInBytes.get -> int?
 OpenTelemetry.Exporter.Zipkin.ZipkinExporterOptions.MaxPayloadSizeInBytes.set -> void
 OpenTelemetry.Exporter.Zipkin.ZipkinExporterOptions.ServiceName.get -> string

src/OpenTelemetry.Exporter.Zipkin/CHANGELOG.md

@@ -2,6 +2,8 @@
 
 ## Unreleased
 
+* Added ExportProcessorType to exporter options
+  ([#1504](https://github.com/open-telemetry/opentelemetry-dotnet/pull/1504))
 * Zipkin tags used for InstrumentationLibrary changed from library.name,
   library.version to otel.library.name, otel.library.version respectively.
 * Sending `service.namespace` as Zipkin tag.

src/OpenTelemetry.Exporter.Zipkin/ZipkinExporterHelperExtensions.cs

@@ -43,8 +43,19 @@ public static TracerProviderBuilder AddZipkinExporter(this TracerProviderBuilder
             configure?.Invoke(exporterOptions);
             var zipkinExporter = new ZipkinExporter(exporterOptions);
 
-            // TODO: Pick Simple vs Batching based on ZipkinExporterOptions
-            return builder.AddProcessor(new BatchExportProcessor<Activity>(zipkinExporter));
+            if (exporterOptions.ExportProcessorType == ExportProcessorType.Simple)
+            {
+                return builder.AddProcessor(new SimpleExportProcessor<Activity>(zipkinExporter));
+            }
+            else
+            {
+                return builder.AddProcessor(new BatchExportProcessor<Activity>(
+                    zipkinExporter,
+                    exporterOptions.BatchExportProcessorOptions.MaxQueueSize,
+                    exporterOptions.BatchExportProcessorOptions.ScheduledDelayMilliseconds,
+                    exporterOptions.BatchExportProcessorOptions.ExporterTimeoutMilliseconds,
+                    exporterOptions.BatchExportProcessorOptions.MaxExportBatchSize));
+            }
         }
     }
 }

src/OpenTelemetry.Exporter.Zipkin/ZipkinExporterOptions.cs

@@ -15,6 +15,7 @@
 // </copyright>
 
 using System;
+using System.Diagnostics;
 
 namespace OpenTelemetry.Exporter.Zipkin
 {
@@ -51,5 +52,15 @@ public sealed class ZipkinExporterOptions
         /// </summary>
         public int? MaxPayloadSizeInBytes { get; set; } = DefaultMaxPayloadSizeInBytes;
 #endif
+
+        /// <summary>
+        /// Gets or sets the export processor type to be used with Zipkin Exporter.
+        /// </summary>
+        public ExportProcessorType ExportProcessorType { get; set; } = ExportProcessorType.Batch;
+
+        /// <summary>
+        /// Gets or sets the BatchExportProcessor options. Ignored unless ExportProcessorType is BatchExporter.
+        /// </summary>
+        public BatchExportProcessorOptions<Activity> BatchExportProcessorOptions { get; set; } = new BatchExportProcessorOptions<Activity>();
     }
 }

src/OpenTelemetry/.publicApi/net452/PublicAPI.Unshipped.txt

@@ -22,9 +22,22 @@ OpenTelemetry.Batch<T>.Enumerator.Reset() -> void
 OpenTelemetry.Batch<T>.GetEnumerator() -> OpenTelemetry.Batch<T>.Enumerator
 OpenTelemetry.BatchExportProcessor<T>
 OpenTelemetry.BatchExportProcessor<T>.BatchExportProcessor(OpenTelemetry.BaseExporter<T> exporter, int maxQueueSize = 2048, int scheduledDelayMilliseconds = 5000, int exporterTimeoutMilliseconds = 30000, int maxExportBatchSize = 512) -> void
+OpenTelemetry.BatchExportProcessorOptions<T>
+OpenTelemetry.BatchExportProcessorOptions<T>.BatchExportProcessorOptions() -> void
+OpenTelemetry.BatchExportProcessorOptions<T>.ExporterTimeoutMilliseconds.get -> int
+OpenTelemetry.BatchExportProcessorOptions<T>.ExporterTimeoutMilliseconds.set -> void
+OpenTelemetry.BatchExportProcessorOptions<T>.MaxExportBatchSize.get -> int
+OpenTelemetry.BatchExportProcessorOptions<T>.MaxExportBatchSize.set -> void
+OpenTelemetry.BatchExportProcessorOptions<T>.MaxQueueSize.get -> int
+OpenTelemetry.BatchExportProcessorOptions<T>.MaxQueueSize.set -> void
+OpenTelemetry.BatchExportProcessorOptions<T>.ScheduledDelayMilliseconds.get -> int
+OpenTelemetry.BatchExportProcessorOptions<T>.ScheduledDelayMilliseconds.set -> void
 OpenTelemetry.CompositeProcessor<T>
 OpenTelemetry.CompositeProcessor<T>.AddProcessor(OpenTelemetry.BaseProcessor<T> processor) -> OpenTelemetry.CompositeProcessor<T>
 OpenTelemetry.CompositeProcessor<T>.CompositeProcessor(System.Collections.Generic.IEnumerable<OpenTelemetry.BaseProcessor<T>> processors) -> void
+OpenTelemetry.ExportProcessorType
+OpenTelemetry.ExportProcessorType.Batch = 1 -> OpenTelemetry.ExportProcessorType
+OpenTelemetry.ExportProcessorType.Simple = 0 -> OpenTelemetry.ExportProcessorType
 OpenTelemetry.ExportResult
 OpenTelemetry.ExportResult.Failure = 1 -> OpenTelemetry.ExportResult
 OpenTelemetry.ExportResult.Success = 0 -> OpenTelemetry.ExportResult

src/OpenTelemetry/.publicApi/net46/PublicAPI.Unshipped.txt

@@ -22,9 +22,22 @@ OpenTelemetry.Batch<T>.Enumerator.Reset() -> void
 OpenTelemetry.Batch<T>.GetEnumerator() -> OpenTelemetry.Batch<T>.Enumerator
 OpenTelemetry.BatchExportProcessor<T>
 OpenTelemetry.BatchExportProcessor<T>.BatchExportProcessor(OpenTelemetry.BaseExporter<T> exporter, int maxQueueSize = 2048, int scheduledDelayMilliseconds = 5000, int exporterTimeoutMilliseconds = 30000, int maxExportBatchSize = 512) -> void
+OpenTelemetry.BatchExportProcessorOptions<T>
+OpenTelemetry.BatchExportProcessorOptions<T>.BatchExportProcessorOptions() -> void
+OpenTelemetry.BatchExportProcessorOptions<T>.ExporterTimeoutMilliseconds.get -> int
+OpenTelemetry.BatchExportProcessorOptions<T>.ExporterTimeoutMilliseconds.set -> void
+OpenTelemetry.BatchExportProcessorOptions<T>.MaxExportBatchSize.get -> int
+OpenTelemetry.BatchExportProcessorOptions<T>.MaxExportBatchSize.set -> void
+OpenTelemetry.BatchExportProcessorOptions<T>.MaxQueueSize.get -> int
+OpenTelemetry.BatchExportProcessorOptions<T>.MaxQueueSize.set -> void
+OpenTelemetry.BatchExportProcessorOptions<T>.ScheduledDelayMilliseconds.get -> int
+OpenTelemetry.BatchExportProcessorOptions<T>.ScheduledDelayMilliseconds.set -> void
 OpenTelemetry.CompositeProcessor<T>
 OpenTelemetry.CompositeProcessor<T>.AddProcessor(OpenTelemetry.BaseProcessor<T> processor) -> OpenTelemetry.CompositeProcessor<T>
 OpenTelemetry.CompositeProcessor<T>.CompositeProcessor(System.Collections.Generic.IEnumerable<OpenTelemetry.BaseProcessor<T>> processors) -> void
+OpenTelemetry.ExportProcessorType
+OpenTelemetry.ExportProcessorType.Batch = 1 -> OpenTelemetry.ExportProcessorType
+OpenTelemetry.ExportProcessorType.Simple = 0 -> OpenTelemetry.ExportProcessorType
 OpenTelemetry.ExportResult
 OpenTelemetry.ExportResult.Failure = 1 -> OpenTelemetry.ExportResult
 OpenTelemetry.ExportResult.Success = 0 -> OpenTelemetry.ExportResult

src/OpenTelemetry/.publicApi/net461/PublicAPI.Unshipped.txt

@@ -23,9 +23,22 @@ OpenTelemetry.Batch<T>.Enumerator.Reset() -> void
 OpenTelemetry.Batch<T>.GetEnumerator() -> OpenTelemetry.Batch<T>.Enumerator
 OpenTelemetry.BatchExportProcessor<T>
 OpenTelemetry.BatchExportProcessor<T>.BatchExportProcessor(OpenTelemetry.BaseExporter<T> exporter, int maxQueueSize = 2048, int scheduledDelayMilliseconds = 5000, int exporterTimeoutMilliseconds = 30000, int maxExportBatchSize = 512) -> void
+OpenTelemetry.BatchExportProcessorOptions<T>
+OpenTelemetry.BatchExportProcessorOptions<T>.BatchExportProcessorOptions() -> void
+OpenTelemetry.BatchExportProcessorOptions<T>.ExporterTimeoutMilliseconds.get -> int
+OpenTelemetry.BatchExportProcessorOptions<T>.ExporterTimeoutMilliseconds.set -> void
+OpenTelemetry.BatchExportProcessorOptions<T>.MaxExportBatchSize.get -> int
+OpenTelemetry.BatchExportProcessorOptions<T>.MaxExportBatchSize.set -> void
+OpenTelemetry.BatchExportProcessorOptions<T>.MaxQueueSize.get -> int
+OpenTelemetry.BatchExportProcessorOptions<T>.MaxQueueSize.set -> void
+OpenTelemetry.BatchExportProcessorOptions<T>.ScheduledDelayMilliseconds.get -> int
+OpenTelemetry.BatchExportProcessorOptions<T>.ScheduledDelayMilliseconds.set -> void
 OpenTelemetry.CompositeProcessor<T>
 OpenTelemetry.CompositeProcessor<T>.AddProcessor(OpenTelemetry.BaseProcessor<T> processor) -> OpenTelemetry.CompositeProcessor<T>
 OpenTelemetry.CompositeProcessor<T>.CompositeProcessor(System.Collections.Generic.IEnumerable<OpenTelemetry.BaseProcessor<T>> processors) -> void
+OpenTelemetry.ExportProcessorType
+OpenTelemetry.ExportProcessorType.Batch = 1 -> OpenTelemetry.ExportProcessorType
+OpenTelemetry.ExportProcessorType.Simple = 0 -> OpenTelemetry.ExportProcessorType
 OpenTelemetry.ExportResult
 OpenTelemetry.ExportResult.Failure = 1 -> OpenTelemetry.ExportResult
 OpenTelemetry.ExportResult.Success = 0 -> OpenTelemetry.ExportResult

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

@@ -23,9 +23,22 @@ OpenTelemetry.Batch<T>.Enumerator.Reset() -> void
 OpenTelemetry.Batch<T>.GetEnumerator() -> OpenTelemetry.Batch<T>.Enumerator
 OpenTelemetry.BatchExportProcessor<T>
 OpenTelemetry.BatchExportProcessor<T>.BatchExportProcessor(OpenTelemetry.BaseExporter<T> exporter, int maxQueueSize = 2048, int scheduledDelayMilliseconds = 5000, int exporterTimeoutMilliseconds = 30000, int maxExportBatchSize = 512) -> void
+OpenTelemetry.BatchExportProcessorOptions<T>
+OpenTelemetry.BatchExportProcessorOptions<T>.BatchExportProcessorOptions() -> void
+OpenTelemetry.BatchExportProcessorOptions<T>.ExporterTimeoutMilliseconds.get -> int
+OpenTelemetry.BatchExportProcessorOptions<T>.ExporterTimeoutMilliseconds.set -> void
+OpenTelemetry.BatchExportProcessorOptions<T>.MaxExportBatchSize.get -> int
+OpenTelemetry.BatchExportProcessorOptions<T>.MaxExportBatchSize.set -> void
+OpenTelemetry.BatchExportProcessorOptions<T>.MaxQueueSize.get -> int
+OpenTelemetry.BatchExportProcessorOptions<T>.MaxQueueSize.set -> void
+OpenTelemetry.BatchExportProcessorOptions<T>.ScheduledDelayMilliseconds.get -> int
+OpenTelemetry.BatchExportProcessorOptions<T>.ScheduledDelayMilliseconds.set -> void
 OpenTelemetry.CompositeProcessor<T>
 OpenTelemetry.CompositeProcessor<T>.AddProcessor(OpenTelemetry.BaseProcessor<T> processor) -> OpenTelemetry.CompositeProcessor<T>
 OpenTelemetry.CompositeProcessor<T>.CompositeProcessor(System.Collections.Generic.IEnumerable<OpenTelemetry.BaseProcessor<T>> processors) -> void
+OpenTelemetry.ExportProcessorType
+OpenTelemetry.ExportProcessorType.Batch = 1 -> OpenTelemetry.ExportProcessorType
+OpenTelemetry.ExportProcessorType.Simple = 0 -> OpenTelemetry.ExportProcessorType
 OpenTelemetry.ExportResult
 OpenTelemetry.ExportResult.Failure = 1 -> OpenTelemetry.ExportResult
 OpenTelemetry.ExportResult.Success = 0 -> OpenTelemetry.ExportResult

src/OpenTelemetry/BatchExportProcessor.cs

@@ -28,6 +28,11 @@ namespace OpenTelemetry
     public class BatchExportProcessor<T> : BaseExportProcessor<T>
         where T : class
     {
+        internal const int DefaultMaxQueueSize = 2048;
+        internal const int DefaultScheduledDelayMilliseconds = 5000;
+        internal const int DefaultExporterTimeoutMilliseconds = 30000;
+        internal const int DefaultMaxExportBatchSize = 512;
+
         private readonly CircularBuffer<T> circularBuffer;
         private readonly int scheduledDelayMilliseconds;
         private readonly int exporterTimeoutMilliseconds;
@@ -49,10 +54,10 @@ public class BatchExportProcessor<T> : BaseExportProcessor<T>
         /// <param name="maxExportBatchSize">The maximum batch size of every export. It must be smaller or equal to maxQueueSize. The default value is 512.</param>
         public BatchExportProcessor(
             BaseExporter<T> exporter,
-            int maxQueueSize = 2048,
-            int scheduledDelayMilliseconds = 5000,
-            int exporterTimeoutMilliseconds = 30000,
-            int maxExportBatchSize = 512)
+            int maxQueueSize = DefaultMaxQueueSize,
+            int scheduledDelayMilliseconds = DefaultScheduledDelayMilliseconds,
+            int exporterTimeoutMilliseconds = DefaultExporterTimeoutMilliseconds,
+            int maxExportBatchSize = DefaultMaxExportBatchSize)
             : base(exporter)
         {
             if (maxQueueSize <= 0)

src/OpenTelemetry/BatchExportProcessorOptions.cs

@@ -0,0 +1,47 @@
+// <copyright file="BatchExportProcessorOptions.cs" company="OpenTelemetry Authors">
+// Copyright The OpenTelemetry Authors
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+// </copyright>
+
+using System;
+using System.Diagnostics;
+using System.Threading;
+using OpenTelemetry.Internal;
+
+namespace OpenTelemetry
+{
+    public class BatchExportProcessorOptions<T>
+        where T : class
+    {
+        /// <summary>
+        /// Gets or sets the maximum queue size. The queue drops the data if the maximum size is reached. The default value is 2048.
+        /// </summary>
+        public int MaxQueueSize { get; set; } = BatchExportProcessor<T>.DefaultMaxQueueSize;
+
+        /// <summary>
+        /// Gets or sets the delay interval (in milliseconds) between two consecutive exports. The default value is 5000.
+        /// </summary>
+        public int ScheduledDelayMilliseconds { get; set; } = BatchExportProcessor<T>.DefaultScheduledDelayMilliseconds;
+
+        /// <summary>
+        /// Gets or sets the timeout (in milliseconds) after which the export is cancelled. The default value is 30000.
+        /// </summary>
+        public int ExporterTimeoutMilliseconds { get; set; } = BatchExportProcessor<T>.DefaultExporterTimeoutMilliseconds;
+
+        /// <summary>
+        /// Gets or sets the maximum batch size of every export. It must be smaller or equal to MaxQueueLength. The default value is 512.
+        /// </summary>
+        public int MaxExportBatchSize { get; set; } = BatchExportProcessor<T>.DefaultMaxExportBatchSize;
+    }
+}

src/OpenTelemetry/ExportProcessorType.cs

@@ -0,0 +1,38 @@
+// <copyright file="ExportProcessorType.cs" company="OpenTelemetry Authors">
+// Copyright The OpenTelemetry Authors
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+// </copyright>
+
+namespace OpenTelemetry
+{
+    /// <summary>
+    /// Type of Export Processor to be used.
+    /// </summary>
+    public enum ExportProcessorType
+    {
+        /// <summary>
+        /// Use SimpleExportProcessor.
+        /// Refer to the <a href="https://github.com/open-telemetry/opentelemetry-specification/blob/master/specification/trace/sdk.md#simple-processor">
+        /// specification</a> for more information.
+        /// </summary>
+        Simple,
+
+        /// <summary>
+        /// Use BatchExportProcessor.
+        /// Refer to <a href="https://github.com/open-telemetry/opentelemetry-specification/blob/master/specification/trace/sdk.md#batching-processor">
+        /// specification</a> for more information.
+        /// </summary>
+        Batch,
+    }
+}