io.opentelemetry.sdk.metrics.view

Interface Aggregation

@Immutable
public interface Aggregation

Aggregation is the process of combining a certain set of recorded measurements for a given Instrument into the equivalent MetricData.

Method Summary

Modifier and Type	Method and Description
boolean	availableForInstrument(InstrumentType instrumentType) Returns true if this Aggregation can be applied to the given InstrumentType.
AggregatorFactory	getAggregatorFactory(InstrumentValueType instrumentValueType) Returns an AggregationFactory that can be used to produce the Aggregator that needs to be used to aggregate all the values to produce this Aggregation.
MetricData.Type	getDescriptorType(InstrumentType instrumentType, InstrumentValueType instrumentValueType) Returns the MetricData.Type that this Aggregation will produce.
String	getUnit(String initialUnit) Returns the unit that this Aggregation will produce.

Method Detail

getAggregatorFactory

AggregatorFactory getAggregatorFactory(InstrumentValueType instrumentValueType)

Returns an AggregationFactory that can be used to produce the Aggregator that needs to be used to aggregate all the values to produce this Aggregation.

Parameters:

instrumentValueType - the type of recorded values for the Instrument.

Returns:

the AggregationFactory.

getDescriptorType

MetricData.Type getDescriptorType(InstrumentType instrumentType,
                                  InstrumentValueType instrumentValueType)

Returns the MetricData.Type that this Aggregation will produce.

Parameters:

instrumentType - the type of the Instrument.

instrumentValueType - the type of recorded values for the Instrument.

Returns:

the MetricData.Type that this Aggregation will produce.

getUnit

String getUnit(String initialUnit)

Returns the unit that this Aggregation will produce.

Parameters:

initialUnit - the initial unit for the Instrument's measurements.

Returns:

the unit that this Aggregation will produce.

availableForInstrument

boolean availableForInstrument(InstrumentType instrumentType)

Returns true if this Aggregation can be applied to the given InstrumentType.

Parameters:

instrumentType - the type of the Instrument.

Returns:

true if this Aggregation can be applied to the given InstrumentType.