Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Rename to Base2ExponentialBucketHistogram to align with the latest spec #4079

Merged
merged 1 commit into from
Jan 13, 2023
Merged

Rename to Base2ExponentialBucketHistogram to align with the latest spec #4079

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions ...try/Metrics/ExponentialBucketHistogram.cs → ...etrics/Base2ExponentialBucketHistogram.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
// <copyright file="ExponentialBucketHistogram.cs" company="OpenTelemetry Authors">
// <copyright file="Base2ExponentialBucketHistogram.cs" company="OpenTelemetry Authors">
// Copyright The OpenTelemetry Authors
//
// Licensed under the Apache License, Version 2.0 (the "License");
Expand All @@ -25,23 +25,23 @@ namespace OpenTelemetry.Metrics;
/// identified by <c>Bucket[index] = ( base ^ index, base ^ (index + 1) ]</c>,
/// where <c>index</c> is an integer.
/// </summary>
internal sealed class ExponentialBucketHistogram
internal sealed class Base2ExponentialBucketHistogram
{
private int scale;
private double scalingFactor; // 2 ^ scale / log(2)

/// <summary>
/// Initializes a new instance of the <see cref="ExponentialBucketHistogram"/> class.
/// Initializes a new instance of the <see cref="Base2ExponentialBucketHistogram"/> class.
/// </summary>
/// <param name="maxBuckets">
/// The maximum number of buckets in each of the positive and negative ranges, not counting the special zero bucket. The default value is 160.
/// </param>
public ExponentialBucketHistogram(int maxBuckets = 160)
public Base2ExponentialBucketHistogram(int maxBuckets = 160)
: this(maxBuckets, 20)
{
}

internal ExponentialBucketHistogram(int maxBuckets, int scale)
internal Base2ExponentialBucketHistogram(int maxBuckets, int scale)
{
/*
The following table is calculated based on [ MapToIndex(double.Epsilon), MapToIndex(double.MaxValue) ]:
Expand Down
6 changes: 3 additions & 3 deletions ...xponentialBucketHistogramConfiguration.cs → ...xponentialBucketHistogramConfiguration.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
// <copyright file="ExponentialBucketHistogramConfiguration.cs" company="OpenTelemetry Authors">
// <copyright file="Base2ExponentialBucketHistogramConfiguration.cs" company="OpenTelemetry Authors">
// Copyright The OpenTelemetry Authors
//
// Licensed under the Apache License, Version 2.0 (the "License");
Expand All @@ -17,9 +17,9 @@
namespace OpenTelemetry.Metrics;

/// <summary>
/// Stores configuration for a histogram metric stream with exponential bucket boundaries.
/// Stores configuration for a histogram metric stream with base-2 exponential bucket boundaries.
/// </summary>
internal sealed class ExponentialBucketHistogramConfiguration : MetricStreamConfiguration
internal sealed class Base2ExponentialBucketHistogramConfiguration : MetricStreamConfiguration
{
/// <summary>
/// Gets or sets the maximum number of buckets in each of the positive and negative ranges, not counting the special zero bucket.
Expand Down
26 changes: 13 additions & 13 deletions ...Metrics/ExponentialBucketHistogramTest.cs → ...cs/Base2ExponentialBucketHistogramTest.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
// <copyright file="ExponentialBucketHistogramTest.cs" company="OpenTelemetry Authors">
// <copyright file="Base2ExponentialBucketHistogramTest.cs" company="OpenTelemetry Authors">
// Copyright The OpenTelemetry Authors
//
// Licensed under the Apache License, Version 2.0 (the "License");
Expand All @@ -19,12 +19,12 @@

namespace OpenTelemetry.Metrics.Tests;

public class ExponentialBucketHistogramTest
public class Base2ExponentialBucketHistogramTest
{
[Fact]
public void ScalingFactorCalculation()
{
var histogram = new ExponentialBucketHistogram();
var histogram = new Base2ExponentialBucketHistogram();

histogram.Scale = 20;
Assert.Equal("0 10000010011 0111000101010100011101100101001010111000001011111110", IEEE754Double.FromDouble(histogram.ScalingFactor).ToString());
Expand Down Expand Up @@ -140,7 +140,7 @@ public void IndexLookupScale0()
bucket[3]: (8, 16]
...
*/
var histogram = new ExponentialBucketHistogram(maxBuckets: 2, scale: 0);
var histogram = new Base2ExponentialBucketHistogram(maxBuckets: 2, scale: 0);

Assert.Equal(-1075, histogram.MapToIndex(IEEE754Double.FromString("0 00000000000 0000000000000000000000000000000000000000000000000001"))); // ~4.9406564584124654E-324 (minimum subnormal positive, double.Epsilon, 2 ^ -1074)
Assert.Equal(-1074, histogram.MapToIndex(IEEE754Double.FromString("0 00000000000 0000000000000000000000000000000000000000000000000010"))); // double.Epsilon * 2
Expand Down Expand Up @@ -199,7 +199,7 @@ public void IndexLookupScaleMinusOne()
bucket[3]: (64, 256]
...
*/
var histogram = new ExponentialBucketHistogram(maxBuckets: 2, scale: -1);
var histogram = new Base2ExponentialBucketHistogram(maxBuckets: 2, scale: -1);

Assert.Equal(-538, histogram.MapToIndex(IEEE754Double.FromString("0 00000000000 0000000000000000000000000000000000000000000000000001"))); // ~4.9406564584124654E-324 (minimum subnormal positive, double.Epsilon, 2 ^ -1074)
Assert.Equal(-537, histogram.MapToIndex(IEEE754Double.FromString("0 00000000000 0000000000000000000000000000000000000000000000000010"))); // double.Epsilon * 2
Expand Down Expand Up @@ -256,7 +256,7 @@ public void IndexLookupScaleMinusTwo()
bucket[3]: (4096, 65536]
...
*/
var histogram = new ExponentialBucketHistogram(maxBuckets: 2, scale: -2);
var histogram = new Base2ExponentialBucketHistogram(maxBuckets: 2, scale: -2);

Assert.Equal(-269, histogram.MapToIndex(IEEE754Double.FromString("0 00000000000 0000000000000000000000000000000000000000000000000001"))); // ~4.9406564584124654E-324 (minimum subnormal positive, double.Epsilon, 2 ^ -1074)
Assert.Equal(-269, histogram.MapToIndex(IEEE754Double.FromString("0 00000000000 0000000000000000000000000000000000000000000000000010"))); // double.Epsilon * 2
Expand Down Expand Up @@ -307,7 +307,7 @@ public void IndexLookupScaleMinusTen()
bucket[-1]: (2 ^ -1024, 1]
bucket[0]: (1, double.MaxValue]
*/
var histogram = new ExponentialBucketHistogram(maxBuckets: 2, scale: -10);
var histogram = new Base2ExponentialBucketHistogram(maxBuckets: 2, scale: -10);

Assert.Equal(-2, histogram.MapToIndex(IEEE754Double.FromString("0 00000000000 0000000000000000000000000000000000000000000000000001"))); // ~4.9406564584124654E-324 (minimum subnormal positive, double.Epsilon, 2 ^ -1074)
Assert.Equal(-2, histogram.MapToIndex(IEEE754Double.FromString("0 00000000000 0100000000000000000000000000000000000000000000000000"))); // ~5.562684646268003E-309 (2 ^ -1024)
Expand All @@ -330,7 +330,7 @@ public void IndexLookupScaleMinusEleven()
bucket[-1]: [double.Epsilon, 1]
bucket[0]: (1, double.MaxValue]
*/
var histogram = new ExponentialBucketHistogram(maxBuckets: 2, scale: -11);
var histogram = new Base2ExponentialBucketHistogram(maxBuckets: 2, scale: -11);

Assert.Equal(-1, histogram.MapToIndex(IEEE754Double.FromString("0 00000000000 0000000000000000000000000000000000000000000000000001"))); // ~4.9406564584124654E-324 (minimum subnormal positive, double.Epsilon, 2 ^ -1074)
Assert.Equal(-1, histogram.MapToIndex(IEEE754Double.FromString("0 00000000000 1111111111111111111111111111111111111111111111111111"))); // ~2.2250738585072009E-308 (maximum subnormal positive)
Expand Down Expand Up @@ -358,7 +358,7 @@ public void IndexLookupScaleOne()
bucket[3]: (2.8284271247461901, 4]
...
*/
var histogram = new ExponentialBucketHistogram(maxBuckets: 2, scale: 1);
var histogram = new Base2ExponentialBucketHistogram(maxBuckets: 2, scale: 1);

Assert.Equal(-2149, histogram.MapToIndex(IEEE754Double.FromString("0 00000000000 0000000000000000000000000000000000000000000000000001"))); // ~4.9406564584124654E-324 (minimum subnormal positive, double.Epsilon, 2 ^ -1074)
Assert.Equal(-2147, histogram.MapToIndex(IEEE754Double.FromString("0 00000000000 0000000000000000000000000000000000000000000000000010"))); // double.Epsilon * 2
Expand Down Expand Up @@ -424,7 +424,7 @@ 1048576 ___
...
*/

var histogram = new ExponentialBucketHistogram(maxBuckets: 2, scale: 20);
var histogram = new Base2ExponentialBucketHistogram(maxBuckets: 2, scale: 20);

Assert.Equal((-1074 * 1048576) - 1, histogram.MapToIndex(IEEE754Double.FromString("0 00000000000 0000000000000000000000000000000000000000000000000001"))); // ~4.9406564584124654E-324 (minimum subnormal positive, double.Epsilon, 2 ^ -1074)
Assert.Equal(-1, histogram.MapToIndex(IEEE754Double.FromString("0 01111111111 0000000000000000000000000000000000000000000000000000"))); // 1
Expand All @@ -435,7 +435,7 @@ 1048576 ___
[Fact]
public void InfinityHandling()
{
var histogram = new ExponentialBucketHistogram(maxBuckets: 2, scale: 0);
var histogram = new Base2ExponentialBucketHistogram(maxBuckets: 2, scale: 0);

histogram.Record(double.PositiveInfinity);
histogram.Record(double.NegativeInfinity);
Expand All @@ -446,7 +446,7 @@ public void InfinityHandling()
[Fact]
public void NaNHandling()
{
var histogram = new ExponentialBucketHistogram(maxBuckets: 2, scale: 0);
var histogram = new Base2ExponentialBucketHistogram(maxBuckets: 2, scale: 0);

histogram.Record(double.NaN); // NaN (language/runtime native)
histogram.Record(IEEE754Double.FromString("0 11111111111 0000000000000000000000000000000000000000000000000001").DoubleValue); // sNaN on x86/64 and ARM
Expand All @@ -459,7 +459,7 @@ public void NaNHandling()
[Fact]
public void ZeroHandling()
{
var histogram = new ExponentialBucketHistogram(maxBuckets: 2, scale: 0);
var histogram = new Base2ExponentialBucketHistogram(maxBuckets: 2, scale: 0);

histogram.Record(IEEE754Double.FromString("0 00000000000 0000000000000000000000000000000000000000000000000000").DoubleValue); // +0
histogram.Record(IEEE754Double.FromString("1 00000000000 0000000000000000000000000000000000000000000000000000").DoubleValue); // -0
Expand Down