chore: Move to BatchLogRecordExportProcessorOptions and PeriodicExportingMetricReaderOptions

This avoids introducing a potentially ambiguous constructor, restores the original shipped API signatures.

Author: jeromelaban

src/OpenTelemetry/.publicApi/Stable/PublicAPI.Shipped.txt

@@ -31,9 +31,9 @@ OpenTelemetry.Batch<T>.Enumerator.Enumerator() -> void
 OpenTelemetry.Batch<T>.Enumerator.MoveNext() -> bool
 OpenTelemetry.Batch<T>.Enumerator.Reset() -> void
 OpenTelemetry.BatchActivityExportProcessor
-OpenTelemetry.BatchActivityExportProcessor.BatchActivityExportProcessor(OpenTelemetry.BaseExporter<System.Diagnostics.Activity!>! exporter, int maxQueueSize, int scheduledDelayMilliseconds, int exporterTimeoutMilliseconds, int maxExportBatchSize) -> void
+OpenTelemetry.BatchActivityExportProcessor.BatchActivityExportProcessor(OpenTelemetry.BaseExporter<System.Diagnostics.Activity!>! exporter, int maxQueueSize = 2048, int scheduledDelayMilliseconds = 5000, int exporterTimeoutMilliseconds = 30000, int maxExportBatchSize = 512) -> void
 OpenTelemetry.BatchExportProcessor<T>
-OpenTelemetry.BatchExportProcessor<T>.BatchExportProcessor(OpenTelemetry.BaseExporter<T!>! exporter, int maxQueueSize, int scheduledDelayMilliseconds, int exporterTimeoutMilliseconds, int maxExportBatchSize) -> void
+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
@@ -45,7 +45,7 @@ OpenTelemetry.BatchExportProcessorOptions<T>.MaxQueueSize.set -> void
 OpenTelemetry.BatchExportProcessorOptions<T>.ScheduledDelayMilliseconds.get -> int
 OpenTelemetry.BatchExportProcessorOptions<T>.ScheduledDelayMilliseconds.set -> void
 OpenTelemetry.BatchLogRecordExportProcessor
-OpenTelemetry.BatchLogRecordExportProcessor.BatchLogRecordExportProcessor(OpenTelemetry.BaseExporter<OpenTelemetry.Logs.LogRecord!>! exporter, int maxQueueSize, int scheduledDelayMilliseconds, int exporterTimeoutMilliseconds, int maxExportBatchSize) -> void
+OpenTelemetry.BatchLogRecordExportProcessor.BatchLogRecordExportProcessor(OpenTelemetry.BaseExporter<OpenTelemetry.Logs.LogRecord!>! exporter, int maxQueueSize = 2048, int scheduledDelayMilliseconds = 5000, int exporterTimeoutMilliseconds = 30000, int maxExportBatchSize = 512) -> 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
@@ -256,7 +256,7 @@ OpenTelemetry.Metrics.MetricType.LongSum = 26 -> OpenTelemetry.Metrics.MetricTyp
 OpenTelemetry.Metrics.MetricType.LongSumNonMonotonic = 138 -> OpenTelemetry.Metrics.MetricType
 OpenTelemetry.Metrics.MetricTypeExtensions
 OpenTelemetry.Metrics.PeriodicExportingMetricReader
-OpenTelemetry.Metrics.PeriodicExportingMetricReader.PeriodicExportingMetricReader(OpenTelemetry.BaseExporter<OpenTelemetry.Metrics.Metric!>! exporter, int exportIntervalMilliseconds, int exportTimeoutMilliseconds) -> void
+OpenTelemetry.Metrics.PeriodicExportingMetricReader.PeriodicExportingMetricReader(OpenTelemetry.BaseExporter<OpenTelemetry.Metrics.Metric!>! exporter, int exportIntervalMilliseconds = 60000, int exportTimeoutMilliseconds = 30000) -> void
 OpenTelemetry.Metrics.PeriodicExportingMetricReaderOptions
 OpenTelemetry.Metrics.PeriodicExportingMetricReaderOptions.ExportIntervalMilliseconds.get -> int?
 OpenTelemetry.Metrics.PeriodicExportingMetricReaderOptions.ExportIntervalMilliseconds.set -> void

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

