Package io.opencensus.metrics
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.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description private static class
DoubleGauge.NoopDoubleGauge.NoopDoublePoint
No-op implementations of DoublePoint class.-
Nested classes/interfaces inherited from class io.opencensus.metrics.DoubleGauge
DoubleGauge.DoublePoint
-
-
Field Summary
Fields Modifier and Type Field Description private int
labelKeysSize
-
Constructor Summary
Constructors Constructor Description NoopDoubleGauge(java.lang.String name, java.lang.String description, java.lang.String unit, java.util.List<LabelKey> labelKeys)
Creates a newNoopDoublePoint
.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description void
clear()
Removes allTimeSeries
from the gauge metric.(package private) static DoubleGauge.NoopDoubleGauge
create(java.lang.String name, java.lang.String description, java.lang.String unit, java.util.List<LabelKey> labelKeys)
DoubleGauge.NoopDoubleGauge.NoopDoublePoint
getDefaultTimeSeries()
Returns aDoublePoint
for a gauge with all labels not set, or default labels.DoubleGauge.NoopDoubleGauge.NoopDoublePoint
getOrCreateTimeSeries(java.util.List<LabelValue> labelValues)
Creates aTimeSeries
and returns aDoublePoint
if the specifiedlabelValues
is not already associated with this gauge, else returns an existingDoublePoint
.void
removeTimeSeries(java.util.List<LabelValue> labelValues)
Removes theTimeSeries
from the gauge metric, if it is present.-
Methods inherited from class io.opencensus.metrics.DoubleGauge
newNoopDoubleGauge
-
-
-
-
Constructor Detail
-
NoopDoubleGauge
NoopDoubleGauge(java.lang.String name, java.lang.String description, java.lang.String unit, java.util.List<LabelKey> labelKeys)
Creates a newNoopDoublePoint
.
-
-
Method Detail
-
create
static DoubleGauge.NoopDoubleGauge create(java.lang.String name, java.lang.String description, java.lang.String unit, java.util.List<LabelKey> labelKeys)
-
getOrCreateTimeSeries
public DoubleGauge.NoopDoubleGauge.NoopDoublePoint getOrCreateTimeSeries(java.util.List<LabelValue> labelValues)
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
public DoubleGauge.NoopDoubleGauge.NoopDoublePoint 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
public void removeTimeSeries(java.util.List<LabelValue> labelValues)
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
-
-