Class SdkLoggerProvider

java.lang.Object

io.opentelemetry.sdk.logs.SdkLoggerProvider

All Implemented Interfaces:

LoggerProvider, Closeable, AutoCloseable

public final class SdkLoggerProvider
extends Object
implements LoggerProvider, Closeable

SDK implementation for LoggerProvider.

Since:

1.27.0

Method Summary

Modifier and Type	Method	Description
static SdkLoggerProviderBuilder	builder()	Returns a new SdkLoggerProviderBuilder for SdkLoggerProvider.
void	close()
CompletableResultCode	forceFlush()	Request the active log processor to process all logs that have not yet been processed.
Logger	get(String instrumentationScopeName)	Gets or creates a named Logger instance.
LoggerBuilder	loggerBuilder(String instrumentationScopeName)	Creates a LoggerBuilder for a named Logger instance.
CompletableResultCode	shutdown()	Attempt to shut down the active log processor.
String	toString()

Methods inherited from class Object

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

Method Details

builder

public static SdkLoggerProviderBuilder builder()

Returns a new SdkLoggerProviderBuilder for SdkLoggerProvider.

Returns:

a new builder instance

get

public Logger get(String instrumentationScopeName)

Description copied from interface: LoggerProvider

Gets or creates a named Logger instance.

Specified by:

get in interface LoggerProvider

Parameters:

instrumentationScopeName - A name uniquely identifying the instrumentation scope, such as the instrumentation library, package, or fully qualified class name. Must not be null.

Returns:

a Logger instance.

loggerBuilder

public LoggerBuilder loggerBuilder(String instrumentationScopeName)

Description copied from interface: LoggerProvider

Creates a LoggerBuilder for a named Logger instance.

Specified by:

loggerBuilder in interface LoggerProvider

Parameters:

instrumentationScopeName - A name uniquely identifying the instrumentation scope, such as the instrumentation library, package, or fully qualified class name. Must not be null.

Returns:

a LoggerBuilder instance.

forceFlush

public CompletableResultCode forceFlush()

Request the active log processor to process all logs that have not yet been processed.

Returns:

a CompletableResultCode which is completed when the flush is finished

shutdown

public CompletableResultCode shutdown()

Attempt to shut down the active log processor.

Returns:

a CompletableResultCode which is completed when the active log process has been shut down.

close

public void close()

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

toString

public String toString()

Overrides:

toString in class Object