@@ -1,4 +1,8 @@
-OpenTelemetry.BatchActivityExportProcessor.BatchActivityExportProcessor(OpenTelemetry.BaseExporter<System.Diagnostics.Activity!>! exporter, int maxQueueSize = 2048, int scheduledDelayMilliseconds = 5000, int exporterTimeoutMilliseconds = 30000, int maxExportBatchSize = 512, bool useThreads = true) -> void
-OpenTelemetry.BatchExportProcessor<T>.BatchExportProcessor(OpenTelemetry.BaseExporter<T!>! exporter, int maxQueueSize = 2048, int scheduledDelayMilliseconds = 5000, int exporterTimeoutMilliseconds = 30000, int maxExportBatchSize = 512, bool useThreads = true) -> void
-OpenTelemetry.BatchLogRecordExportProcessor.BatchLogRecordExportProcessor(OpenTelemetry.BaseExporter<OpenTelemetry.Logs.LogRecord!>! exporter, int maxQueueSize = 2048, int scheduledDelayMilliseconds = 5000, int exporterTimeoutMilliseconds = 30000, int maxExportBatchSize = 512, bool useThreads = true) -> void
-OpenTelemetry.Metrics.PeriodicExportingMetricReader.PeriodicExportingMetricReader(OpenTelemetry.BaseExporter<OpenTelemetry.Metrics.Metric!>! exporter, int exportIntervalMilliseconds = 60000, int exportTimeoutMilliseconds = 30000, bool useThreads = true) -> void
+OpenTelemetry.BatchActivityExportProcessor.BatchActivityExportProcessor(OpenTelemetry.BaseExporter<System.Diagnostics.Activity!>! exporter, OpenTelemetry.BatchExportProcessorOptions<System.Diagnostics.Activity!>! options) -> void
+OpenTelemetry.BatchExportProcessor<T>.BatchExportProcessor(OpenTelemetry.BaseExporter<T!>! exporter, OpenTelemetry.BatchExportProcessorOptions<T!>! options) -> void
+OpenTelemetry.BatchExportProcessorOptions<T>.UseThreads.get -> bool
+OpenTelemetry.BatchExportProcessorOptions<T>.UseThreads.set -> void
+OpenTelemetry.BatchLogRecordExportProcessor.BatchLogRecordExportProcessor(OpenTelemetry.BaseExporter<OpenTelemetry.Logs.LogRecord!>! exporter, OpenTelemetry.BatchExportProcessorOptions<OpenTelemetry.Logs.LogRecord!>! options) -> void
+OpenTelemetry.Metrics.PeriodicExportingMetricReader.PeriodicExportingMetricReader(OpenTelemetry.BaseExporter<OpenTelemetry.Metrics.Metric!>! exporter, OpenTelemetry.Metrics.PeriodicExportingMetricReaderOptions! options) -> void
+OpenTelemetry.Metrics.PeriodicExportingMetricReaderOptions.UseThreads.get -> bool
+OpenTelemetry.Metrics.PeriodicExportingMetricReaderOptions.UseThreads.set -> void

src/OpenTelemetry/BatchExportProcessor.cs

