Class DerivedLongGauge.NoopDerivedLongGauge

java.lang.Object

io.opencensus.metrics.DerivedLongGauge

io.opencensus.metrics.DerivedLongGauge.NoopDerivedLongGauge

Enclosing class:

DerivedLongGauge

private static final class DerivedLongGauge.NoopDerivedLongGauge
extends DerivedLongGauge

No-op implementations of DerivedLongGauge class.

Since:

0.17

Field Summary

Fields

Modifier and Type	Field	Description
private final int	labelKeysSize

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
void	clear()	Removes all TimeSeries from the gauge metric.
(package private) static DerivedLongGauge.NoopDerivedLongGauge	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 gauge metric, if it is present.

Methods inherited from class DerivedLongGauge

newNoopDerivedLongGauge

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

NoopDerivedLongGauge

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

Creates a new NoopDerivedLongGauge.

Method Details

create

static DerivedLongGauge.NoopDerivedLongGauge 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: DerivedLongGauge

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 DerivedLongGauge

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

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

Specified by:

removeTimeSeries in class DerivedLongGauge

Parameters:

labelValues - the list of label values.

clear

public void clear()

Description copied from class: DerivedLongGauge

Removes all TimeSeries from the gauge metric.

Specified by:

clear in class DerivedLongGauge