Class DerivedLongCumulativeImpl

java.lang.Object

io.opencensus.metrics.DerivedLongCumulative

io.opencensus.implcore.metrics.DerivedLongCumulativeImpl

All Implemented Interfaces:

Meter

public final class DerivedLongCumulativeImpl
extends DerivedLongCumulative
implements Meter

Implementation of DerivedLongCumulative.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	DerivedLongCumulativeImpl.PointWithFunction<T>	Implementation of DerivedLongCumulativeImpl.PointWithFunction with an object and a callback function.

Field Summary

Fields

Modifier and Type	Field	Description
private final List<LabelValue>	constantLabelValues
private final int	labelKeysSize
private final MetricDescriptor	metricDescriptor
private Map<List<LabelValue>, DerivedLongCumulativeImpl.PointWithFunction<?>>	registeredPoints
private final Timestamp	startTime

Constructor Summary

Constructors

Constructor	Description
DerivedLongCumulativeImpl(String name, String description, String unit, List<LabelKey> labelKeys, Map<LabelKey, LabelValue> constantLabels, Timestamp startTime)

Method Summary

Modifier and Type	Method	Description
void	clear()	Removes all TimeSeries from the cumulative metric.
<T> void	createTimeSeries(List<LabelValue> labelValues, T obj, ToLongFunction<T> function)	Creates a TimeSeries.
Metric	getMetric(Clock clock)	Provides a Metric with one or more TimeSeries.
MetricDescriptor	getMetricDescriptor()	Provides a MetricDescriptor.
void	removeTimeSeries(List<LabelValue> labelValues)	Removes the TimeSeries from the cumulative metric, if it is present.

Methods inherited from class Object

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

Field Details

metricDescriptor

private final MetricDescriptor metricDescriptor

labelKeysSize

private final int labelKeysSize

constantLabelValues

private final List<LabelValue> constantLabelValues

startTime

private final Timestamp startTime

registeredPoints

private volatile Map<List<LabelValue>, DerivedLongCumulativeImpl.PointWithFunction<?>> registeredPoints

Constructor Details

DerivedLongCumulativeImpl

DerivedLongCumulativeImpl(String name,
 String description,
 String unit,
 List<LabelKey> labelKeys,
 Map<LabelKey, LabelValue> constantLabels,
 Timestamp startTime)

Method Details

createTimeSeries

public <T> void createTimeSeries(List<LabelValue> labelValues,
 @Nullable
 T obj,
 ToLongFunction<T> function)

Description copied from class: DerivedLongCumulative

Creates a TimeSeries. The value of a single point in the TimeSeries is observed from a callback function. This function is invoked whenever metrics are collected, meaning the reported value is up-to-date. It keeps a WeakReference to the object and it is the user's responsibility to manage the lifetime of the object.

Specified by:

createTimeSeries in class DerivedLongCumulative

Type Parameters:

T - the type of the object upon which the function derives a measurement.

Parameters:

labelValues - the list of label values.

obj - the state object from which the function derives a measurement.

function - the function to be called.

removeTimeSeries

public void removeTimeSeries(List<LabelValue> labelValues)

Description copied from class: DerivedLongCumulative

Removes the TimeSeries from the cumulative metric, if it is present.

Specified by:

removeTimeSeries in class DerivedLongCumulative

Parameters:

labelValues - the list of label values.

clear

public void clear()

Description copied from class: DerivedLongCumulative

Removes all TimeSeries from the cumulative metric.

Specified by:

clear in class DerivedLongCumulative

getMetricDescriptor

public MetricDescriptor getMetricDescriptor()

Description copied from interface: Meter

Provides a MetricDescriptor.

Specified by:

getMetricDescriptor in interface Meter

Returns:

a MetricDescriptor.

getMetric

@Nullable
public Metric getMetric(Clock clock)

Description copied from interface: Meter

Provides a Metric with one or more TimeSeries.

Specified by:

getMetric in interface Meter

Parameters:

clock - the clock used to get the time.

Returns:

a Metric.