Package io.opentelemetry.sdk.metrics
Class SdkMeterProvider
java.lang.Object
io.opentelemetry.sdk.metrics.SdkMeterProvider
- All Implemented Interfaces:
MeterProvider
,Closeable
,AutoCloseable
SDK implementation for
MeterProvider
.- Since:
- 1.14.0
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionprivate static class
Helper class to expose registered metric exports.private static class
-
Field Summary
FieldsModifier and TypeFieldDescription(package private) static final String
private final AtomicBoolean
private static final Logger
private final ScopeConfigurator
<MeterConfig> private final List
<MetricProducer> private final List
<RegisteredReader> private final List
<RegisteredView> private final ComponentRegistry
<SdkMeter> private final MeterProviderSharedState
-
Constructor Summary
ConstructorsConstructorDescriptionSdkMeterProvider
(List<RegisteredView> registeredViews, IdentityHashMap<MetricReader, CardinalityLimitSelector> metricReaders, List<MetricProducer> metricProducers, Clock clock, Resource resource, ExemplarFilter exemplarFilter, ScopeConfigurator<MeterConfig> meterConfigurator) -
Method Summary
Modifier and TypeMethodDescriptionstatic SdkMeterProviderBuilder
builder()
Returns a newSdkMeterProviderBuilder
forSdkMeterProvider
.void
close()
Close the meter provider.CallMetricReader.forceFlush()
on all metric readers associated with this provider.private MeterConfig
getMeterConfig
(InstrumentationScopeInfo instrumentationScopeInfo) meterBuilder
(String instrumentationScopeName) Creates a MeterBuilder for a named Meter instance.(package private) void
Reset the provider, clearing all registered instruments.shutdown()
Shutdown the provider.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
-
DEFAULT_METER_NAME
- See Also:
-
registeredViews
-
registeredReaders
-
metricProducers
-
registry
-
meterConfigurator
-
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
Returns a newSdkMeterProviderBuilder
forSdkMeterProvider
. -
getMeterConfig
-
meterBuilder
Description copied from interface:MeterProvider
Creates a MeterBuilder for a named Meter instance.- Specified by:
meterBuilder
in interfaceMeterProvider
- 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
CallMetricReader.forceFlush()
on all metric readers associated with this provider. The resultingCompletableResultCode
completes when all complete. -
shutdown
Shutdown the provider. CallsMetricReader.shutdown()
on all metric readers associated with this provider. The resultingCompletableResultCode
completes when all complete. -
close
public void close()Close the meter provider. Callsshutdown()
and blocks waiting for it to complete.- Specified by:
close
in interfaceAutoCloseable
- Specified by:
close
in interfaceCloseable
-
toString
-