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

Method Summary

Modifier and Type	Method	Description
SdkLoggerProviderBuilder	addLogRecordProcessor(LogRecordProcessor processor)	Add a log processor.
SdkLoggerProviderBuilder	addLogRecordProcessorFirst(LogRecordProcessor processor)	Add a log processor as first.
SdkLoggerProviderBuilder	addResource(io.opentelemetry.sdk.resources.Resource resource)	Merge a Resource with the current.
SdkLoggerProvider	build()	Create a SdkLoggerProvider instance.
SdkLoggerProviderBuilder	setClock(io.opentelemetry.sdk.common.Clock clock)	Assign a Clock.
SdkLoggerProviderBuilder	setLogLimits(Supplier<LogLimits> logLimitsSupplier)	Assign a Supplier of LogLimits.
SdkLoggerProviderBuilder	setResource(io.opentelemetry.sdk.resources.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

Method Details

setResource

public SdkLoggerProviderBuilder setResource(io.opentelemetry.sdk.resources.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(io.opentelemetry.sdk.resources.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

addLogRecordProcessorFirst

public SdkLoggerProviderBuilder addLogRecordProcessorFirst(LogRecordProcessor processor)

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

Compared to addLogRecordProcessor(LogRecordProcessor), this method adds the processor to the beginning of the processor pipeline. So the processor given will be executed before than the other processors already added.

Parameters:

processor - the log processor

Returns:

this

Since:

1.50.0

setClock

public SdkLoggerProviderBuilder setClock(io.opentelemetry.sdk.common.Clock clock)

Assign a Clock.

Parameters:

clock - The clock to use for all temporal needs.

Returns:

this

build

public SdkLoggerProvider build()

Create a SdkLoggerProvider instance.

Returns:

an instance configured with the provided options