Package io.opentelemetry.sdk.metrics

Class SdkMeterProvider

java.lang.Object

io.opentelemetry.sdk.metrics.SdkMeterProvider

All Implemented Interfaces:

io.opentelemetry.api.metrics.MeterProvider, MetricProducer

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

SdkMeterProvider implementation for MeterProvider.

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

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.

Method Summary

Modifier and Type	Method	Description
static SdkMeterProviderBuilder	builder()	Returns a new SdkMeterProviderBuilder for SdkMeterProvider.
Collection<MetricData>	collectAllMetrics()	Returns a collection of produced MetricDatas to be exported.
io.opentelemetry.sdk.metrics.SdkMeter	get(String instrumentationName)
io.opentelemetry.sdk.metrics.SdkMeter	get(String instrumentationName, String instrumentationVersion)
void	registerView(InstrumentSelector selector, View view)	Deprecated. Use SdkMeterProviderBuilder.registerView(InstrumentSelector, View)

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

collectAllMetrics

public Collection<MetricData> collectAllMetrics()

Description copied from interface: MetricProducer

Returns a collection of produced MetricDatas to be exported. This will only be those metrics that have been produced since the last time this method was called.

Specified by:

collectAllMetrics in interface MetricProducer

Returns:

a collection of produced MetricDatas to be exported.

builder

public static SdkMeterProviderBuilder builder()

Returns a new SdkMeterProviderBuilder for SdkMeterProvider.

Returns:

a new SdkMeterProviderBuilder for SdkMeterProvider.

registerView

@Deprecated
public void registerView(InstrumentSelector selector,
                         View view)

Deprecated.

Use SdkMeterProviderBuilder.registerView(InstrumentSelector, View)

Register a view with the given InstrumentSelector.

Example on how to register a view:

 // get a handle to the MeterSdkProvider
 SdkMeterProvider meterProvider = SdkMeterProvider.builder().build();

 // create a selector to select which instruments to customize:
 InstrumentSelector instrumentSelector = InstrumentSelector.builder()
   .setInstrumentType(InstrumentType.COUNTER)
   .build();

 // create a specification of how you want the metrics aggregated:
 AggregatorFactory aggregatorFactory = AggregatorFactory.minMaxSumCount();

 //register the view with the MeterSdkProvider
 meterProvider.registerView(instrumentSelector, View.builder()
   .setAggregatorFactory(aggregatorFactory).build());