Package io.opentelemetry.sdk.logs

Class SdkLoggerProviderBuilder

java.lang.Object

io.opentelemetry.sdk.logs.SdkLoggerProviderBuilder

public final class SdkLoggerProviderBuilder
extends Object

Builder class for SdkLoggerProvider instances.

Since:

1.27.0

Field Summary

Fields

Modifier and Type	Field	Description
private Clock	clock
private ScopeConfiguratorBuilder<LoggerConfig>	loggerConfiguratorBuilder
private Supplier<LogLimits>	logLimitsSupplier
private final List<LogRecordProcessor>	logRecordProcessors
private Resource	resource

Constructor Summary

Constructors

Constructor	Description
SdkLoggerProviderBuilder()

Method Summary

Modifier and Type	Method	Description
(package private) SdkLoggerProviderBuilder	addLoggerConfiguratorCondition(Predicate<InstrumentationScopeInfo> scopeMatcher, LoggerConfig loggerConfig)	Adds a condition to the logger configurator, which computes LoggerConfig for each InstrumentationScopeInfo.
SdkLoggerProviderBuilder	addLogRecordProcessor(LogRecordProcessor processor)	Add a log processor.
SdkLoggerProviderBuilder	addResource(Resource resource)	Merge a Resource with the current.
SdkLoggerProvider	build()	Create a SdkLoggerProvider instance.
SdkLoggerProviderBuilder	setClock(Clock clock)	Assign a Clock.
(package private) SdkLoggerProviderBuilder	setLoggerConfigurator(ScopeConfigurator<LoggerConfig> loggerConfigurator)	Set the logger configurator, which computes LoggerConfig for each InstrumentationScopeInfo.
SdkLoggerProviderBuilder	setLogLimits(Supplier<LogLimits> logLimitsSupplier)	Assign a Supplier of LogLimits.
SdkLoggerProviderBuilder	setResource(Resource resource)	Assign a Resource to be attached to all LogRecordData created by Loggers obtained from the SdkLoggerProvider.

Methods inherited from class java.lang.Object

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

Field Details

logRecordProcessors

private final List<LogRecordProcessor> logRecordProcessors

resource

private Resource resource

logLimitsSupplier

private Supplier<LogLimits> logLimitsSupplier

clock

private Clock clock

loggerConfiguratorBuilder

private ScopeConfiguratorBuilder<LoggerConfig> loggerConfiguratorBuilder

Constructor Details

SdkLoggerProviderBuilder

SdkLoggerProviderBuilder()

Method Details

setResource

public SdkLoggerProviderBuilder setResource(Resource resource)

Assign a Resource to be attached to all LogRecordData created by Loggers obtained from the SdkLoggerProvider.

Parameters:

resource - the resource

Returns:

this

addResource

public SdkLoggerProviderBuilder addResource(Resource resource)

Merge a Resource with the current.

Parameters:

resource - Resource to merge with current.

Since:

1.29.0

setLogLimits

public SdkLoggerProviderBuilder setLogLimits(Supplier<LogLimits> logLimitsSupplier)

Assign a Supplier of LogLimits. LogLimits will be retrieved each time a Logger.logRecordBuilder() is called.

The logLimitsSupplier must be thread-safe and return immediately (no remote calls, as contention free as possible).

Parameters:

logLimitsSupplier - the supplier that will be used to retrieve the LogLimits for every LogRecordBuilder.

Returns:

this

addLogRecordProcessor

public SdkLoggerProviderBuilder addLogRecordProcessor(LogRecordProcessor processor)

Add a log processor. LogRecordProcessor.onEmit(Context, ReadWriteLogRecord) will be called each time a log is emitted by Logger instances obtained from the SdkLoggerProvider.

Parameters:

processor - the log processor

Returns:

this

setClock

public SdkLoggerProviderBuilder setClock(Clock clock)

Assign a Clock.

Parameters:

clock - The clock to use for all temporal needs.

Returns:

this

setLoggerConfigurator

SdkLoggerProviderBuilder setLoggerConfigurator(ScopeConfigurator<LoggerConfig> loggerConfigurator)

Set the logger configurator, which computes LoggerConfig for each InstrumentationScopeInfo.

This method is experimental so not public. You may reflectively call it using SdkLoggerProviderUtil.setLoggerConfigurator(SdkLoggerProviderBuilder, ScopeConfigurator).

Overrides any matchers added via addLoggerConfiguratorCondition(Predicate, LoggerConfig).

See Also:

• LoggerConfig.configuratorBuilder()

addLoggerConfiguratorCondition

SdkLoggerProviderBuilder addLoggerConfiguratorCondition(Predicate<InstrumentationScopeInfo> scopeMatcher,
 LoggerConfig loggerConfig)

Adds a condition to the logger configurator, which computes LoggerConfig for each InstrumentationScopeInfo.

This method is experimental so not public. You may reflectively call it using SdkLoggerProviderUtil.addLoggerConfiguratorCondition(SdkLoggerProviderBuilder, Predicate, LoggerConfig).

Applies after any previously added conditions.

If setLoggerConfigurator(ScopeConfigurator) was previously called, this condition will only be applied if the Function.apply(Object) returns null for the matched InstrumentationScopeInfo(s).

See Also:

• ScopeConfiguratorBuilder.nameEquals(String)
• ScopeConfiguratorBuilder.nameMatchesGlob(String)

build

public SdkLoggerProvider build()

Create a SdkLoggerProvider instance.

Returns:

an instance configured with the provided options