@@ -39,42 +39,44 @@ public abstract 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>
     protected BatchExportProcessor(
         BaseExporter<T> exporter,
-        int maxQueueSize,
-        int scheduledDelayMilliseconds,
-        int exporterTimeoutMilliseconds,
-        int maxExportBatchSize)
-        : this(exporter, maxQueueSize, scheduledDelayMilliseconds, exporterTimeoutMilliseconds, maxExportBatchSize, true)
+        int maxQueueSize = DefaultMaxQueueSize,
+        int scheduledDelayMilliseconds = DefaultScheduledDelayMilliseconds,
+        int exporterTimeoutMilliseconds = DefaultExporterTimeoutMilliseconds,
+        int maxExportBatchSize = DefaultMaxExportBatchSize)
+        : this(exporter, new BatchExportProcessorOptions<T>
+        {
+            MaxQueueSize = maxQueueSize,
+            ScheduledDelayMilliseconds = scheduledDelayMilliseconds,
+            ExporterTimeoutMilliseconds = exporterTimeoutMilliseconds,
+            MaxExportBatchSize = maxExportBatchSize,
+            UseThreads = true,
+        })
     {
     }
 
     /// <summary>
     /// Initializes a new instance of the <see cref="BatchExportProcessor{T}"/> class.
     /// </summary>
     /// <param name="exporter">Exporter instance.</param>
-    /// <param name="maxQueueSize">The maximum queue size. After the size is reached data are dropped. The default value is 2048.</param>
-    /// <param name="scheduledDelayMilliseconds">The delay interval in milliseconds between two consecutive exports. The default value is 5000.</param>
-    /// <param name="exporterTimeoutMilliseconds">How long the export can run before it is cancelled. The default value is 30000.</param>
-    /// <param name="maxExportBatchSize">The maximum batch size of every export. It must be smaller or equal to maxQueueSize. The default value is 512.</param>
-    /// <param name="useThreads">Enables the use of <see cref="Thread" /> when true, <see cref="Task"/> when false.</param>
+    /// <param name="options">Configuration options for the batch export processor.</param>
     protected BatchExportProcessor(
         BaseExporter<T> exporter,
-        int maxQueueSize = DefaultMaxQueueSize,
-        int scheduledDelayMilliseconds = DefaultScheduledDelayMilliseconds,
-        int exporterTimeoutMilliseconds = DefaultExporterTimeoutMilliseconds,
-        int maxExportBatchSize = DefaultMaxExportBatchSize,
-        bool useThreads = true)
+        BatchExportProcessorOptions<T> options)
         : base(exporter)
     {
-        Guard.ThrowIfOutOfRange(maxQueueSize, min: 1);
-        Guard.ThrowIfOutOfRange(maxExportBatchSize, min: 1, max: maxQueueSize, maxName: nameof(maxQueueSize));
-        Guard.ThrowIfOutOfRange(scheduledDelayMilliseconds, min: 1);
-        Guard.ThrowIfOutOfRange(exporterTimeoutMilliseconds, min: 0);
-
-        this.circularBuffer = new CircularBuffer<T>(maxQueueSize);
-        this.ScheduledDelayMilliseconds = scheduledDelayMilliseconds;
-        this.ExporterTimeoutMilliseconds = exporterTimeoutMilliseconds;
-        this.MaxExportBatchSize = maxExportBatchSize;
-        this.useThreads = useThreads;
+        Guard.ThrowIfNull(options);
+#pragma warning disable CA1062 // Validate arguments of public methods - needed for netstandard2.1
+        Guard.ThrowIfOutOfRange(options.MaxQueueSize, min: 1);
+#pragma warning restore CA1062 // Validate arguments of public methods - needed for netstandard2.1
+        Guard.ThrowIfOutOfRange(options.MaxExportBatchSize, min: 1, max: options.MaxQueueSize, maxName: nameof(options.MaxQueueSize));
+        Guard.ThrowIfOutOfRange(options.ScheduledDelayMilliseconds, min: 1);
+        Guard.ThrowIfOutOfRange(options.ExporterTimeoutMilliseconds, min: 0);
+
+        this.circularBuffer = new CircularBuffer<T>(options.MaxQueueSize);
+        this.ScheduledDelayMilliseconds = options.ScheduledDelayMilliseconds;
+        this.ExporterTimeoutMilliseconds = options.ExporterTimeoutMilliseconds;
+        this.MaxExportBatchSize = options.MaxExportBatchSize;
+        this.useThreads = options.UseThreads;
 
         this.worker = this.CreateWorker();
         this.worker.Start();

src/OpenTelemetry/BatchExportProcessorOptions.cs

@@ -29,4 +29,9 @@ public class BatchExportProcessorOptions<T>
     /// Gets or sets the maximum batch size of every export. It must be smaller or equal to <see cref="MaxQueueSize"/>. The default value is 512.
     /// </summary>
     public int MaxExportBatchSize { get; set; } = BatchExportProcessor<T>.DefaultMaxExportBatchSize;
+
+    /// <summary>
+    /// Gets or sets a value indicating whether to use threads. Enables the use of <see cref="Thread" /> when true, <see cref="Task"/> when false. The default value is true.
+    /// </summary>
+    public bool UseThreads { get; set; } = true;
 }

