Class DerivedLongCumulative.NoopDerivedLongCumulative

java.lang.Object

io.opencensus.metrics.DerivedLongCumulative

io.opencensus.metrics.DerivedLongCumulative.NoopDerivedLongCumulative

Enclosing class:

DerivedLongCumulative

private static final class DerivedLongCumulative.NoopDerivedLongCumulative
extends DerivedLongCumulative

No-op implementations of DerivedLongCumulative class.

Since:

0.21

Field Summary

Fields

Modifier and Type	Field	Description
private final int	labelKeysSize

Constructor Summary

Constructors

Constructor	Description
NoopDerivedLongCumulative(String name, String description, String unit, List<LabelKey> labelKeys)	Creates a new NoopDerivedLongCumulative.

Method Summary

Modifier and Type	Method	Description
void	clear()	Removes all TimeSeries from the cumulative metric.
(package private) static DerivedLongCumulative.NoopDerivedLongCumulative	create(String name, String description, String unit, List<LabelKey> labelKeys)
<T> void	createTimeSeries(List<LabelValue> labelValues, T obj, ToLongFunction<T> function)	Creates a TimeSeries.
void	removeTimeSeries(List<LabelValue> labelValues)	Removes the TimeSeries from the cumulative metric, if it is present.

Methods inherited from class DerivedLongCumulative

newNoopDerivedLongCumulative

Methods inherited from class Object

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

Field Details

labelKeysSize

private final int labelKeysSize

Constructor Details

NoopDerivedLongCumulative

NoopDerivedLongCumulative(String name,
 String description,
 String unit,
 List<LabelKey> labelKeys)

Creates a new NoopDerivedLongCumulative.

Method Details

create

static DerivedLongCumulative.NoopDerivedLongCumulative create(String name,
 String description,
 String unit,
 List<LabelKey> labelKeys)

createTimeSeries

public <T> void createTimeSeries(List<LabelValue> labelValues,
 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