Class DoubleGauge.NoopDoubleGauge

java.lang.Object

io.opencensus.metrics.DoubleGauge

io.opencensus.metrics.DoubleGauge.NoopDoubleGauge

Enclosing class:

DoubleGauge

private static final class DoubleGauge.NoopDoubleGauge
extends DoubleGauge

No-op implementations of DoubleGauge class.

Since:

0.17

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private static final class	DoubleGauge.NoopDoubleGauge.NoopDoublePoint	No-op implementations of DoublePoint class.

Nested classes/interfaces inherited from class DoubleGauge

DoubleGauge.DoublePoint

Field Summary

Fields

Modifier and Type	Field	Description
private final int	labelKeysSize

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
void	clear()	Removes all TimeSeries from the gauge metric.
(package private) static DoubleGauge.NoopDoubleGauge	create(String name, String description, String unit, List<LabelKey> labelKeys)
DoubleGauge.NoopDoubleGauge.NoopDoublePoint	getDefaultTimeSeries()	Returns a DoublePoint for a gauge with all labels not set, or default labels.
DoubleGauge.NoopDoubleGauge.NoopDoublePoint	getOrCreateTimeSeries(List<LabelValue> labelValues)	Creates a TimeSeries and returns a DoublePoint if the specified labelValues is not already associated with this gauge, else returns an existing DoublePoint.
void	removeTimeSeries(List<LabelValue> labelValues)	Removes the TimeSeries from the gauge metric, if it is present.

Methods inherited from class DoubleGauge

newNoopDoubleGauge

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

NoopDoubleGauge

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

Creates a new NoopDoublePoint.

Method Details

create

static DoubleGauge.NoopDoubleGauge create(String name,
 String description,
 String unit,
 List<LabelKey> labelKeys)

getOrCreateTimeSeries

public DoubleGauge.NoopDoubleGauge.NoopDoublePoint getOrCreateTimeSeries(List<LabelValue> labelValues)

Description copied from class: DoubleGauge

Creates a TimeSeries and returns a DoublePoint if the specified labelValues is not already associated with this gauge, else returns an existing DoublePoint.

It is recommended to keep a reference to the DoublePoint instead of always calling this method for manual operations.

Specified by:

getOrCreateTimeSeries in class DoubleGauge

Parameters:

labelValues - the list of label values. The number of label values must be the same to that of the label keys passed to MetricRegistry.addDoubleGauge(String, String, String, List).

Returns:

a DoublePoint the value of single gauge.

getDefaultTimeSeries

public DoubleGauge.NoopDoubleGauge.NoopDoublePoint getDefaultTimeSeries()

Description copied from class: DoubleGauge

Returns a DoublePoint for a gauge with all labels not set, or default labels.

Specified by:

getDefaultTimeSeries in class DoubleGauge

Returns:

a DoublePoint for a gauge with all labels not set, or default labels.

removeTimeSeries

public void removeTimeSeries(List<LabelValue> labelValues)

Description copied from class: DoubleGauge

Removes the TimeSeries from the gauge metric, if it is present. i.e. references to previous DoublePoint objects are invalid (not part of the metric).

Specified by:

removeTimeSeries in class DoubleGauge

Parameters:

labelValues - the list of label values.

clear

public void clear()

Description copied from class: DoubleGauge

Removes all TimeSeries from the gauge metric. i.e. references to all previous DoublePoint objects are invalid (not part of the metric).

Specified by:

clear in class DoubleGauge