MetricReaderOptions for AddInMemoryExporter extension methods

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

@@ -1,2 +1,3 @@
 OpenTelemetry.Metrics.InMemoryExporterMetricsExtensions
-static OpenTelemetry.Metrics.InMemoryExporterMetricsExtensions.AddInMemoryExporter(this OpenTelemetry.Metrics.MeterProviderBuilder builder, System.Collections.Generic.ICollection<OpenTelemetry.Metrics.Metric> exportedItems) -> OpenTelemetry.Metrics.MeterProviderBuilder
+static OpenTelemetry.Metrics.InMemoryExporterMetricsExtensions.AddInMemoryExporter(this OpenTelemetry.Metrics.MeterProviderBuilder builder, System.Collections.Generic.ICollection<OpenTelemetry.Metrics.Metric> exportedItems) -> OpenTelemetry.Metrics.MeterProviderBuilder
+static OpenTelemetry.Metrics.InMemoryExporterMetricsExtensions.AddInMemoryExporter(this OpenTelemetry.Metrics.MeterProviderBuilder builder, System.Collections.Generic.ICollection<OpenTelemetry.Metrics.Metric> exportedItems, System.Action<OpenTelemetry.Metrics.MetricReaderOptions> configureMetricReader) -> OpenTelemetry.Metrics.MeterProviderBuilder

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

@@ -1,2 +1,3 @@
 OpenTelemetry.Metrics.InMemoryExporterMetricsExtensions
-static OpenTelemetry.Metrics.InMemoryExporterMetricsExtensions.AddInMemoryExporter(this OpenTelemetry.Metrics.MeterProviderBuilder builder, System.Collections.Generic.ICollection<OpenTelemetry.Metrics.Metric> exportedItems) -> OpenTelemetry.Metrics.MeterProviderBuilder
+static OpenTelemetry.Metrics.InMemoryExporterMetricsExtensions.AddInMemoryExporter(this OpenTelemetry.Metrics.MeterProviderBuilder builder, System.Collections.Generic.ICollection<OpenTelemetry.Metrics.Metric> exportedItems) -> OpenTelemetry.Metrics.MeterProviderBuilder
+static OpenTelemetry.Metrics.InMemoryExporterMetricsExtensions.AddInMemoryExporter(this OpenTelemetry.Metrics.MeterProviderBuilder builder, System.Collections.Generic.ICollection<OpenTelemetry.Metrics.Metric> exportedItems, System.Action<OpenTelemetry.Metrics.MetricReaderOptions> configureMetricReader) -> OpenTelemetry.Metrics.MeterProviderBuilder

src/OpenTelemetry.Exporter.InMemory/CHANGELOG.md

@@ -2,6 +2,10 @@
 
 ## Unreleased
 
