Package io.opencensus.implcore.metrics

Class DerivedLongGaugeImpl

java.lang.Object

io.opencensus.metrics.DerivedLongGauge

io.opencensus.implcore.metrics.DerivedLongGaugeImpl

All Implemented Interfaces:

Meter

public final class DerivedLongGaugeImpl
extends DerivedLongGauge
implements Meter

Implementation of DerivedLongGauge.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	DerivedLongGaugeImpl.PointWithFunction<T>	Implementation of DerivedLongGaugeImpl.PointWithFunction with an object and a callback function.

Field Summary

Fields

Modifier and Type	Field	Description
private java.util.List<LabelValue>	constantLabelValues
private int	labelKeysSize
private MetricDescriptor	metricDescriptor
private java.util.Map<java.util.List<LabelValue>,DerivedLongGaugeImpl.PointWithFunction<?>>	registeredPoints

Constructor Summary

Constructors

Constructor	Description
DerivedLongGaugeImpl(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.
<T> void	createTimeSeries(java.util.List<LabelValue> labelValues, T obj, ToLongFunction<T> function)	Creates a TimeSeries.
Metric	getMetric(Clock clock)	Provides a Metric with one or more TimeSeries.
MetricDescriptor	getMetricDescriptor()	Provides a MetricDescriptor.
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

metricDescriptor

private final MetricDescriptor metricDescriptor

labelKeysSize

private final int labelKeysSize

constantLabelValues

private final java.util.List<LabelValue> constantLabelValues

registeredPoints

private volatile java.util.Map<java.util.List<LabelValue>,DerivedLongGaugeImpl.PointWithFunction<?>> registeredPoints

Constructor Detail

DerivedLongGaugeImpl

DerivedLongGaugeImpl(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

createTimeSeries

public <T> void createTimeSeries(java.util.List<LabelValue> labelValues,
                                 @Nullable
                                 T obj,
                                 ToLongFunction<T> function)

Description copied from class: DerivedLongGauge

Creates a TimeSeries. The value of a single point in the TimeSeries is observed from a callback function. This function is invoked whenever metrics are collected, meaning the reported value is up-to-date. It keeps a WeakReference to the object and it is the user's responsibility to manage the lifetime of the object.

Specified by:

createTimeSeries in class DerivedLongGauge

Type Parameters:

T - the type of the object upon which the function derives a measurement.

Parameters:

labelValues - the list of label values.

obj - the state object from which the function derives a measurement.

function - the function to be called.

removeTimeSeries

public void removeTimeSeries(java.util.List<LabelValue> labelValues)

Description copied from class: DerivedLongGauge

Removes the TimeSeries from the gauge metric, if it is present.

Specified by:

removeTimeSeries in class DerivedLongGauge

Parameters:

labelValues - the list of label values.

clear

public void clear()

Description copied from class: DerivedLongGauge

Removes all TimeSeries from the gauge metric.

Specified by:

clear in class DerivedLongGauge

getMetricDescriptor

public MetricDescriptor getMetricDescriptor()

Description copied from interface: Meter

Provides a MetricDescriptor.

Specified by:

getMetricDescriptor in interface Meter

Returns:

a MetricDescriptor.

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.