Package io.opentelemetry.api.metrics
Interface Meter
-
@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
-
-
-
Method Detail
-
doubleCounterBuilder
DoubleCounterBuilder doubleCounterBuilder(String name)
Returns a builder for aDoubleCounter
.- Parameters:
name
- the name of the instrument. Should be a ASCII string with a length no greater than 255 characters.- Returns:
- a
DoubleCounter.Builder
. - Throws:
NullPointerException
- ifname
is null.IllegalArgumentException
- if different metric with the same name already registered.IllegalArgumentException
- if thename
does not match the requirements.
-
longCounterBuilder
LongCounterBuilder longCounterBuilder(String name)
Returns a builder for aLongCounter
.- Parameters:
name
- the name of the instrument. Should be a ASCII string with a length no greater than 255 characters.- Returns:
- a
LongCounter.Builder
. - Throws:
NullPointerException
- ifname
is null.IllegalArgumentException
- if different metric with the same name already registered.IllegalArgumentException
- if thename
does not match the requirements.
-
doubleUpDownCounterBuilder
DoubleUpDownCounterBuilder doubleUpDownCounterBuilder(String name)
Returns a builder for aDoubleUpDownCounter
.- Parameters:
name
- the name of the instrument. Should be a ASCII string with a length no greater than 255 characters.- Returns:
- a
DoubleCounter.Builder
. - Throws:
NullPointerException
- ifname
is null.IllegalArgumentException
- if different metric with the same name already registered.IllegalArgumentException
- if thename
does not match the requirements.
-
longUpDownCounterBuilder
LongUpDownCounterBuilder longUpDownCounterBuilder(String name)
Returns a builder for aLongUpDownCounter
.- Parameters:
name
- the name of the instrument. Should be a ASCII string with a length no greater than 255 characters.- Returns:
- a
LongCounter.Builder
. - Throws:
NullPointerException
- ifname
is null.IllegalArgumentException
- if different metric with the same name already registered.IllegalArgumentException
- if thename
does not match the requirements.
-
doubleValueRecorderBuilder
DoubleValueRecorderBuilder doubleValueRecorderBuilder(String name)
Returns a new builder for aDoubleValueRecorder
.- Parameters:
name
- the name of the instrument. Should be a ASCII string with a length no greater than 255 characters.- Returns:
- a new builder for a
DoubleValueRecorder
. - Throws:
NullPointerException
- ifname
is null.IllegalArgumentException
- if different metric with the same name already registered.IllegalArgumentException
- if thename
does not match the requirements.
-
longValueRecorderBuilder
LongValueRecorderBuilder longValueRecorderBuilder(String name)
Returns a new builder for aLongValueRecorder
.- Parameters:
name
- the name of the instrument. Should be a ASCII string with a length no greater than 255 characters.- Returns:
- a new builder for a
LongValueRecorder
. - Throws:
NullPointerException
- ifname
is null.IllegalArgumentException
- if different metric with the same name already registered.IllegalArgumentException
- if thename
does not match the requirements.
-
doubleSumObserverBuilder
DoubleSumObserverBuilder doubleSumObserverBuilder(String name)
Returns a new builder for aDoubleSumObserver
.- Parameters:
name
- the name of the instrument. Should be a ASCII string with a length no greater than 255 characters.- Returns:
- a new builder for a
DoubleSumObserver
. - Throws:
NullPointerException
- ifname
is null.IllegalArgumentException
- if different metric with the same name already registered.IllegalArgumentException
- if thename
does not match the requirements.
-
longSumObserverBuilder
LongSumObserverBuilder longSumObserverBuilder(String name)
Returns a new builder for aLongSumObserver
.- Parameters:
name
- the name of the instrument. Should be a ASCII string with a length no greater than 255 characters.- Returns:
- a new builder for a
LongSumObserver
. - Throws:
NullPointerException
- ifname
is null.IllegalArgumentException
- if different metric with the same name already registered.IllegalArgumentException
- if thename
does not match the requirements.
-
doubleUpDownSumObserverBuilder
DoubleUpDownSumObserverBuilder doubleUpDownSumObserverBuilder(String name)
Returns a new builder for aDoubleUpDownSumObserver
.- Parameters:
name
- the name of the instrument. Should be a ASCII string with a length no greater than 255 characters.- Returns:
- a new builder for a
DoubleUpDownObserver
. - Throws:
NullPointerException
- ifname
is null.IllegalArgumentException
- if different metric with the same name already registered.IllegalArgumentException
- if thename
does not match the requirements.
-
longUpDownSumObserverBuilder
LongUpDownSumObserverBuilder longUpDownSumObserverBuilder(String name)
Returns a new builder for aLongUpDownSumObserver
.- Parameters:
name
- the name of the instrument. Should be a ASCII string with a length no greater than 255 characters.- Returns:
- a new builder for a
LongUpDownSumObserver
. - Throws:
NullPointerException
- ifname
is null.IllegalArgumentException
- if different metric with the same name already registered.IllegalArgumentException
- if thename
does not match the requirements.
-
doubleValueObserverBuilder
DoubleValueObserverBuilder doubleValueObserverBuilder(String name)
Returns a new builder for aDoubleValueObserver
.- Parameters:
name
- the name of the instrument. Should be a ASCII string with a length no greater than 255 characters.- Returns:
- a new builder for a
DoubleValueObserver
. - Throws:
NullPointerException
- ifname
is null.IllegalArgumentException
- if different metric with the same name already registered.IllegalArgumentException
- if thename
does not match the requirements.
-
longValueObserverBuilder
LongValueObserverBuilder longValueObserverBuilder(String name)
Returns a new builder for aLongValueObserver
.- Parameters:
name
- the name of the instrument. Should be a ASCII string with a length no greater than 255 characters.- Returns:
- a new builder for a
LongValueObserver
. - Throws:
NullPointerException
- ifname
is null.IllegalArgumentException
- if different metric with the same name already registered.IllegalArgumentException
- if thename
does not match the requirements.
-
newBatchRecorder
BatchRecorder newBatchRecorder(String... keyValuePairs)
Utility method that allows users to atomically record measurements to a set of Instruments 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.
-
-