Package io.opencensus.implcore.metrics
Class DoubleGaugeImpl
java.lang.Object
io.opencensus.metrics.DoubleGauge
io.opencensus.implcore.metrics.DoubleGaugeImpl
- All Implemented Interfaces:
Meter
Implementation of
DoubleGauge
.-
Nested Class Summary
Nested ClassesNested classes/interfaces inherited from class io.opencensus.metrics.DoubleGauge
DoubleGauge.DoublePoint
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate final List
<LabelValue> private final List
<LabelValue> private final int
private final MetricDescriptor
private Map
<List<LabelValue>, DoubleGaugeImpl.PointImpl> (package private) static final LabelValue
-
Constructor Summary
ConstructorsConstructorDescriptionDoubleGaugeImpl
(String name, String description, String unit, List<LabelKey> labelKeys, Map<LabelKey, LabelValue> constantLabels) -
Method Summary
Modifier and TypeMethodDescriptionvoid
clear()
Removes allTimeSeries
from the gauge metric.Returns aDoublePoint
for a gauge with all labels not set, or default labels.Provides aMetric
with one or moreTimeSeries
.Provides aMetricDescriptor
.getOrCreateTimeSeries
(List<LabelValue> labelValues) Creates aTimeSeries
and returns aDoublePoint
if the specifiedlabelValues
is not already associated with this gauge, else returns an existingDoublePoint
.private DoubleGauge.DoublePoint
registerTimeSeries
(List<LabelValue> labelValues) void
removeTimeSeries
(List<LabelValue> labelValues) Removes theTimeSeries
from the gauge metric, if it is present.
-
Field Details
-
UNSET_VALUE
-
metricDescriptor
-
registeredPoints
-
labelKeysSize
private final int labelKeysSize -
defaultLabelValues
-
constantLabelValues
-
-
Constructor Details
-
DoubleGaugeImpl
-
-
Method Details
-
getOrCreateTimeSeries
Description copied from class:DoubleGauge
Creates aTimeSeries
and returns aDoublePoint
if the specifiedlabelValues
is not already associated with this gauge, else returns an existingDoublePoint
.It is recommended to keep a reference to the DoublePoint instead of always calling this method for manual operations.
- Specified by:
getOrCreateTimeSeries
in classDoubleGauge
- Parameters:
labelValues
- the list of label values. The number of label values must be the same to that of the label keys passed toMetricRegistry.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
Description copied from class:DoubleGauge
Returns aDoublePoint
for a gauge with all labels not set, or default labels.- Specified by:
getDefaultTimeSeries
in classDoubleGauge
- Returns:
- a
DoublePoint
for a gauge with all labels not set, or default labels.
-
removeTimeSeries
Description copied from class:DoubleGauge
Removes theTimeSeries
from the gauge metric, if it is present. i.e. references to previousDoublePoint
objects are invalid (not part of the metric).- Specified by:
removeTimeSeries
in classDoubleGauge
- Parameters:
labelValues
- the list of label values.
-
clear
public void clear()Description copied from class:DoubleGauge
Removes allTimeSeries
from the gauge metric. i.e. references to all previousDoublePoint
objects are invalid (not part of the metric).- Specified by:
clear
in classDoubleGauge
-
getMetricDescriptor
Description copied from interface:Meter
Provides aMetricDescriptor
.- Specified by:
getMetricDescriptor
in interfaceMeter
- Returns:
- a
MetricDescriptor
.
-
registerTimeSeries
-
getMetric
Description copied from interface:Meter
Provides aMetric
with one or moreTimeSeries
.
-