Class LongGaugeImpl

java.lang.Object

io.opencensus.metrics.LongGauge

io.opencensus.implcore.metrics.LongGaugeImpl

public final class LongGaugeImpl
extends LongGauge

Implementation of LongGauge.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	LongGaugeImpl.PointImpl	Implementation of LongGauge.LongPoint.

Nested classes/interfaces inherited from class LongGauge

LongGauge.LongPoint

Method Summary

Modifier and Type	Method	Description
void	clear()	Removes all TimeSeries from the gauge metric. i.e. references to all previous LongPoint objects are invalid (not part of the metric).
LongGauge.LongPoint	getDefaultTimeSeries()	Returns a LongPoint for a gauge with all labels not set, or default labels.
Metric	getMetric(Clock clock)
MetricDescriptor	getMetricDescriptor()
LongGauge.LongPoint	getOrCreateTimeSeries(List<LabelValue> labelValues)	Creates a TimeSeries and returns a LongPoint if the specified labelValues is not already associated with this gauge, else returns an existing LongPoint.
void	removeTimeSeries(List<LabelValue> labelValues)	Removes the TimeSeries from the gauge metric, if it is present. i.e. references to previous LongPoint objects are invalid (not part of the metric).

Methods inherited from class Object

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

Method Details

getOrCreateTimeSeries

public LongGauge.LongPoint getOrCreateTimeSeries(List<LabelValue> labelValues)

Description copied from class: LongGauge

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

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

Specified by:

getOrCreateTimeSeries in class LongGauge

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.addLongGauge(String, String, String, List).

Returns:

a LongPoint the value of single gauge.

getDefaultTimeSeries

public LongGauge.LongPoint getDefaultTimeSeries()

Description copied from class: LongGauge

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

Specified by:

getDefaultTimeSeries in class LongGauge

Returns:

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

removeTimeSeries

public void removeTimeSeries(List<LabelValue> labelValues)

Description copied from class: LongGauge

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

Specified by:

removeTimeSeries in class LongGauge

Parameters:

labelValues - the list of label values.

clear

public void clear()

Description copied from class: LongGauge

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

Specified by:

clear in class LongGauge

getMetricDescriptor

public MetricDescriptor getMetricDescriptor()

getMetric

@Nullable
public Metric getMetric(Clock clock)