Hide MetricReader.ProcessMetrics for now (#2683)

docs/metrics/extending-the-sdk/MyReader.cs

@@ -1,59 +0,0 @@
-// <copyright file="MyReader.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.Text;
-using OpenTelemetry;
-using OpenTelemetry.Metrics;
-
-internal class MyReader : MetricReader
-{
-    private readonly string name;
-
-    public MyReader(string name = "MyReader")
-    {
-        this.name = name;
-    }
-
-    protected override bool ProcessMetrics(in Batch<Metric> metrics, int timeoutMilliseconds)
-    {
-        var sb = new StringBuilder();
-        foreach (var record in metrics)
-        {
-            if (sb.Length > 0)
-            {
-                sb.Append(", ");
-            }
-
-            sb.Append($"{record}");
-        }
-
-        Console.WriteLine($"{this.name}.ProcessMetrics(metrics=[{sb}], timeoutMilliseconds={timeoutMilliseconds})");
-        return true;
-    }
-
-    protected override bool OnShutdown(int timeoutMilliseconds)
-    {
-        Console.WriteLine($"{this.name}.OnShutdown(timeoutMilliseconds={timeoutMilliseconds})");
-        return base.OnShutdown(timeoutMilliseconds);
-    }
-
-    protected override void Dispose(bool disposing)
-    {
-        Console.WriteLine($"{this.name}.Dispose({disposing})");
-        base.Dispose(disposing);
-    }
-}

docs/metrics/extending-the-sdk/Program.cs

@@ -42,7 +42,7 @@ public class Program
     {
         using var meterProvider = Sdk.CreateMeterProviderBuilder()
             .AddMeter("MyCompany.MyProduct.MyLibrary")
-            .AddReader(new MyReader())
+            .AddReader(new BaseExportingMetricReader(new MyExporter("ExporterX")))
             .AddMyExporter()
             .Build();
 

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

@@ -1,4 +1,3 @@
-abstract OpenTelemetry.Metrics.MetricReader.ProcessMetrics(in OpenTelemetry.Batch<OpenTelemetry.Metrics.Metric> metrics, int timeoutMilliseconds) -> bool
 OpenTelemetry.BaseExporter<T>.ForceFlush(int timeoutMilliseconds = -1) -> bool
 OpenTelemetry.Batch<T>.Batch(T[] items, int count) -> void
 OpenTelemetry.Batch<T>.Count.get -> long
@@ -116,7 +115,6 @@ override OpenTelemetry.BatchExportProcessor<T>.Dispose(bool disposing) -> void
 override OpenTelemetry.Metrics.BaseExportingMetricReader.Dispose(bool disposing) -> void
 override OpenTelemetry.Metrics.BaseExportingMetricReader.OnCollect(int timeoutMilliseconds) -> bool
 override OpenTelemetry.Metrics.BaseExportingMetricReader.OnShutdown(int timeoutMilliseconds) -> bool
-override OpenTelemetry.Metrics.BaseExportingMetricReader.ProcessMetrics(in OpenTelemetry.Batch<OpenTelemetry.Metrics.Metric> metrics, int timeoutMilliseconds) -> bool
 override OpenTelemetry.Metrics.MeterProviderBuilderBase.AddInstrumentation<TInstrumentation>(System.Func<TInstrumentation> instrumentationFactory) -> OpenTelemetry.Metrics.MeterProviderBuilder
 override OpenTelemetry.Metrics.MeterProviderBuilderBase.AddMeter(params string[] names) -> OpenTelemetry.Metrics.MeterProviderBuilder
 override OpenTelemetry.Metrics.PeriodicExportingMetricReader.Dispose(bool disposing) -> void

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

@@ -1,4 +1,3 @@
-abstract OpenTelemetry.Metrics.MetricReader.ProcessMetrics(in OpenTelemetry.Batch<OpenTelemetry.Metrics.Metric> metrics, int timeoutMilliseconds) -> bool
 OpenTelemetry.BaseExporter<T>.ForceFlush(int timeoutMilliseconds = -1) -> bool
 OpenTelemetry.Batch<T>.Batch(T[] items, int count) -> void
 OpenTelemetry.Batch<T>.Count.get -> long
@@ -116,7 +115,6 @@ override OpenTelemetry.BatchExportProcessor<T>.Dispose(bool disposing) -> void
 override OpenTelemetry.Metrics.BaseExportingMetricReader.Dispose(bool disposing) -> void
 override OpenTelemetry.Metrics.BaseExportingMetricReader.OnCollect(int timeoutMilliseconds) -> bool
 override OpenTelemetry.Metrics.BaseExportingMetricReader.OnShutdown(int timeoutMilliseconds) -> bool
-override OpenTelemetry.Metrics.BaseExportingMetricReader.ProcessMetrics(in OpenTelemetry.Batch<OpenTelemetry.Metrics.Metric> metrics, int timeoutMilliseconds) -> bool
 override OpenTelemetry.Metrics.MeterProviderBuilderBase.AddInstrumentation<TInstrumentation>(System.Func<TInstrumentation> instrumentationFactory) -> OpenTelemetry.Metrics.MeterProviderBuilder
 override OpenTelemetry.Metrics.MeterProviderBuilderBase.AddMeter(params string[] names) -> OpenTelemetry.Metrics.MeterProviderBuilder
 override OpenTelemetry.Metrics.PeriodicExportingMetricReader.Dispose(bool disposing) -> void

src/OpenTelemetry/Metrics/BaseExportingMetricReader.cs

@@ -78,7 +78,7 @@ namespace OpenTelemetry.Metrics
         }
 
         /// <inheritdoc/>
-        protected override bool ProcessMetrics(in Batch<Metric> metrics, int timeoutMilliseconds)
+        internal override bool ProcessMetrics(in Batch<Metric> metrics, int timeoutMilliseconds)
         {
             // TODO: Do we need to consider timeout here?
             return this.exporter.Export(metrics) == ExportResult.Success;

src/OpenTelemetry/Metrics/CompositeMetricReader.cs

@@ -70,7 +70,7 @@ namespace OpenTelemetry.Metrics
         public Enumerator GetEnumerator() => new Enumerator(this.head);
 
         /// <inheritdoc/>
-        protected override bool ProcessMetrics(in Batch<Metric> metrics, int timeoutMilliseconds)
+        internal override bool ProcessMetrics(in Batch<Metric> metrics, int timeoutMilliseconds)
         {
             // CompositeMetricReader delegates the work to its underlying readers,
             // so CompositeMetricReader.ProcessMetrics should never be called.

src/OpenTelemetry/Metrics/MetricReader.cs

@@ -191,7 +191,10 @@ namespace OpenTelemetry.Metrics
         /// Returns <c>true</c> when metrics processing succeeded; otherwise,
         /// <c>false</c>.
         /// </returns>
-        protected abstract bool ProcessMetrics(in Batch<Metric> metrics, int timeoutMilliseconds);
+        internal virtual bool ProcessMetrics(in Batch<Metric> metrics, int timeoutMilliseconds)
+        {
+            return true;
+        }
 
         /// <summary>
         /// Called by <c>Collect</c>. This function should block the current

test/OpenTelemetry.Extensions.Hosting.Tests/HostingMeterExtensionTests.cs

@@ -229,10 +229,6 @@ namespace OpenTelemetry.Extensions.Hosting.Tests
 
         internal class TestReader : MetricReader
         {
-            protected override bool ProcessMetrics(in Batch<Metric> metrics, int timeoutMilliseconds)
-            {
-                return true;
-            }
         }
     }
 }