Package io.opencensus.implcore.metrics

Class DoubleGaugeImpl

java.lang.Object

io.opencensus.metrics.DoubleGauge

io.opencensus.implcore.metrics.DoubleGaugeImpl

All Implemented Interfaces:

Meter

public final class DoubleGaugeImpl
extends DoubleGauge
implements Meter

Implementation of DoubleGauge.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	DoubleGaugeImpl.PointImpl	Implementation of DoubleGauge.DoublePoint.

Nested classes/interfaces inherited from class io.opencensus.metrics.DoubleGauge

DoubleGauge.DoublePoint

Field Summary

Fields

Modifier and Type	Field	Description
private java.util.List<LabelValue>	constantLabelValues
private java.util.List<LabelValue>	defaultLabelValues
private int	labelKeysSize
private MetricDescriptor	metricDescriptor
private java.util.Map<java.util.List<LabelValue>,DoubleGaugeImpl.PointImpl>	registeredPoints
(package private) static LabelValue	UNSET_VALUE

Constructor Summary

Constructors

Constructor	Description
DoubleGaugeImpl(java.lang.String name, java.lang.String description, java.lang.String unit, java.util.List<LabelKey> labelKeys, java.util.Map<LabelKey,LabelValue> constantLabels)

Method Summary

Modifier and Type	Method	Description
void	clear()	Removes all TimeSeries from the gauge metric.
DoubleGauge.DoublePoint	getDefaultTimeSeries()	Returns a DoublePoint for a gauge with all labels not set, or default labels.
Metric	getMetric(Clock clock)	Provides a Metric with one or more TimeSeries.
MetricDescriptor	getMetricDescriptor()	Provides a MetricDescriptor.
DoubleGauge.DoublePoint	getOrCreateTimeSeries(java.util.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.
private DoubleGauge.DoublePoint	registerTimeSeries(java.util.List<LabelValue> labelValues)
void	removeTimeSeries(java.util.List<LabelValue> labelValues)	Removes the TimeSeries from the gauge metric, if it is present.

Methods inherited from class java.lang.Object

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

Field Detail

UNSET_VALUE

static final LabelValue UNSET_VALUE

metricDescriptor

private final MetricDescriptor metricDescriptor

registeredPoints

private volatile java.util.Map<java.util.List<LabelValue>,DoubleGaugeImpl.PointImpl> registeredPoints

labelKeysSize

private final int labelKeysSize

defaultLabelValues

private final java.util.List<LabelValue> defaultLabelValues

constantLabelValues

private final java.util.List<LabelValue> constantLabelValues

Constructor Detail

DoubleGaugeImpl

DoubleGaugeImpl(java.lang.String name,
                java.lang.String description,
                java.lang.String unit,
                java.util.List<LabelKey> labelKeys,
                java.util.Map<LabelKey,LabelValue> constantLabels)

Method Detail

getOrCreateTimeSeries

public DoubleGauge.DoublePoint getOrCreateTimeSeries(java.util.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(java.lang.String, java.lang.String, java.lang.String, java.util.List<io.opencensus.metrics.LabelKey>).

Returns:

a DoublePoint the value of single gauge.

getDefaultTimeSeries

public DoubleGauge.DoublePoint 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(java.util.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

getMetricDescriptor

public MetricDescriptor getMetricDescriptor()

Description copied from interface: Meter

Provides a MetricDescriptor.

Specified by:

getMetricDescriptor in interface Meter

Returns:

a MetricDescriptor.

registerTimeSeries

private DoubleGauge.DoublePoint registerTimeSeries(java.util.List<LabelValue> labelValues)

getMetric

@Nullable
public Metric getMetric(Clock clock)

Description copied from interface: Meter

Provides a Metric with one or more TimeSeries.

Specified by:

getMetric in interface Meter

Parameters:

clock - the clock used to get the time.

Returns:

a Metric.