Class DerivedDoubleGauge.NoopDerivedDoubleGauge

java.lang.Object

io.opencensus.metrics.DerivedDoubleGauge

io.opencensus.metrics.DerivedDoubleGauge.NoopDerivedDoubleGauge

Enclosing class:

DerivedDoubleGauge

private static final class DerivedDoubleGauge.NoopDerivedDoubleGauge
extends DerivedDoubleGauge

No-op implementations of DerivedDoubleGauge class.

Since:

0.17

Field Summary

Fields

Modifier and Type	Field	Description
private final int	labelKeysSize

Constructor Summary

Constructors

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

Method Summary

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

Methods inherited from class DerivedDoubleGauge

newNoopDerivedDoubleGauge

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

NoopDerivedDoubleGauge

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

Creates a new NoopDerivedDoubleGauge.

Method Details

create

static DerivedDoubleGauge.NoopDerivedDoubleGauge create(String name,
 String description,
 String unit,
 List<LabelKey> labelKeys)

createTimeSeries

public <T> void createTimeSeries(List<LabelValue> labelValues,
 T obj,
 ToDoubleFunction<T> function)

Description copied from class: DerivedDoubleGauge

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 DerivedDoubleGauge

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: DerivedDoubleGauge

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

Specified by:

removeTimeSeries in class DerivedDoubleGauge

Parameters:

labelValues - the list of label values.

clear

public void clear()

Description copied from class: DerivedDoubleGauge

Removes all TimeSeries from the gauge metric.

Specified by:

clear in class DerivedDoubleGauge