+* Adds the ability to configure `MetricReaderOptions` via the
+ `AddInMemoryExporter` extension method.
+ ([#2931](https:/open-telemetry/opentelemetry-dotnet/pull/2931))
+
 ## 1.2.0-rc2
 
 Released 2022-Feb-02

src/OpenTelemetry.Exporter.InMemory/InMemoryExporterMetricsExtensions.cs

@@ -14,16 +14,20 @@
 // limitations under the License.
 // </copyright>
 
+using System;
 using System.Collections.Generic;
 using OpenTelemetry.Exporter;
 using OpenTelemetry.Internal;
 
 namespace OpenTelemetry.Metrics
 {
+ /// <summary>
+ /// Extension methods to simplify registering of the InMemory exporter.
+ /// </summary>
  public static class InMemoryExporterMetricsExtensions
  {
  /// <summary>
- /// Adds InMemory exporter to the TracerProvider.
+ /// Adds InMemory metric exporter to the <see cref="MeterProviderBuilder"/> using default options.
  /// </summary>
  /// <param name="builder"><see cref="MeterProviderBuilder"/> builder to use.</param>
  /// <param name="exportedItems">Collection which will be populated with the exported MetricItem.</param>
@@ -33,7 +37,61 @@ public static MeterProviderBuilder AddInMemoryExporter(this MeterProviderBuilder
  Guard.ThrowIfNull(builder);
  Guard.ThrowIfNull(exportedItems);
 
- return builder.AddReader(new BaseExportingMetricReader(new InMemoryExporter<Metric>(exportedItems)));
+ if (builder is IDeferredMeterProviderBuilder deferredMeterProviderBuilder)
+ {
+ return deferredMeterProviderBuilder.Configure((sp, builder) =>
+ {
+ AddInMemoryExporter(builder, exportedItems, sp.GetOptions<MetricReaderOptions>(), null);
+ });
+ }
+
+ return AddInMemoryExporter(builder, exportedItems, new MetricReaderOptions(), null);
+ }
+
+ /// <summary>
+ /// Adds InMemory metric exporter to the <see cref="MeterProviderBuilder"/> using default options.
+ /// </summary>
+ /// <param name="builder"><see cref="MeterProviderBuilder"/> builder to use.</param>
+ /// <param name="exportedItems">Collection which will be populated with the exported MetricItem.</param>
+ /// <param name="configureMetricReader"><see cref="MetricReader"/> configuration options.</param>
+ /// <returns>The instance of <see cref="MeterProviderBuilder"/> to chain the calls.</returns>
+ public static MeterProviderBuilder AddInMemoryExporter(this MeterProviderBuilder builder, ICollection<Metric> exportedItems, Action<MetricReaderOptions> configureMetricReader)
+ {
+ Guard.ThrowIfNull(builder);
+ Guard.ThrowIfNull(exportedItems);
+
+ if (builder is IDeferredMeterProviderBuilder deferredMeterProviderBuilder)
+ {
+ return deferredMeterProviderBuilder.Configure((sp, builder) =>
+ {
+ AddInMemoryExporter(builder, exportedItems, sp.GetOptions<MetricReaderOptions>(), configureMetricReader);
+ });
+ }
+
+ return AddInMemoryExporter(builder, exportedItems, new MetricReaderOptions(), configureMetricReader);
+ }
+
+ private static MeterProviderBuilder AddInMemoryExporter(
+ MeterProviderBuilder builder,
+ ICollection<Metric> exportedItems,
+ MetricReaderOptions metricReaderOptions,
+ Action<MetricReaderOptions> configureMetricReader)
+ {
+ configureMetricReader?.Invoke(metricReaderOptions);
+
+ var metricExporter = new InMemoryExporter<Metric>(exportedItems);
+
+ if (metricReaderOptions.MetricReaderType == (MetricReaderType)(-1))
+ {
+ metricReaderOptions.MetricReaderType = MetricReaderType.Manual;
+ }
+
+ var metricReader = metricReaderOptions.MetricReaderType == MetricReaderType.Manual
+ ? new BaseExportingMetricReader(metricExporter)
+ : new PeriodicExportingMetricReader(metricExporter, metricReaderOptions.PeriodicExportingMetricReaderOptions.ExportIntervalMilliseconds);
+
+ metricReader.Temporality = metricReaderOptions.Temporality;
+ return builder.AddReader(metricReader);
  }
  }
 }

src/OpenTelemetry.Exporter.InMemory/OpenTelemetry.Exporter.InMemory.csproj

@@ -16,6 +16,7 @@
  </ItemGroup>
 
  <ItemGroup>
+ <Compile Include="$(RepoRoot)\src\OpenTelemetry\Internal\ServiceProviderExtensions.cs" Link="Includes\ServiceProviderExtensions.cs" />
  <Compile Include="$(RepoRoot)\src\OpenTelemetry.Api\Internal\Guard.cs" Link="Includes\Guard.cs" />
  </ItemGroup>
 

test/Benchmarks/Metrics/HistogramBenchmarks.cs

@@ -20,7 +20,6 @@
 using System.Threading;
 using BenchmarkDotNet.Attributes;
 using OpenTelemetry;
-using OpenTelemetry.Exporter;
 using OpenTelemetry.Metrics;
 using OpenTelemetry.Tests;
 
@@ -76,11 +75,14 @@ public void Setup()
  }
 
  var exportedItems = new List<Metric>();
- var reader = new PeriodicExportingMetricReader(new InMemoryExporter<Metric>(exportedItems), 1000);
 
  this.provider = Sdk.CreateMeterProviderBuilder()
  .AddMeter(this.meter.Name)
- .AddReader(reader)
+ .AddInMemoryExporter(exportedItems, metricReaderOptions =>
+ {
+ metricReaderOptions.MetricReaderType = MetricReaderType.Periodic;
+ metricReaderOptions.PeriodicExportingMetricReaderOptions.ExportIntervalMilliseconds = 1000;
+ })
  .AddView(this.histogramLong.Name, new ExplicitBucketHistogramConfiguration() { Boundaries = this.bounds })
  .AddView(this.histogramDouble.Name, new ExplicitBucketHistogramConfiguration() { Boundaries = this.bounds })
  .Build();

test/Benchmarks/Metrics/MetricsBenchmarks.cs

@@ -71,13 +71,14 @@ public void Setup()
  this.meter = new Meter(Utils.GetCurrentMethodName());
 
  var exportedItems = new List<Metric>();
- var reader = new PeriodicExportingMetricReader(new InMemoryExporter<Metric>(exportedItems), 1000)
- {
- Temporality = this.AggregationTemporality,
- };
  this.provider = Sdk.CreateMeterProviderBuilder()
  .AddMeter(this.meter.Name) // All instruments from this meter are enabled.
- .AddReader(reader)
+ .AddInMemoryExporter(exportedItems, metricReaderOptions =>
+ {
+ metricReaderOptions.MetricReaderType = MetricReaderType.Periodic;
+ metricReaderOptions.PeriodicExportingMetricReaderOptions.ExportIntervalMilliseconds = 1000;
+ metricReaderOptions.Temporality = this.AggregationTemporality;
+ })
  .Build();
 
  this.counter = this.meter.CreateCounter<long>("counter");

test/Benchmarks/Metrics/MetricsViewBenchmarks.cs

@@ -89,23 +89,23 @@ public void Setup()
  {
  this.provider = Sdk.CreateMeterProviderBuilder()
  .AddMeter(this.meter.Name)
- .AddReader(new BaseExportingMetricReader(new InMemoryExporter<Metric>(this.metrics)))
+ .AddInMemoryExporter(this.metrics)
  .Build();
  }
  else if (this.ViewConfig == ViewConfiguration.ViewNoInstrSelect)
  {
  this.provider = Sdk.CreateMeterProviderBuilder()
  .AddMeter(this.meter.Name)
  .AddView("nomatch", new MetricStreamConfiguration() { TagKeys = new string[] { "DimName1", "DimName2", "DimName3" } })
- .AddReader(new BaseExportingMetricReader(new InMemoryExporter<Metric>(this.metrics)))
+ .AddInMemoryExporter(this.metrics)
  .Build();
  }
  else if (this.ViewConfig == ViewConfiguration.ViewSelectsInstr)
  {
  this.provider = Sdk.CreateMeterProviderBuilder()
  .AddMeter(this.meter.Name)
  .AddView(this.counter.Name, new MetricStreamConfiguration() { TagKeys = new string[] { "DimName1", "DimName2", "DimName3" } })
- .AddReader(new BaseExportingMetricReader(new InMemoryExporter<Metric>(this.metrics)))
+ .AddInMemoryExporter(this.metrics)
  .Build();
  }
  }

