Package io.opencensus.metrics
Class LongGauge.NoopLongGauge
- java.lang.Object
-
- io.opencensus.metrics.LongGauge
-
- io.opencensus.metrics.LongGauge.NoopLongGauge
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description private static class
LongGauge.NoopLongGauge.NoopLongPoint
No-op implementations of LongPoint class.-
Nested classes/interfaces inherited from class io.opencensus.metrics.LongGauge
LongGauge.LongPoint
-
-
Field Summary
Fields Modifier and Type Field Description private int
labelKeysSize
-
Constructor Summary
Constructors Constructor Description NoopLongGauge(java.lang.String name, java.lang.String description, java.lang.String unit, java.util.List<LabelKey> labelKeys)
Creates a newNoopLongPoint
.
-
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 LongGauge.NoopLongGauge
create(java.lang.String name, java.lang.String description, java.lang.String unit, java.util.List<LabelKey> labelKeys)
LongGauge.NoopLongGauge.NoopLongPoint
getDefaultTimeSeries()
Returns aLongPoint
for a gauge with all labels not set, or default labels.LongGauge.NoopLongGauge.NoopLongPoint
getOrCreateTimeSeries(java.util.List<LabelValue> labelValues)
Creates aTimeSeries
and returns aLongPoint
if the specifiedlabelValues
is not already associated with this gauge, else returns an existingLongPoint
.void
removeTimeSeries(java.util.List<LabelValue> labelValues)
Removes theTimeSeries
from the gauge metric, if it is present.-
Methods inherited from class io.opencensus.metrics.LongGauge
newNoopLongGauge
-
-
-
-
Constructor Detail
-
NoopLongGauge
NoopLongGauge(java.lang.String name, java.lang.String description, java.lang.String unit, java.util.List<LabelKey> labelKeys)
Creates a newNoopLongPoint
.
-
-
Method Detail
-
create
static LongGauge.NoopLongGauge create(java.lang.String name, java.lang.String description, java.lang.String unit, java.util.List<LabelKey> labelKeys)
-
getOrCreateTimeSeries
public LongGauge.NoopLongGauge.NoopLongPoint getOrCreateTimeSeries(java.util.List<LabelValue> labelValues)
Description copied from class:LongGauge
Creates aTimeSeries
and returns aLongPoint
if the specifiedlabelValues
is not already associated with this gauge, else returns an existingLongPoint
.It is recommended to keep a reference to the LongPoint instead of always calling this method for manual operations.
- Specified by:
getOrCreateTimeSeries
in classLongGauge
- Parameters:
labelValues
- the list of label values. The number of label values must be the same to that of the label keys passed toMetricRegistry.addLongGauge(java.lang.String, java.lang.String, java.lang.String, java.util.List<io.opencensus.metrics.LabelKey>)
.- Returns:
- a
LongPoint
the value of single gauge.
-
getDefaultTimeSeries
public LongGauge.NoopLongGauge.NoopLongPoint getDefaultTimeSeries()
Description copied from class:LongGauge
Returns aLongPoint
for a gauge with all labels not set, or default labels.- Specified by:
getDefaultTimeSeries
in classLongGauge
- Returns:
- a
LongPoint
for a gauge with all labels not set, or default labels.
-
removeTimeSeries
public void removeTimeSeries(java.util.List<LabelValue> labelValues)
Description copied from class:LongGauge
Removes theTimeSeries
from the gauge metric, if it is present. i.e. references to previousLongPoint
objects are invalid (not part of the metric).- Specified by:
removeTimeSeries
in classLongGauge
- Parameters:
labelValues
- the list of label values.
-
-