Class ScopeConfiguratorBuilder<T>

java.lang.Object

io.opentelemetry.sdk.internal.ScopeConfiguratorBuilder<T>

Type Parameters:

T - The scope configuration object, e.g. TracerConfig, LoggerConfig, MeterConfig.

public final class ScopeConfiguratorBuilder<T>
extends Object

Builder for ScopeConfigurator.

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private static final class	ScopeConfiguratorBuilder.Condition<T>

Field Summary

Fields

Modifier and Type	Field	Description
private final ScopeConfigurator<T>	baseScopeConfigurator
private final List<ScopeConfiguratorBuilder.Condition<T>>	conditions
private T	defaultScopeConfig

Constructor Summary

Constructors

Constructor	Description
ScopeConfiguratorBuilder(ScopeConfigurator<T> baseScopeConfigurator)

Method Summary

Modifier and Type	Method	Description
ScopeConfiguratorBuilder<T>	addCondition(Predicate<InstrumentationScopeInfo> scopePredicate, T scopeConfig)	Add a condition.
ScopeConfigurator<T>	build()	Build a ScopeConfigurator with the configuration of this builder.
static Predicate<InstrumentationScopeInfo>	nameEquals(String scopeName)	Helper function for exact matching InstrumentationScopeInfo.getName() against the scopeName.
static Predicate<InstrumentationScopeInfo>	nameMatchesGlob(String globPattern)	Helper function for pattern matching InstrumentationScopeInfo.getName() against the globPattern.
ScopeConfiguratorBuilder<T>	setDefault(T defaultScopeConfig)	Set the default scope config, which is returned by Function.apply(Object) if a InstrumentationScopeInfo does not match any conditions.

Methods inherited from class Object

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

Field Details

baseScopeConfigurator

private final ScopeConfigurator<T> baseScopeConfigurator

defaultScopeConfig

@Nullable
private T defaultScopeConfig

conditions

private final List<ScopeConfiguratorBuilder.Condition<T>> conditions

Constructor Details

ScopeConfiguratorBuilder

ScopeConfiguratorBuilder(ScopeConfigurator<T> baseScopeConfigurator)

Method Details

setDefault

public ScopeConfiguratorBuilder<T> setDefault(T defaultScopeConfig)

Set the default scope config, which is returned by Function.apply(Object) if a InstrumentationScopeInfo does not match any conditions. If a default is not set, an SDK defined default is used.

addCondition

public ScopeConfiguratorBuilder<T> addCondition(Predicate<InstrumentationScopeInfo> scopePredicate,
 T scopeConfig)

Add a condition. Conditions are evaluated in order. The scopeConfig for the first match is returned by Function.apply(Object).

Parameters:

scopePredicate - predicate that InstrumentationScopeInfos are evaluated against

scopeConfig - the scope config to use when this condition is the first matching scopePredicate

See Also:

• nameMatchesGlob(String)
• nameEquals(String)

nameMatchesGlob

public static Predicate<InstrumentationScopeInfo> nameMatchesGlob(String globPattern)

Helper function for pattern matching InstrumentationScopeInfo.getName() against the globPattern.

globPattern may contain the wildcard characters * and ? with the following matching criteria:

• * matches 0 or more instances of any character
• ? matches exactly one instance of any character

See Also:

• addCondition(Predicate, Object)

nameEquals

public static Predicate<InstrumentationScopeInfo> nameEquals(String scopeName)

Helper function for exact matching InstrumentationScopeInfo.getName() against the scopeName.

See Also:

• addCondition(Predicate, Object)

build

public ScopeConfigurator<T> build()

Build a ScopeConfigurator with the configuration of this builder.