Package io.opentelemetry.sdk.metrics.internal

Class MeterConfig

java.lang.Object

io.opentelemetry.sdk.metrics.internal.MeterConfig

Direct Known Subclasses:

AutoValue_MeterConfig

@Immutable
public abstract class MeterConfig
extends Object

A collection of configuration options which define the behavior of a Meter.

This class is internal and is hence not for public use. Its APIs are unstable and can change at any time.

See Also:

• SdkMeterProviderUtil.setMeterConfigurator(SdkMeterProviderBuilder, ScopeConfigurator)
• SdkMeterProviderUtil.addMeterConfiguratorCondition(SdkMeterProviderBuilder, Predicate, MeterConfig)

Field Summary

Fields

Modifier and Type	Field	Description
private static final MeterConfig	DEFAULT_CONFIG
private static final MeterConfig	DISABLED_CONFIG

Constructor Summary

Constructors

Constructor	Description
MeterConfig()

Method Summary

Modifier and Type	Method	Description
static ScopeConfiguratorBuilder<MeterConfig>	configuratorBuilder()	Create a ScopeConfiguratorBuilder for configuring SdkMeterProviderUtil.setMeterConfigurator(SdkMeterProviderBuilder, ScopeConfigurator).
static MeterConfig	defaultConfig()	Returns the default MeterConfig, which is used when no configurator is set or when the meter configurator returns null for a InstrumentationScopeInfo.
static MeterConfig	disabled()	Returns a disabled MeterConfig.
static MeterConfig	enabled()	Returns an enabled MeterConfig.
abstract boolean	isEnabled()	Returns true if this meter is enabled.

Methods inherited from class java.lang.Object

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

Field Details

DEFAULT_CONFIG

private static final MeterConfig DEFAULT_CONFIG

DISABLED_CONFIG

private static final MeterConfig DISABLED_CONFIG

Constructor Details

MeterConfig

MeterConfig()

Method Details

disabled

public static MeterConfig disabled()

Returns a disabled MeterConfig.

enabled

public static MeterConfig enabled()

Returns an enabled MeterConfig.

defaultConfig

public static MeterConfig defaultConfig()

Returns the default MeterConfig, which is used when no configurator is set or when the meter configurator returns null for a InstrumentationScopeInfo.

configuratorBuilder

public static ScopeConfiguratorBuilder<MeterConfig> configuratorBuilder()

Create a ScopeConfiguratorBuilder for configuring SdkMeterProviderUtil.setMeterConfigurator(SdkMeterProviderBuilder, ScopeConfigurator).

isEnabled

public abstract boolean isEnabled()

Returns true if this meter is enabled. Defaults to true.