src/OpenTelemetry/Logs/Processor/BatchLogRecordExportProcessor.cs

@@ -21,43 +21,32 @@ public class BatchLogRecordExportProcessor : BatchExportProcessor<LogRecord>
     /// <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 BatchLogRecordExportProcessor(
         BaseExporter<LogRecord> exporter,
-        int maxQueueSize,
-        int scheduledDelayMilliseconds,
-        int exporterTimeoutMilliseconds,
-        int maxExportBatchSize)
+        int maxQueueSize = DefaultMaxQueueSize,
+        int scheduledDelayMilliseconds = DefaultScheduledDelayMilliseconds,
+        int exporterTimeoutMilliseconds = DefaultExporterTimeoutMilliseconds,
+        int maxExportBatchSize = DefaultMaxExportBatchSize)
         : this(
             exporter,
-            maxQueueSize,
-            scheduledDelayMilliseconds,
-            exporterTimeoutMilliseconds,
-            maxExportBatchSize,
-            true)
+            new BatchExportProcessorOptions<LogRecord>
+            {
+                MaxQueueSize = maxQueueSize,
+                ScheduledDelayMilliseconds = scheduledDelayMilliseconds,
+                ExporterTimeoutMilliseconds = exporterTimeoutMilliseconds,
+                MaxExportBatchSize = maxExportBatchSize,
+                UseThreads = true,
+            })
     {
     }
 
     /// <summary>
     /// Initializes a new instance of the <see cref="BatchLogRecordExportProcessor"/> class.
     /// </summary>
     /// <param name="exporter">Log record exporter.</param>
-    /// <param name="maxQueueSize">The maximum queue size. After the size is reached data are dropped. The default value is 2048.</param>
-    /// <param name="scheduledDelayMilliseconds">The delay interval in milliseconds between two consecutive exports. The default value is 5000.</param>
-    /// <param name="exporterTimeoutMilliseconds">How long the export can run before it is cancelled. The default value is 30000.</param>
-    /// <param name="maxExportBatchSize">The maximum batch size of every export. It must be smaller or equal to maxQueueSize. The default value is 512.</param>
-    /// <param name="useThreads">Enables the use of <see cref="Thread" /> when true, <see cref="Task"/> when false.</param>
+    /// <param name="options">Configuration options for the batch export processor.</param>
     public BatchLogRecordExportProcessor(
         BaseExporter<LogRecord> exporter,
-        int maxQueueSize = DefaultMaxQueueSize,
-        int scheduledDelayMilliseconds = DefaultScheduledDelayMilliseconds,
-        int exporterTimeoutMilliseconds = DefaultExporterTimeoutMilliseconds,
-        int maxExportBatchSize = DefaultMaxExportBatchSize,
-        bool useThreads = true)
-        : base(
-            exporter,
-            maxQueueSize,
-            scheduledDelayMilliseconds,
-            exporterTimeoutMilliseconds,
-            maxExportBatchSize,
-            useThreads)
+        BatchExportProcessorOptions<LogRecord> options)
+        : base(exporter, options)
     {
     }
 

