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

Base2ExponentialHistogramAggregation maxBuckets must be >= 2 #6093

Merged
merged 1 commit into from
Jan 4, 2024
Merged

Base2ExponentialHistogramAggregation maxBuckets must be >= 2 #6093

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
4 changes: 2 additions & 2 deletions ...test/java/io/opentelemetry/sdk/extension/incubator/fileconfig/AggregationFactoryTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,8 +62,8 @@ private static Stream<Arguments> createTestCases() {
Arguments.of(
new Aggregation()
.withBase2ExponentialBucketHistogram(
new Base2ExponentialBucketHistogram().withMaxSize(1).withMaxScale(2)),
io.opentelemetry.sdk.metrics.Aggregation.base2ExponentialBucketHistogram(1, 2)),
new Base2ExponentialBucketHistogram().withMaxSize(2).withMaxScale(2)),
io.opentelemetry.sdk.metrics.Aggregation.base2ExponentialBucketHistogram(2, 2)),
Arguments.of(
new Aggregation()
.withExplicitBucketHistogram(new ExplicitBucketHistogram().withBoundaries(null)),
Expand Down
2 changes: 1 addition & 1 deletion ...java/io/opentelemetry/sdk/metrics/internal/view/Base2ExponentialHistogramAggregation.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ public static Aggregation getDefault() {
* @return the aggregation
*/
public static Aggregation create(int maxBuckets, int maxScale) {
checkArgument(maxBuckets >= 1, "maxBuckets must be > 0");
checkArgument(maxBuckets >= 2, "maxBuckets must be >= 2");
checkArgument(maxScale <= 20 && maxScale >= -10, "maxScale must be -10 <= x <= 20");
return new Base2ExponentialHistogramAggregation(maxBuckets, maxScale);
}
Expand Down
4 changes: 2 additions & 2 deletions sdk/metrics/src/test/java/io/opentelemetry/sdk/metrics/AggregationTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,9 +31,9 @@ void haveToString() {
assertThat(Aggregation.base2ExponentialBucketHistogram())
.asString()
.isEqualTo("Base2ExponentialHistogramAggregation{maxBuckets=160,maxScale=20}");
assertThat(Aggregation.base2ExponentialBucketHistogram(1, 0))
assertThat(Aggregation.base2ExponentialBucketHistogram(2, 0))
.asString()
.isEqualTo("Base2ExponentialHistogramAggregation{maxBuckets=1,maxScale=0}");
.isEqualTo("Base2ExponentialHistogramAggregation{maxBuckets=2,maxScale=0}");
}

@Test
Expand Down
44 changes: 41 additions & 3 deletions .../io/opentelemetry/sdk/metrics/internal/view/Base2ExponentialHistogramAggregationTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,18 @@
import static org.assertj.core.api.Assertions.assertThat;
import static org.assertj.core.api.Assertions.assertThatThrownBy;

import io.opentelemetry.api.common.Attributes;
import io.opentelemetry.sdk.metrics.Aggregation;
import io.opentelemetry.sdk.metrics.InstrumentType;
import io.opentelemetry.sdk.metrics.InstrumentValueType;
import io.opentelemetry.sdk.metrics.data.ExemplarData;
import io.opentelemetry.sdk.metrics.data.ExponentialHistogramPointData;
import io.opentelemetry.sdk.metrics.internal.aggregator.Aggregator;
import io.opentelemetry.sdk.metrics.internal.aggregator.AggregatorFactory;
import io.opentelemetry.sdk.metrics.internal.aggregator.AggregatorHandle;
import io.opentelemetry.sdk.metrics.internal.descriptor.Advice;
import io.opentelemetry.sdk.metrics.internal.descriptor.InstrumentDescriptor;
import io.opentelemetry.sdk.metrics.internal.exemplar.ExemplarFilter;
import org.junit.jupiter.api.Test;

class Base2ExponentialHistogramAggregationTest {
Expand All @@ -22,12 +34,38 @@ void goodConfig() {
void invalidConfig_Throws() {
assertThatThrownBy(() -> Base2ExponentialHistogramAggregation.create(0, 20))
.isInstanceOf(IllegalArgumentException.class)
.hasMessage("maxBuckets must be > 0");
assertThatThrownBy(() -> Base2ExponentialHistogramAggregation.create(1, 21))
.hasMessage("maxBuckets must be >= 2");
assertThatThrownBy(() -> Base2ExponentialHistogramAggregation.create(2, 21))
.isInstanceOf(IllegalArgumentException.class)
.hasMessage("maxScale must be -10 <= x <= 20");
assertThatThrownBy(() -> Base2ExponentialHistogramAggregation.create(1, -11))
assertThatThrownBy(() -> Base2ExponentialHistogramAggregation.create(2, -11))
.isInstanceOf(IllegalArgumentException.class)
.hasMessage("maxScale must be -10 <= x <= 20");
}

@Test
void minimumBucketsCanAccommodateMaxRange() {
Aggregation aggregation = Base2ExponentialHistogramAggregation.create(2, 20);
Aggregator<ExponentialHistogramPointData, ExemplarData> aggregator =
((AggregatorFactory) aggregation)
.createAggregator(
InstrumentDescriptor.create(
"foo",
"description",
"unit",
InstrumentType.HISTOGRAM,
InstrumentValueType.DOUBLE,
Advice.empty()),
ExemplarFilter.alwaysOff());
AggregatorHandle<ExponentialHistogramPointData, ExemplarData> handle =
aggregator.createHandle();
// Record max range
handle.recordDouble(Double.MIN_VALUE);
handle.recordDouble(Double.MAX_VALUE);

ExponentialHistogramPointData pointData =
handle.aggregateThenMaybeReset(0, 1, Attributes.empty(), /* reset= */ true);
assertThat(pointData.getCount()).isEqualTo(2);
assertThat(pointData.getScale()).isEqualTo(-11);
}
}