Update MetricPoint for Histograms (#2657)

open-telemetry · Nov 23, 2021 · 69ef5f8 · 69ef5f8
1 parent ca22838
commit 69ef5f8
Show file tree

Hide file tree

Showing 12 changed files with 223 additions and 98 deletions.
diff --git a/src/OpenTelemetry.Exporter.Console/ConsoleMetricExporter.cs b/src/OpenTelemetry.Exporter.Console/ConsoleMetricExporter.cs
@@ -95,38 +95,42 @@ public override ExportResult Export(in Batch<Metric> batch)
                     if (metricType.IsHistogram())
                     {
                         var bucketsBuilder = new StringBuilder();
-                        bucketsBuilder.Append($"Sum: {metricPoint.DoubleValue} Count: {metricPoint.LongValue} \n");
+                        var sum = metricPoint.GetHistogramSum();
+                        var count = metricPoint.GetHistogramCount();
+                        bucketsBuilder.Append($"Sum: {sum} Count: {count} \n");
 
-                        if (metricPoint.ExplicitBounds != null)
+                        var explicitBounds = metricPoint.GetExplicitBounds();
+                        if (explicitBounds != null)
                         {
-                            for (int i = 0; i < metricPoint.ExplicitBounds.Length + 1; i++)
+                            var bucketCounts = metricPoint.GetBucketCounts();
+                            for (int i = 0; i < explicitBounds.Length + 1; i++)
                             {
                                 if (i == 0)
                                 {
                                     bucketsBuilder.Append("(-Infinity,");
-                                    bucketsBuilder.Append(metricPoint.ExplicitBounds[i]);
+                                    bucketsBuilder.Append(explicitBounds[i]);
                                     bucketsBuilder.Append(']');
                                     bucketsBuilder.Append(':');
-                                    bucketsBuilder.Append(metricPoint.BucketCounts[i]);
+                                    bucketsBuilder.Append(bucketCounts[i]);
                                 }
-                                else if (i == metricPoint.ExplicitBounds.Length)
+                                else if (i == explicitBounds.Length)
                                 {
                                     bucketsBuilder.Append('(');
-                                    bucketsBuilder.Append(metricPoint.ExplicitBounds[i - 1]);
+                                    bucketsBuilder.Append(explicitBounds[i - 1]);
                                     bucketsBuilder.Append(',');
                                     bucketsBuilder.Append("+Infinity]");
                                     bucketsBuilder.Append(':');
-                                    bucketsBuilder.Append(metricPoint.BucketCounts[i]);
+                                    bucketsBuilder.Append(bucketCounts[i]);
                                 }
                                 else
                                 {
                                     bucketsBuilder.Append('(');
-                                    bucketsBuilder.Append(metricPoint.ExplicitBounds[i - 1]);
+                                    bucketsBuilder.Append(explicitBounds[i - 1]);
                                     bucketsBuilder.Append(',');
-                                    bucketsBuilder.Append(metricPoint.ExplicitBounds[i]);
+                                    bucketsBuilder.Append(explicitBounds[i]);
                                     bucketsBuilder.Append(']');
                                     bucketsBuilder.Append(':');
-                                    bucketsBuilder.Append(metricPoint.BucketCounts[i]);
+                                    bucketsBuilder.Append(bucketCounts[i]);
                                 }
 
                                 bucketsBuilder.AppendLine();

diff --git a/src/OpenTelemetry.Exporter.OpenTelemetryProtocol/Implementation/MetricItemExtensions.cs b/src/OpenTelemetry.Exporter.OpenTelemetryProtocol/Implementation/MetricItemExtensions.cs
@@ -249,14 +249,16 @@ internal static OtlpMetrics.Metric ToOtlpMetric(this Metric metric)
                             dataPoint.Count = (ulong)metricPoint.LongValue;
                             dataPoint.Sum = metricPoint.DoubleValue;
 
-                            if (metricPoint.BucketCounts != null)
+                            var bucketCounts = metricPoint.GetBucketCounts();
+                            if (bucketCounts != null)
                             {
-                                for (int i = 0; i < metricPoint.BucketCounts.Length; i++)
+                                var explicitBounds = metricPoint.GetExplicitBounds();
+                                for (int i = 0; i < bucketCounts.Length; i++)
                                 {
-                                    dataPoint.BucketCounts.Add((ulong)metricPoint.BucketCounts[i]);
-                                    if (i < metricPoint.BucketCounts.Length - 1)
+                                    dataPoint.BucketCounts.Add((ulong)bucketCounts[i]);
+                                    if (i < bucketCounts.Length - 1)
                                     {
-                                        dataPoint.ExplicitBounds.Add(metricPoint.ExplicitBounds[i]);
+                                        dataPoint.ExplicitBounds.Add(explicitBounds[i]);
                                     }
                                 }
                             }

diff --git a/src/OpenTelemetry.Exporter.Prometheus/Implementation/PrometheusSerializerExt.cs b/src/OpenTelemetry.Exporter.Prometheus/Implementation/PrometheusSerializerExt.cs
@@ -91,11 +91,11 @@ public static int WriteMetric(byte[] buffer, int cursor, Metric metric)
                     var tags = metricPoint.Tags;
                     var timestamp = metricPoint.EndTime.ToUnixTimeMilliseconds();
 
-                    if (metricPoint.BucketCounts != null)
+                    var bucketCounts = metricPoint.GetBucketCounts();
+                    if (bucketCounts != null)
                     {
                         // Histogram buckets
-                        var bucketCounts = metricPoint.BucketCounts;
-                        var explicitBounds = metricPoint.ExplicitBounds;
+                        var explicitBounds = metricPoint.GetExplicitBounds();
                         long totalCount = 0;
                         for (int idxBound = 0; idxBound < explicitBounds.Length + 1; idxBound++)
                         {
@@ -133,6 +133,9 @@ public static int WriteMetric(byte[] buffer, int cursor, Metric metric)
                     }
 
                     // Histogram sum
+                    var count = metricPoint.GetHistogramCount();
+                    var sum = metricPoint.GetHistogramSum();
+
                     cursor = WriteMetricName(buffer, cursor, metric.Name, metric.Unit);
                     cursor = WriteAsciiStringNoEscape(buffer, cursor, "_sum");
 
@@ -156,7 +159,7 @@ public static int WriteMetric(byte[] buffer, int cursor, Metric metric)
 
                     buffer[cursor++] = unchecked((byte)' ');
 
-                    cursor = WriteDouble(buffer, cursor, metricPoint.DoubleValue);
+                    cursor = WriteDouble(buffer, cursor, sum);
                     buffer[cursor++] = unchecked((byte)' ');
 
                     cursor = WriteLong(buffer, cursor, timestamp);
@@ -187,7 +190,7 @@ public static int WriteMetric(byte[] buffer, int cursor, Metric metric)
 
                     buffer[cursor++] = unchecked((byte)' ');
 
-                    cursor = WriteLong(buffer, cursor, metricPoint.LongValue);
+                    cursor = WriteLong(buffer, cursor, count);
                     buffer[cursor++] = unchecked((byte)' ');
 
                     cursor = WriteLong(buffer, cursor, timestamp);

diff --git a/src/OpenTelemetry/.publicApi/net461/PublicAPI.Unshipped.txt b/src/OpenTelemetry/.publicApi/net461/PublicAPI.Unshipped.txt
@@ -56,10 +56,12 @@ OpenTelemetry.Metrics.Metric.Name.get -> string
 OpenTelemetry.Metrics.Metric.Temporality.get -> OpenTelemetry.Metrics.AggregationTemporality
 OpenTelemetry.Metrics.Metric.Unit.get -> string
 OpenTelemetry.Metrics.MetricPoint
-OpenTelemetry.Metrics.MetricPoint.BucketCounts.get -> long[]
 OpenTelemetry.Metrics.MetricPoint.DoubleValue.get -> double
 OpenTelemetry.Metrics.MetricPoint.EndTime.get -> System.DateTimeOffset
-OpenTelemetry.Metrics.MetricPoint.ExplicitBounds.get -> double[]
+OpenTelemetry.Metrics.MetricPoint.GetBucketCounts() -> long[]
+OpenTelemetry.Metrics.MetricPoint.GetExplicitBounds() -> double[]
+OpenTelemetry.Metrics.MetricPoint.GetHistogramCount() -> long
+OpenTelemetry.Metrics.MetricPoint.GetHistogramSum() -> double
 OpenTelemetry.Metrics.MetricPoint.LongValue.get -> long
 OpenTelemetry.Metrics.MetricPoint.MetricPoint() -> void
 OpenTelemetry.Metrics.MetricPoint.StartTime.get -> System.DateTimeOffset

diff --git a/src/OpenTelemetry/.publicApi/netstandard2.0/PublicAPI.Unshipped.txt b/src/OpenTelemetry/.publicApi/netstandard2.0/PublicAPI.Unshipped.txt
@@ -56,10 +56,12 @@ OpenTelemetry.Metrics.Metric.Name.get -> string
 OpenTelemetry.Metrics.Metric.Temporality.get -> OpenTelemetry.Metrics.AggregationTemporality
 OpenTelemetry.Metrics.Metric.Unit.get -> string
 OpenTelemetry.Metrics.MetricPoint
-OpenTelemetry.Metrics.MetricPoint.BucketCounts.get -> long[]
 OpenTelemetry.Metrics.MetricPoint.DoubleValue.get -> double
 OpenTelemetry.Metrics.MetricPoint.EndTime.get -> System.DateTimeOffset
-OpenTelemetry.Metrics.MetricPoint.ExplicitBounds.get -> double[]
+OpenTelemetry.Metrics.MetricPoint.GetBucketCounts() -> long[]
+OpenTelemetry.Metrics.MetricPoint.GetExplicitBounds() -> double[]
+OpenTelemetry.Metrics.MetricPoint.GetHistogramCount() -> long
+OpenTelemetry.Metrics.MetricPoint.GetHistogramSum() -> double
 OpenTelemetry.Metrics.MetricPoint.LongValue.get -> long
 OpenTelemetry.Metrics.MetricPoint.MetricPoint() -> void
 OpenTelemetry.Metrics.MetricPoint.StartTime.get -> System.DateTimeOffset

diff --git a/src/OpenTelemetry/CHANGELOG.md b/src/OpenTelemetry/CHANGELOG.md
@@ -6,12 +6,16 @@
   `Keys`+`Values`
   ([#2642](https://github.com/open-telemetry/opentelemetry-dotnet/pull/2642))
 
+* Refactored `MetricPoint` and added public methods: `GetBucketCounts`,
+  `GetExplicitBounds`, `GetHistogramCount`, and `GetHistogramSum`
+  ([#2657](https://github.com/open-telemetry/opentelemetry-dotnet/pull/2657))
+
 ## 1.2.0-beta2
 
 Released 2021-Nov-19
 
-* Renamed `HistogramConfiguration` to `ExplicitBucketHistogramConfiguration`
-  and changed its member `BucketBounds` to `Boundaries`.
+* Renamed `HistogramConfiguration` to `ExplicitBucketHistogramConfiguration` and
+  changed its member `BucketBounds` to `Boundaries`.
   ([#2638](https://github.com/open-telemetry/opentelemetry-dotnet/pull/2638))
 
 * Metrics with the same name but from different meters are allowed.

diff --git a/src/OpenTelemetry/Metrics/HistogramMeasurements.cs b/src/OpenTelemetry/Metrics/HistogramMeasurements.cs
@@ -0,0 +1,45 @@
+// <copyright file="HistogramMeasurements.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.Metrics
+{
+    internal class HistogramMeasurements
+    {
+        internal readonly long[] BucketCounts;
+
+        internal readonly long[] AggregatedBucketCounts;
+
+        internal readonly double[] ExplicitBounds;
+
+        internal readonly object LockObject;
+
+        internal long CountVal;
+
+        internal long Count;
+
+        internal double SumVal;
+
+        internal double Sum;
+
+        internal HistogramMeasurements(double[] histogramBounds)
+        {
+            this.ExplicitBounds = histogramBounds;
+            this.BucketCounts = histogramBounds != null ? new long[histogramBounds.Length + 1] : null;
+            this.AggregatedBucketCounts = histogramBounds != null ? new long[histogramBounds.Length + 1] : null;
+            this.LockObject = new object();
+        }
+    }
+}