src/OpenTelemetry/Metrics/Reader/PeriodicExportingMetricReader.cs

@@ -30,26 +30,34 @@ public class PeriodicExportingMetricReader : BaseExportingMetricReader
     /// <param name="exportTimeoutMilliseconds">How long the export can run before it is cancelled. The default value is 30000.</param>
     public PeriodicExportingMetricReader(
         BaseExporter<Metric> exporter,
-        int exportIntervalMilliseconds,
-        int exportTimeoutMilliseconds)
-        : this(exporter, exportIntervalMilliseconds, exportTimeoutMilliseconds, true)
+        int exportIntervalMilliseconds = DefaultExportIntervalMilliseconds,
+        int exportTimeoutMilliseconds = DefaultExportTimeoutMilliseconds)
+        : this(exporter, new PeriodicExportingMetricReaderOptions
+        {
+            ExportIntervalMilliseconds = exportIntervalMilliseconds,
+            ExportTimeoutMilliseconds = exportTimeoutMilliseconds,
+            UseThreads = true,
+        })
     {
     }
 
     /// <summary>
     /// Initializes a new instance of the <see cref="PeriodicExportingMetricReader"/> class.
     /// </summary>
     /// <param name="exporter">Exporter instance to export Metrics to.</param>
-    /// <param name="exportIntervalMilliseconds">The interval in milliseconds between two consecutive exports. The default value is 60000.</param>
-    /// <param name="exportTimeoutMilliseconds">How long the export can run before it is cancelled. The default value is 30000.</param>
-    /// <param name="useThreads">Enables the use of <see cref="Thread" /> when true, <see cref="Task"/> when false.</param>
+    /// <param name="options">Configuration options for the periodic exporting metric reader.</param>
     public PeriodicExportingMetricReader(
         BaseExporter<Metric> exporter,
-        int exportIntervalMilliseconds = DefaultExportIntervalMilliseconds,
-        int exportTimeoutMilliseconds = DefaultExportTimeoutMilliseconds,
-        bool useThreads = true)
+        PeriodicExportingMetricReaderOptions options)
         : base(exporter)
     {
+        Guard.ThrowIfNull(options);
+
+#pragma warning disable CA1062 // Validate arguments of public methods - needed for netstandard2.1
+        var exportIntervalMilliseconds = options!.ExportIntervalMilliseconds ?? DefaultExportIntervalMilliseconds;
+#pragma warning restore CA1062 // Validate arguments of public methods - needed for netstandard2.1
+        var exportTimeoutMilliseconds = options.ExportTimeoutMilliseconds ?? DefaultExportTimeoutMilliseconds;
+
         Guard.ThrowIfInvalidTimeout(exportIntervalMilliseconds);
         Guard.ThrowIfZero(exportIntervalMilliseconds);
         Guard.ThrowIfInvalidTimeout(exportTimeoutMilliseconds);
@@ -61,7 +69,7 @@ public PeriodicExportingMetricReader(
 
         this.ExportIntervalMilliseconds = exportIntervalMilliseconds;
         this.ExportTimeoutMilliseconds = exportTimeoutMilliseconds;
-        this.useThreads = useThreads;
+        this.useThreads = options.UseThreads;
 
         this.worker = this.CreateWorker();
         this.worker.Start();

src/OpenTelemetry/Metrics/Reader/PeriodicExportingMetricReaderOptions.cs

@@ -52,4 +52,9 @@ internal PeriodicExportingMetricReaderOptions(IConfiguration configuration)
     /// associated with the metric reader.
     /// </summary>
     public int? ExportTimeoutMilliseconds { get; set; }
+
+    /// <summary>
+    /// Gets or sets a value indicating whether to use threads. Enables the use of <see cref="Thread" /> when true, <see cref="Task"/> when false. The default value is true.
+    /// </summary>
+    public bool UseThreads { get; set; } = true;
 }