test/OpenTelemetry.Exporter.OpenTelemetryProtocol.Tests/OtlpMetricsExporterTests.cs

@@ -240,11 +240,10 @@ public void TestCounterToOltpMetric(string name, string description, string unit
  using var meter = new Meter(Utils.GetCurrentMethodName());
  using var provider = Sdk.CreateMeterProviderBuilder()
  .AddMeter(meter.Name)
- .AddReader(
- new BaseExportingMetricReader(new InMemoryExporter<Metric>(metrics))
- {
- Temporality = aggregationTemporality,
- })
+ .AddInMemoryExporter(metrics, metricReaderOptions =>
+ {
+ metricReaderOptions.Temporality = aggregationTemporality;
+ })
  .Build();
 
  var attributes = ToAttributes(keysValues).ToArray();
@@ -334,13 +333,13 @@ public void TestHistogramToOltpMetric(string name, string description, string un
  {
  var metrics = new List<Metric>();
 
- var metricReader = new BaseExportingMetricReader(new InMemoryExporter<Metric>(metrics));
- metricReader.Temporality = aggregationTemporality;
-
  using var meter = new Meter(Utils.GetCurrentMethodName());
  using var provider = Sdk.CreateMeterProviderBuilder()
  .AddMeter(meter.Name)
- .AddReader(metricReader)
+ .AddInMemoryExporter(metrics, metricReaderOptions =>
+ {
+ metricReaderOptions.Temporality = aggregationTemporality;
+ })
  .Build();
 
  var attributes = ToAttributes(keysValues).ToArray();

test/OpenTelemetry.Instrumentation.AspNetCore.Tests/MetricTests.cs

@@ -19,7 +19,6 @@
 using System.Linq;
 using System.Threading.Tasks;
 using Microsoft.AspNetCore.Mvc.Testing;
-using OpenTelemetry.Exporter;
 using OpenTelemetry.Metrics;
 using OpenTelemetry.Trace;
 #if NETCOREAPP3_1
@@ -57,15 +56,10 @@ public void AddAspNetCoreInstrumentation_BadArgs()
  public async Task RequestMetricIsCaptured()
  {
  var metricItems = new List<Metric>();
- var metricExporter = new InMemoryExporter<Metric>(metricItems);
 
- var metricReader = new BaseExportingMetricReader(metricExporter)
- {
- Temporality = AggregationTemporality.Cumulative,
- };
  this.meterProvider = Sdk.CreateMeterProviderBuilder()
  .AddAspNetCoreInstrumentation()
- .AddReader(metricReader)
+ .AddInMemoryExporter(metricItems)
  .Build();
 
  using (var client = this.factory.CreateClient())

test/OpenTelemetry.Instrumentation.Http.Tests/HttpClientTests.netcore31.cs

@@ -25,7 +25,6 @@
 using System.Threading.Tasks;
 using Moq;
 using Newtonsoft.Json;
-using OpenTelemetry.Exporter;
 using OpenTelemetry.Metrics;
 using OpenTelemetry.Tests;
 using OpenTelemetry.Trace;
@@ -55,16 +54,11 @@ public async Task HttpOutCallsAreCollectedSuccessfullyAsync(HttpTestData.HttpOut
  var processor = new Mock<BaseProcessor<Activity>>();
  tc.Url = HttpTestData.NormalizeValues(tc.Url, host, port);
 
- var metricItems = new List<Metric>();
- var metricExporter = new InMemoryExporter<Metric>(metricItems);
+ var metrics = new List<Metric>();
 
- var metricReader = new BaseExportingMetricReader(metricExporter)
- {
- Temporality = AggregationTemporality.Cumulative,
- };
  var meterProvider = Sdk.CreateMeterProviderBuilder()
  .AddHttpClientInstrumentation()
- .AddReader(metricReader)
+ .AddInMemoryExporter(metrics)
  .Build();
 
  using (serverLifeTime)
@@ -107,7 +101,7 @@ public async Task HttpOutCallsAreCollectedSuccessfullyAsync(HttpTestData.HttpOut
 
  meterProvider.Dispose();
 
- var requestMetrics = metricItems
+ var requestMetrics = metrics
  .Where(metric => metric.Name == "http.client.duration")
  .ToArray();
 

test/OpenTelemetry.Tests/Metrics/InMemoryExporterTests.cs

@@ -16,7 +16,6 @@
 
 using System.Collections.Generic;
 using System.Diagnostics.Metrics;
-using OpenTelemetry.Exporter;
 using OpenTelemetry.Tests;
 using Xunit;
 
@@ -32,9 +31,9 @@ public void InMemoryExporterShouldDeepCopyMetricPoints()
  using var meter = new Meter(Utils.GetCurrentMethodName());
  using var meterProvider = Sdk.CreateMeterProviderBuilder()
  .AddMeter(meter.Name)
- .AddReader(new BaseExportingMetricReader(new InMemoryExporter<Metric>(exportedItems))
+ .AddInMemoryExporter(exportedItems, metricReaderOptions =>
  {
- Temporality = AggregationTemporality.Delta,
+ metricReaderOptions.Temporality = AggregationTemporality.Delta;
  })
  .Build();
 

test/OpenTelemetry.Tests/Metrics/MemoryEfficiencyTests.cs

@@ -16,7 +16,6 @@
 
 using System.Collections.Generic;
 using System.Diagnostics.Metrics;
-using OpenTelemetry.Exporter;
 using OpenTelemetry.Tests;
 using Xunit;
 
@@ -35,11 +34,10 @@ public void ExportOnlyWhenPointChanged(AggregationTemporality temporality)
 
  using var meterProvider = Sdk.CreateMeterProviderBuilder()
  .AddMeter(meter.Name)
- .AddReader(
- new BaseExportingMetricReader(new InMemoryExporter<Metric>(exportedItems))
- {
- Temporality = temporality,
- })
+ .AddInMemoryExporter(exportedItems, metricReaderOptions =>
+ {
+ metricReaderOptions.Temporality = temporality;
+ })
  .Build();
 
  var counter = meter.CreateCounter<long>("meter");