Class DropAggregator

java.lang.Object

io.opentelemetry.sdk.metrics.internal.aggregator.DropAggregator

All Implemented Interfaces:

Aggregator<PointData, DoubleExemplarData>

public final class DropAggregator
extends Object
implements Aggregator<PointData, DoubleExemplarData>

A "null object" Aggregator which denotes no aggregation should occur.

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 AggregatorHandle<PointData, DoubleExemplarData>	HANDLE
static final Aggregator<PointData, DoubleExemplarData>	INSTANCE
private static final PointData	POINT_DATA

Constructor Summary

Constructors

Modifier	Constructor	Description
private	DropAggregator()

Method Summary

Modifier and Type	Method	Description
AggregatorHandle<PointData, DoubleExemplarData>	createHandle()	Returns a new AggregatorHandle.
MetricData	toMetricData(Resource resource, InstrumentationScopeInfo instrumentationScopeInfo, MetricDescriptor metricDescriptor, Collection<PointData> points, AggregationTemporality temporality)	Returns the MetricData that this Aggregation will produce.

Methods inherited from class Object

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

Methods inherited from interface Aggregator

copyPoint, createReusablePoint, diff, diffInPlace, toPoint, toPoint

Field Details

POINT_DATA

private static final PointData POINT_DATA

INSTANCE

public static final Aggregator<PointData, DoubleExemplarData> INSTANCE

HANDLE

private static final AggregatorHandle<PointData, DoubleExemplarData> HANDLE

Constructor Details

DropAggregator

private DropAggregator()

Method Details

createHandle

public AggregatorHandle<PointData, DoubleExemplarData> createHandle()

Description copied from interface: Aggregator

Returns a new AggregatorHandle. This MUST by used by the synchronous to aggregate recorded measurements during the collection cycle.

Specified by:

createHandle in interface Aggregator<PointData, DoubleExemplarData>

Returns:

a new AggregatorHandle.

toMetricData

public MetricData toMetricData(Resource resource,
 InstrumentationScopeInfo instrumentationScopeInfo,
 MetricDescriptor metricDescriptor,
 Collection<PointData> points,
 AggregationTemporality temporality)

Description copied from interface: Aggregator

Returns the MetricData that this Aggregation will produce.

Specified by:

toMetricData in interface Aggregator<PointData, DoubleExemplarData>

Parameters:

resource - the resource producing the metric.

instrumentationScopeInfo - the scope that instrumented the metric.

metricDescriptor - the name, description and unit of the metric.

points - list of points

temporality - the temporality of the metric.

Returns:

the MetricDataType that this Aggregation will produce.