Package io.opentelemetry.sdk.metrics

Class SdkMeterProvider

java.lang.Object

io.opentelemetry.sdk.metrics.SdkMeterProvider

All Implemented Interfaces:

MeterProvider, Closeable, AutoCloseable

public final class SdkMeterProvider
extends Object
implements MeterProvider, Closeable

SDK implementation for MeterProvider.

Since:

1.14.0

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private static class	SdkMeterProvider.LeasedMetricProducer	Helper class to expose registered metric exports.
private static class	SdkMeterProvider.SdkCollectionRegistration

Field Summary

Fields

Modifier and Type	Field	Description
(package private) static final String	DEFAULT_METER_NAME
private final AtomicBoolean	isClosed
private static final Logger	LOGGER
private final ScopeConfigurator<MeterConfig>	meterConfigurator
private final List<MetricProducer>	metricProducers
private final List<RegisteredReader>	registeredReaders
private final List<RegisteredView>	registeredViews
private final ComponentRegistry<SdkMeter>	registry
private final MeterProviderSharedState	sharedState

Constructor Summary

Constructors

Constructor	Description
SdkMeterProvider(List<RegisteredView> registeredViews, IdentityHashMap<MetricReader,CardinalityLimitSelector> metricReaders, List<MetricProducer> metricProducers, Clock clock, Resource resource, ExemplarFilter exemplarFilter, ScopeConfigurator<MeterConfig> meterConfigurator)

Method Summary

Modifier and Type	Method	Description
static SdkMeterProviderBuilder	builder()	Returns a new SdkMeterProviderBuilder for SdkMeterProvider.
void	close()	Close the meter provider.
CompletableResultCode	forceFlush()	Call MetricReader.forceFlush() on all metric readers associated with this provider.
private MeterConfig	getMeterConfig(InstrumentationScopeInfo instrumentationScopeInfo)
MeterBuilder	meterBuilder(String instrumentationScopeName)	Creates a MeterBuilder for a named Meter instance.
(package private) void	resetForTest()	Reset the provider, clearing all registered instruments.
CompletableResultCode	shutdown()	Shutdown the provider.
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.opentelemetry.api.metrics.MeterProvider

get

Field Details

LOGGER

private static final Logger LOGGER

DEFAULT_METER_NAME

static final String DEFAULT_METER_NAME

See Also:

• Constant Field Values

registeredViews

private final List<RegisteredView> registeredViews

registeredReaders

private final List<RegisteredReader> registeredReaders

metricProducers

private final List<MetricProducer> metricProducers

sharedState

private final MeterProviderSharedState sharedState

registry

private final ComponentRegistry<SdkMeter> registry

meterConfigurator

private final ScopeConfigurator<MeterConfig> meterConfigurator

isClosed

private final AtomicBoolean isClosed

Constructor Details

SdkMeterProvider

SdkMeterProvider(List<RegisteredView> registeredViews,
 IdentityHashMap<MetricReader,CardinalityLimitSelector> metricReaders,
 List<MetricProducer> metricProducers,
 Clock clock,
 Resource resource,
 ExemplarFilter exemplarFilter,
 ScopeConfigurator<MeterConfig> meterConfigurator)

Method Details

builder

public static SdkMeterProviderBuilder builder()

Returns a new SdkMeterProviderBuilder for SdkMeterProvider.

getMeterConfig

private MeterConfig getMeterConfig(InstrumentationScopeInfo instrumentationScopeInfo)

meterBuilder

public MeterBuilder meterBuilder(String instrumentationScopeName)

Description copied from interface: MeterProvider

Creates a MeterBuilder for a named Meter instance.

Specified by:

meterBuilder in interface MeterProvider

Parameters:

instrumentationScopeName - A name uniquely identifying the instrumentation scope, such as the instrumentation library, package, or fully qualified class name. Must not be null.

Returns:

a MeterBuilder instance.

resetForTest

void resetForTest()

Reset the provider, clearing all registered instruments.

Note: not currently stable but available for experimental use via SdkMeterProviderUtil.resetForTest(SdkMeterProvider).

forceFlush

public CompletableResultCode forceFlush()

Call MetricReader.forceFlush() on all metric readers associated with this provider. The resulting CompletableResultCode completes when all complete.

shutdown

public CompletableResultCode shutdown()

Shutdown the provider. Calls MetricReader.shutdown() on all metric readers associated with this provider. The resulting CompletableResultCode completes when all complete.

close

public void close()

Close the meter provider. Calls shutdown() and blocks waiting for it to complete.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

toString

public String toString()

Overrides:

toString in class Object