Package io.opencensus.implcore.metrics
Class LongGaugeImpl
- java.lang.Object
-
- io.opencensus.metrics.LongGauge
-
- io.opencensus.implcore.metrics.LongGaugeImpl
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
LongGaugeImpl.PointImpl
Implementation ofLongGauge.LongPoint
.-
Nested classes/interfaces inherited from class io.opencensus.metrics.LongGauge
LongGauge.LongPoint
-
-
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>,LongGaugeImpl.PointImpl>
registeredPoints
(package private) static LabelValue
UNSET_VALUE
-
Constructor Summary
Constructors Constructor Description LongGaugeImpl(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
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
clear()
Removes allTimeSeries
from the gauge metric.LongGauge.LongPoint
getDefaultTimeSeries()
Returns aLongPoint
for a gauge with all labels not set, or default labels.Metric
getMetric(Clock clock)
Provides aMetric
with one or moreTimeSeries
.MetricDescriptor
getMetricDescriptor()
Provides aMetricDescriptor
.LongGauge.LongPoint
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
.private LongGauge.LongPoint
registerTimeSeries(java.util.List<LabelValue> labelValues)
void
removeTimeSeries(java.util.List<LabelValue> labelValues)
Removes theTimeSeries
from the gauge metric, if it is present.
-
-
-
Field Detail
-
UNSET_VALUE
static final LabelValue UNSET_VALUE
-
metricDescriptor
private final MetricDescriptor metricDescriptor
-
registeredPoints
private volatile java.util.Map<java.util.List<LabelValue>,LongGaugeImpl.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
-
LongGaugeImpl
LongGaugeImpl(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 LongGauge.LongPoint 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.LongPoint 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.
-
clear
public void clear()
Description copied from class:LongGauge
Removes allTimeSeries
from the gauge metric. i.e. references to all previousLongPoint
objects are invalid (not part of the metric).
-
getMetricDescriptor
public MetricDescriptor getMetricDescriptor()
Description copied from interface:Meter
Provides aMetricDescriptor
.- Specified by:
getMetricDescriptor
in interfaceMeter
- Returns:
- a
MetricDescriptor
.
-
registerTimeSeries
private LongGauge.LongPoint registerTimeSeries(java.util.List<LabelValue> labelValues)
-
-