io.opentelemetry.sdk.metrics.internal.data.ImmutableHistogramPointData Maven / Gradle / Ivy
/*
* Copyright The OpenTelemetry Authors
* SPDX-License-Identifier: Apache-2.0
*/
package io.opentelemetry.sdk.metrics.internal.data;
import com.google.auto.value.AutoValue;
import io.opentelemetry.api.common.Attributes;
import io.opentelemetry.sdk.internal.PrimitiveLongList;
import io.opentelemetry.sdk.metrics.data.DoubleExemplarData;
import io.opentelemetry.sdk.metrics.data.HistogramPointData;
import java.util.ArrayList;
import java.util.Collections;
import java.util.List;
import javax.annotation.Nullable;
import javax.annotation.concurrent.Immutable;
/**
* An approximate representation of the distribution of measurements.
*
* This class is internal and is hence not for public use. Its APIs are unstable and can change
* at any time.
*/
@Immutable
@AutoValue
public abstract class ImmutableHistogramPointData implements HistogramPointData {
/**
* Creates a HistogramPointData. For a Histogram with N defined boundaries, there should be N+1
* counts.
*
* @return a HistogramPointData.
* @throws IllegalArgumentException if the given boundaries/counts were invalid
*/
public static ImmutableHistogramPointData create(
long startEpochNanos,
long epochNanos,
Attributes attributes,
double sum,
@Nullable Double min,
@Nullable Double max,
List boundaries,
List counts) {
return create(
startEpochNanos,
epochNanos,
attributes,
sum,
min,
max,
boundaries,
counts,
Collections.emptyList());
}
/**
* Creates a HistogramPointData. For a Histogram with N defined boundaries, there should be N+1
* counts.
*
* @return a HistogramPointData.
* @throws IllegalArgumentException if the given boundaries/counts were invalid
*/
public static ImmutableHistogramPointData create(
long startEpochNanos,
long epochNanos,
Attributes attributes,
double sum,
@Nullable Double min,
@Nullable Double max,
List boundaries,
List counts,
List exemplars) {
if (counts.size() != boundaries.size() + 1) {
throw new IllegalArgumentException(
"invalid counts: size should be "
+ (boundaries.size() + 1)
+ " instead of "
+ counts.size());
}
if (!isStrictlyIncreasing(boundaries)) {
throw new IllegalArgumentException("invalid boundaries: " + boundaries);
}
if (!boundaries.isEmpty()
&& (boundaries.get(0).isInfinite() || boundaries.get(boundaries.size() - 1).isInfinite())) {
throw new IllegalArgumentException("invalid boundaries: contains explicit +/-Inf");
}
long totalCount = 0;
for (long c : PrimitiveLongList.toArray(counts)) {
totalCount += c;
}
return new AutoValue_ImmutableHistogramPointData(
startEpochNanos,
epochNanos,
attributes,
sum,
totalCount,
min != null,
min != null ? min : -1,
max != null,
max != null ? max : -1,
Collections.unmodifiableList(new ArrayList<>(boundaries)),
Collections.unmodifiableList(new ArrayList<>(counts)),
exemplars);
}
ImmutableHistogramPointData() {}
private static boolean isStrictlyIncreasing(List xs) {
for (int i = 0; i < xs.size() - 1; i++) {
if (xs.get(i).compareTo(xs.get(i + 1)) >= 0) {
return false;
}
}
return true;
}
}