Package io.opencensus.metrics

Class LongCumulative

java.lang.Object

io.opencensus.metrics.LongCumulative

Direct Known Subclasses:

LongCumulative.NoopLongCumulative, LongCumulativeImpl

@ThreadSafe
public abstract class LongCumulative
extends java.lang.Object

Long Cumulative metric, to report instantaneous measurement of an int64 value. Cumulative values can go up or stay the same, but can never go down. Cumulative values cannot be negative.

Example 1: Create a Cumulative with default labels.

 class YourClass {

   private static final MetricRegistry metricRegistry = Metrics.getMetricRegistry();

   List<LabelKey> labelKeys = Arrays.asList(LabelKey.create("Name", "desc"));

   LongCumulative cumulative = metricRegistry.addLongCumulative(
     "processed_jobs", "Processed jobs", "1", labelKeys);

   // It is recommended to keep a reference of a point for manual operations.
   LongPoint defaultPoint = cumulative.getDefaultTimeSeries();

   void doWork() {
      // Your code here.
      defaultPoint.add(10);
   }

 }
 

Example 2: You can also use labels(keys and values) to track different types of metric.

 class YourClass {

   private static final MetricRegistry metricRegistry = Metrics.getMetricRegistry();

   List<LabelKey> labelKeys = Arrays.asList(LabelKey.create("Name", "desc"));
   List<LabelValue> labelValues = Arrays.asList(LabelValue.create("Inbound"));

   LongCumulative cumulative = metricRegistry.addLongCumulative(
     "processed_jobs", "Processed jobs", "1", labelKeys);

   // It is recommended to keep a reference of a point for manual operations.
   LongPoint inboundPoint = cumulative.getOrCreateTimeSeries(labelValues);

   void doSomeWork() {
      // Your code here.
      inboundPoint.set(15);
   }

 }
 

Since:

0.21

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	LongCumulative.LongPoint	The value of a single point in the Cumulative.TimeSeries.
private static class	LongCumulative.NoopLongCumulative	No-op implementations of LongCumulative class.

Constructor Summary

Constructors

Constructor	Description
LongCumulative()

Method Summary

Modifier and Type	Method	Description
abstract void	clear()	Removes all TimeSeries from the cumulative metric.
abstract LongCumulative.LongPoint	getDefaultTimeSeries()	Returns a LongPoint for a cumulative with all labels not set, or default labels.
abstract LongCumulative.LongPoint	getOrCreateTimeSeries(java.util.List<LabelValue> labelValues)	Creates a TimeSeries and returns a LongPoint if the specified labelValues is not already associated with this cumulative, else returns an existing LongPoint.
(package private) static LongCumulative	newNoopLongCumulative(java.lang.String name, java.lang.String description, java.lang.String unit, java.util.List<LabelKey> labelKeys)	Returns the no-op implementation of the LongCumulative.
abstract void	removeTimeSeries(java.util.List<LabelValue> labelValues)	Removes the TimeSeries from the cumulative metric, if it is present.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

LongCumulative

public LongCumulative()

Method Detail

getOrCreateTimeSeries

public abstract LongCumulative.LongPoint getOrCreateTimeSeries(java.util.List<LabelValue> labelValues)

Creates a TimeSeries and returns a LongPoint if the specified labelValues is not already associated with this cumulative, else returns an existing LongPoint.

It is recommended to keep a reference to the LongPoint instead of always calling this method for manual operations.

Parameters:

labelValues - the list of label values. The number of label values must be the same to that of the label keys passed to MetricRegistry.addLongCumulative(java.lang.String, io.opencensus.metrics.MetricOptions).

Returns:

a LongPoint the value of single cumulative.

Throws:

java.lang.NullPointerException - if labelValues is null OR any element of labelValues is null.

java.lang.IllegalArgumentException - if number of labelValuess are not equal to the label keys passed to MetricRegistry.addLongCumulative(java.lang.String, io.opencensus.metrics.MetricOptions).

Since:

0.21

getDefaultTimeSeries

public abstract LongCumulative.LongPoint getDefaultTimeSeries()

Returns a LongPoint for a cumulative with all labels not set, or default labels.

Returns:

a LongPoint for a cumulative with all labels not set, or default labels.

Since:

0.21

removeTimeSeries

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

Removes the TimeSeries from the cumulative metric, if it is present. i.e. references to previous LongPoint objects are invalid (not part of the metric).

Parameters:

labelValues - the list of label values.

Throws:

java.lang.NullPointerException - if labelValues is null.

Since:

0.21

clear

public abstract void clear()

Removes all TimeSeries from the cumulative metric. i.e. references to all previous LongPoint objects are invalid (not part of the metric).

Since:

0.21

newNoopLongCumulative

static LongCumulative newNoopLongCumulative(java.lang.String name,
                                            java.lang.String description,
                                            java.lang.String unit,
                                            java.util.List<LabelKey> labelKeys)

Returns the no-op implementation of the LongCumulative.

Returns:

the no-op implementation of the LongCumulative.

Since:

0.21