Package io.opentelemetry.sdk.trace.internal

Class TracerConfig

java.lang.Object

io.opentelemetry.sdk.trace.internal.TracerConfig

Direct Known Subclasses:

AutoValue_TracerConfig

@Immutable
public abstract class TracerConfig
extends Object

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

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

See Also:

• SdkTracerProviderUtil.setTracerConfigurator(SdkTracerProviderBuilder, ScopeConfigurator)
• SdkTracerProviderUtil.addTracerConfiguratorCondition(SdkTracerProviderBuilder, Predicate, TracerConfig)

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor	Description
TracerConfig()

Method Summary

Modifier and Type	Method	Description
static ScopeConfiguratorBuilder<TracerConfig>	configuratorBuilder()	Create a ScopeConfiguratorBuilder for configuring SdkTracerProviderUtil.setTracerConfigurator(SdkTracerProviderBuilder, ScopeConfigurator).
static TracerConfig	defaultConfig()	Returns the default TracerConfig, which is used when no configurator is set or when the tracer configurator returns null for a InstrumentationScopeInfo.
static TracerConfig	disabled()	Returns a disabled TracerConfig.
static TracerConfig	enabled()	Returns an enabled TracerConfig.
abstract boolean	isEnabled()	Returns true if this tracer 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 TracerConfig DEFAULT_CONFIG

DISABLED_CONFIG

private static final TracerConfig DISABLED_CONFIG

Constructor Details

TracerConfig

TracerConfig()

Method Details

disabled

public static TracerConfig disabled()

Returns a disabled TracerConfig.

enabled

public static TracerConfig enabled()

Returns an enabled TracerConfig.

defaultConfig

public static TracerConfig defaultConfig()

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

configuratorBuilder

public static ScopeConfiguratorBuilder<TracerConfig> configuratorBuilder()

Create a ScopeConfiguratorBuilder for configuring SdkTracerProviderUtil.setTracerConfigurator(SdkTracerProviderBuilder, ScopeConfigurator).

isEnabled

public abstract boolean isEnabled()

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