io.opentelemetry.metrics

Class DefaultMeter

java.lang.Object

io.opentelemetry.metrics.DefaultMeter

All Implemented Interfaces:

Meter

@ThreadSafe
public final class DefaultMeter
extends Object
implements Meter

No-op implementations of Meter.

Since:

0.1.0

Method Summary

Modifier and Type	Method and Description
LabelSet	createLabelSet(Map<String,String> labels) Returns a new LabelSet with labels built from the keys and values in the provided Map.
LabelSet	createLabelSet(String... keyValuePairs) Returns a new LabelSet with the given labels.
DoubleCounter.Builder	doubleCounterBuilder(String name) Returns a builder for a DoubleCounter.
DoubleMeasure.Builder	doubleMeasureBuilder(String name) Returns a new builder for a DoubleMeasure.
DoubleObserver.Builder	doubleObserverBuilder(String name) Returns a new builder for a DoubleObserver.
static Meter	getInstance() Returns a Meter singleton that is the default implementations for Meter.
LongCounter.Builder	longCounterBuilder(String name) Returns a builder for a LongCounter.
LongMeasure.Builder	longMeasureBuilder(String name) Returns a new builder for a LongMeasure.
LongObserver.Builder	longObserverBuilder(String name) Returns a new builder for a LongObserver.
BatchRecorder	newBatchRecorder(String... keyValuePairs) Utility method that allows users to atomically record measurements to a set of Measures with a common set of labels.

Methods inherited from class java.lang.Object

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

Method Detail

getInstance

public static Meter getInstance()

Returns a Meter singleton that is the default implementations for Meter.

Returns:

a Meter singleton that is the default implementations for Meter.

Since:

0.1.0

doubleCounterBuilder

public DoubleCounter.Builder doubleCounterBuilder(String name)

Description copied from interface: Meter

Returns a builder for a DoubleCounter.

Specified by:

doubleCounterBuilder in interface Meter

Parameters:

name - the name of the metric. Should be a ASCII string with a length no greater than 255 characters.

Returns:

a DoubleCounter.Builder.

longCounterBuilder

public LongCounter.Builder longCounterBuilder(String name)

Description copied from interface: Meter

Returns a builder for a LongCounter.

Specified by:

longCounterBuilder in interface Meter

Parameters:

name - the name of the metric. Should be a ASCII string with a length no greater than 255 characters.

Returns:

a LongCounter.Builder.

doubleMeasureBuilder

public DoubleMeasure.Builder doubleMeasureBuilder(String name)

Description copied from interface: Meter

Returns a new builder for a DoubleMeasure.

Specified by:

doubleMeasureBuilder in interface Meter

Parameters:

name - Name of measure, as a String. Should be a ASCII string with a length no greater than 255 characters.

Returns:

a new builder for a DoubleMeasure.

longMeasureBuilder

public LongMeasure.Builder longMeasureBuilder(String name)

Description copied from interface: Meter

Returns a new builder for a LongMeasure.

Specified by:

longMeasureBuilder in interface Meter

Parameters:

name - Name of measure, as a String. Should be a ASCII string with a length no greater than 255 characters.

Returns:

a new builder for a LongMeasure.

doubleObserverBuilder

public DoubleObserver.Builder doubleObserverBuilder(String name)

Description copied from interface: Meter

Returns a new builder for a DoubleObserver.

Specified by:

doubleObserverBuilder in interface Meter

Parameters:

name - Name of observer, as a String. Should be a ASCII string with a length no greater than 255 characters.

Returns:

a new builder for a DoubleObserver.

longObserverBuilder

public LongObserver.Builder longObserverBuilder(String name)

Description copied from interface: Meter

Returns a new builder for a LongObserver.

Specified by:

longObserverBuilder in interface Meter

Parameters:

name - Name of observer, as a String. Should be a ASCII string with a length no greater than 255 characters.

Returns:

a new builder for a LongObserver.

newBatchRecorder

public BatchRecorder newBatchRecorder(String... keyValuePairs)

Description copied from interface: Meter

Utility method that allows users to atomically record measurements to a set of Measures with a common set of labels.

Specified by:

newBatchRecorder in interface Meter

Parameters:

keyValuePairs - The set of labels to associate with this recorder and all it's recordings.

Returns:

a MeasureBatchRecorder that can be use to atomically record a set of measurements associated with different Measures.

createLabelSet

public LabelSet createLabelSet(String... keyValuePairs)

Description copied from interface: Meter

Returns a new LabelSet with the given labels.

The arguments must are in key, value pairs, so an even number of arguments are required.

If no arguments are provided, the resulting LabelSet will be the empty one.

Specified by:

createLabelSet in interface Meter

Parameters:

keyValuePairs - pairs of keys and values for the labels.

Returns:

a new LabelSet with the given labels.

createLabelSet

public LabelSet createLabelSet(Map<String,String> labels)

Description copied from interface: Meter

Returns a new LabelSet with labels built from the keys and values in the provided Map.

Specified by:

createLabelSet in interface Meter

Parameters:

labels - The key-value pairs to turn into labels.

Returns:

a new LabelSet with the given labels.