Class Base2ExponentialHistogramAggregation

java.lang.Object

io.opentelemetry.sdk.metrics.internal.view.Base2ExponentialHistogramAggregation

All Implemented Interfaces:

Aggregation, AggregatorFactory

public final class Base2ExponentialHistogramAggregation
extends Object
implements Aggregation, AggregatorFactory

Exponential bucket histogram aggregation configuration.

This class is internal and is hence not for public use. Its APIs are unstable and can change at any time.

Field Summary

Fields

Modifier and Type	Field	Description
private static final Aggregation	DEFAULT
private static final int	DEFAULT_MAX_BUCKETS
private static final int	DEFAULT_MAX_SCALE
private final int	maxBuckets
private final int	maxScale

Constructor Summary

Constructors

Modifier	Constructor	Description
private	Base2ExponentialHistogramAggregation(int maxBuckets, int maxScale)

Method Summary

Modifier and Type	Method	Description
static Aggregation	create(int maxBuckets, int maxScale)	Aggregations measurements into an MetricDataType.EXPONENTIAL_HISTOGRAM.
<T extends PointData, U extends ExemplarData> Aggregator<T,U>	createAggregator(InstrumentDescriptor instrumentDescriptor, ExemplarFilter exemplarFilter, MemoryMode memoryMode)	Returns a new Aggregator.
static Aggregation	getDefault()
boolean	isCompatibleWithInstrument(InstrumentDescriptor instrumentDescriptor)	Determine if the Aggregator produced by AggregatorFactory.createAggregator(InstrumentDescriptor, ExemplarFilter, MemoryMode) is compatible with the instrumentDescriptor.
String	toString()

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details

DEFAULT_MAX_BUCKETS

private static final int DEFAULT_MAX_BUCKETS

See Also:

• Constant Field Values

DEFAULT_MAX_SCALE

private static final int DEFAULT_MAX_SCALE

See Also:

• Constant Field Values

DEFAULT

private static final Aggregation DEFAULT

maxBuckets

private final int maxBuckets

maxScale

private final int maxScale

Constructor Details

Base2ExponentialHistogramAggregation

private Base2ExponentialHistogramAggregation(int maxBuckets,
 int maxScale)

Method Details

getDefault

public static Aggregation getDefault()

create

public static Aggregation create(int maxBuckets,
 int maxScale)

Aggregations measurements into an MetricDataType.EXPONENTIAL_HISTOGRAM.

Parameters:

maxBuckets - the max number of positive buckets and negative buckets (max total buckets is 2 * maxBuckets + 1 zero bucket).

maxScale - the maximum and initial scale. If measurements can't fit in a particular scale given the maxBuckets, the scale is reduced until the measurements can be accommodated. Setting maxScale may reduce the number of downscales. Additionally, the performance of computing bucket index is improved when scale is invalid input: '<'= 0.

Returns:

the aggregation

createAggregator

public <T extends PointData, U extends ExemplarData>
Aggregator<T,U> createAggregator(InstrumentDescriptor instrumentDescriptor,
 ExemplarFilter exemplarFilter,
 MemoryMode memoryMode)

Description copied from interface: AggregatorFactory

Returns a new Aggregator.

Specified by:

createAggregator in interface AggregatorFactory

Parameters:

instrumentDescriptor - the descriptor of the Instrument that will record measurements.

exemplarFilter - the filter on which measurements should turn into exemplars

memoryMode - The MemoryMode the aggregator will use

Returns:

a new Aggregator. Aggregator.drop() indicates no measurements should be recorded.

isCompatibleWithInstrument

public boolean isCompatibleWithInstrument(InstrumentDescriptor instrumentDescriptor)

Description copied from interface: AggregatorFactory

Determine if the Aggregator produced by AggregatorFactory.createAggregator(InstrumentDescriptor, ExemplarFilter, MemoryMode) is compatible with the instrumentDescriptor.

Specified by:

isCompatibleWithInstrument in interface AggregatorFactory

toString

public String toString()

Overrides:

toString in class Object