Package io.opentelemetry.sdk.metrics

Class SdkMeterProvider

java.lang.Object

io.opentelemetry.sdk.metrics.SdkMeterProvider

All Implemented Interfaces:

io.opentelemetry.api.metrics.MeterProvider

public final class SdkMeterProvider
extends Object
implements io.opentelemetry.api.metrics.MeterProvider

SdkMeterProvider implementation for MeterProvider.

This class is not intended to be used in application code and it is used only by OpenTelemetry.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SdkMeterProvider.Builder	Builder class for the SdkMeterProvider.

Method Summary

Modifier and Type	Method	Description
static SdkMeterProvider.Builder	builder()	Returns a new SdkMeterProvider.Builder for SdkMeterProvider.
io.opentelemetry.sdk.metrics.SdkMeter	get(String instrumentationName)
io.opentelemetry.sdk.metrics.SdkMeter	get(String instrumentationName, String instrumentationVersion)
MetricProducer	getMetricProducer()	Returns the MetricProducer that can be used to retrieve metrics from this MeterSdkProvider.
void	registerView(InstrumentSelector selector, AggregationConfiguration specification)	Register a view with the given InstrumentSelector.

Methods inherited from class java.lang.Object

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

Method Detail

get

public io.opentelemetry.sdk.metrics.SdkMeter get(String instrumentationName)

Specified by:

get in interface io.opentelemetry.api.metrics.MeterProvider

get

public io.opentelemetry.sdk.metrics.SdkMeter get(String instrumentationName,
                                                 @Nullable
                                                 String instrumentationVersion)

Specified by:

get in interface io.opentelemetry.api.metrics.MeterProvider

getMetricProducer

public MetricProducer getMetricProducer()

Returns the MetricProducer that can be used to retrieve metrics from this MeterSdkProvider.

WARNING: A MetricProducer is stateful. It will only return changes since the last time it was accessed. This means that if more than one MetricExporter has a handle to this MetricProducer, the two exporters will not receive copies of the same metric data to export.

Returns:

the MetricProducer that can be used to retrieve metrics from this MeterSdkProvider.

builder

public static SdkMeterProvider.Builder builder()

Returns a new SdkMeterProvider.Builder for SdkMeterProvider.

Returns:

a new SdkMeterProvider.Builder for SdkMeterProvider.

registerView

public void registerView(InstrumentSelector selector,
                         AggregationConfiguration specification)

Register a view with the given InstrumentSelector.

Example on how to register a view:

 // get a handle to the MeterSdkProvider
 MeterSdkProvider meterProvider = OpenTelemetrySdk.getMeterProvider();

 // create a selector to select which instruments to customize:
 InstrumentSelector instrumentSelector = InstrumentSelector.newBuilder()
   .instrumentType(InstrumentType.COUNTER)
   .buildInstrument();

 // create a specification of how you want the metrics aggregated:
 AggregationConfiguration viewSpecification =
   AggregationConfiguration.create(Aggregations.minMaxSumCount(), Temporality.DELTA);

 //register the view with the MeterSdkProvider
 meterProvider.registerView(instrumentSelector, viewSpecification);
 

See Also:

AggregationConfiguration