Top Description Interfaces Classes
module io.opentelemetry.api

Package io.opentelemetry.api.metrics

Annotations
@ParametersAreNonnullByDefault
Imports
javax.annotation.ParametersAreNonnullByDefault

This package describes the Metrics API that can be used to record application Metrics.

The primary entry point to Metrics is the io.opentelemetry.api.metrics.MeterProvider, which allows the construction of a io.opentelemetry.api.metrics.Meter. Instrumentated libraries should construct a single io.opentelemetry.api.metrics.Meter and register `instruments` via the builders available on io.opentelemetry.api.metrics.Meter.

There is a global instance of io.opentelemetry.api.metrics.MeterProvider available for scenarios where instrumentation authors are unable to obtain one by other means.

Interface Summary

Modifier and TypeInterface and Description
public interface
public interface
DoubleCounter

A Counter instrument that records double values.

public interface
public interface
DoubleGauge

A gauge instrument that synchronously records double values.

public interface
DoubleGaugeBuilder

A builder for Gauge metric types.

public interface
DoubleHistogram

A Histogram instrument that records double values.

public interface
public interface
DoubleUpDownCounter

An UpDownCounter instrument that records double values.

public interface
public interface
LongCounter

A Counter instrument that records long values.

public interface
LongCounterBuilder

Builder class for LongCounter.

public interface
LongGauge

A gauge instrument that synchronously records long values.

public interface
LongGaugeBuilder

A builder for Gauge metric types.

public interface
LongHistogram

A Histogram instrument that records long values.

public interface
public interface
LongUpDownCounter

An UpDownCounter instrument that records long values.

public interface
public interface
Meter

Provides instruments used to record measurements which are aggregated to metrics.

public interface
MeterBuilder

Builder class for creating Meter instances.

public interface
MeterProvider

A registry for creating named Meters.

public interface
ObservableDoubleCounter

A reference to an observable instrument registered with DoubleCounterBuilder#buildWithCallback(Consumer).

public interface
ObservableDoubleGauge

A reference to an observable instrument registered with DoubleGaugeBuilder#buildWithCallback(Consumer).

public interface
ObservableDoubleMeasurement

An interface for observing measurements with double values.

public interface
ObservableDoubleUpDownCounter

A reference to an observable instrument registered with DoubleUpDownCounterBuilder#buildWithCallback(Consumer).

public interface
ObservableLongCounter

A reference to an observable instrument registered with LongCounterBuilder#buildWithCallback(Consumer).

public interface
ObservableLongGauge

A reference to an observable instrument registered with LongGaugeBuilder#buildWithCallback(Consumer).

public interface
ObservableLongMeasurement

An interface for observing measurements with long values.

public interface
ObservableLongUpDownCounter

A reference to an observable metric registered with LongUpDownCounterBuilder#buildWithCallback(Consumer).

public interface
ObservableMeasurement

Super interface for observing measurements.

Class Summary

Modifier and TypeClass and Description
pack-priv class
DefaultMeter

No-op implementation of Meter.

pack-priv class
DefaultMeterProvider

A MeterProvider that does nothing.