io.opentelemetry.metrics

Interface Meter

All Known Implementing Classes:

DefaultMeter

@ThreadSafe
public interface Meter

Meter is a simple, interface that allows users to record measurements (metrics).

There are two ways to record measurements:

• Record raw measurements, and defer defining the aggregation and the labels for the exported Instrument. This should be used in libraries like gRPC to record measurements like "server_latency" or "received_bytes".
• Record pre-defined aggregation data (or already aggregated data). This should be used to report cpu/memory usage, or simple metrics like "queue_length".

TODO: Update comment.

Method Summary

Modifier and Type	Method and Description
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.
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.

Method Detail

doubleCounterBuilder

DoubleCounter.Builder doubleCounterBuilder(String name)

Returns a builder for a DoubleCounter.

Parameters:

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

Returns:

a DoubleCounter.Builder.

Throws:

NullPointerException - if name is null.

IllegalArgumentException - if different metric with the same name already registered.

IllegalArgumentException - if the name does not match the requirements.

Since:

0.1.0

longCounterBuilder

LongCounter.Builder longCounterBuilder(String name)

Returns a builder for a LongCounter.

Parameters:

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

Returns:

a LongCounter.Builder.

Throws:

NullPointerException - if name is null.

IllegalArgumentException - if different metric with the same name already registered.

IllegalArgumentException - if the name does not match the requirements.

Since:

0.1.0

doubleMeasureBuilder

DoubleMeasure.Builder doubleMeasureBuilder(String name)

Returns a new builder for a DoubleMeasure.

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.

Throws:

NullPointerException - if name is null.

IllegalArgumentException - if different metric with the same name already registered.

IllegalArgumentException - if the name does not match the requirements.

Since:

0.1.0

longMeasureBuilder

LongMeasure.Builder longMeasureBuilder(String name)

Returns a new builder for a LongMeasure.

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.

Throws:

NullPointerException - if name is null.

IllegalArgumentException - if different metric with the same name already registered.

IllegalArgumentException - if the name does not match the requirements.

Since:

0.1.0

doubleObserverBuilder

DoubleObserver.Builder doubleObserverBuilder(String name)

Returns a new builder for a DoubleObserver.

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.

Throws:

NullPointerException - if name is null.

IllegalArgumentException - if different metric with the same name already registered.

IllegalArgumentException - if the name does not match the requirements.

Since:

0.1.0

longObserverBuilder

LongObserver.Builder longObserverBuilder(String name)

Returns a new builder for a LongObserver.

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.

Throws:

NullPointerException - if name is null.

IllegalArgumentException - if different metric with the same name already registered.

IllegalArgumentException - if the name does not match the requirements.

Since:

0.1.0

newBatchRecorder

BatchRecorder newBatchRecorder(String... keyValuePairs)

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

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.

Since:

0.1.0