Package io.opentelemetry.sdk.logs

Class SdkLogger

java.lang.Object

io.opentelemetry.sdk.logs.SdkLogger

All Implemented Interfaces:

ExtendedLogger, Logger

final class SdkLogger
extends Object
implements ExtendedLogger

SDK implementation of Logger.

Field Summary

Fields

Modifier and Type	Field	Description
private final InstrumentationScopeInfo	instrumentationScopeInfo
private final boolean	loggerEnabled
private final LoggerSharedState	loggerSharedState
private static final Logger	NOOP_LOGGER

Constructor Summary

Constructors

Constructor	Description
SdkLogger(LoggerSharedState loggerSharedState, InstrumentationScopeInfo instrumentationScopeInfo, LoggerConfig loggerConfig)

Method Summary

Modifier and Type	Method	Description
(package private) InstrumentationScopeInfo	getInstrumentationScopeInfo()
boolean	isEnabled()	Returns true if the logger is enabled.
LogRecordBuilder	logRecordBuilder()	Return a LogRecordBuilder to emit a log record.

Methods inherited from class java.lang.Object

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

Field Details

NOOP_LOGGER

private static final Logger NOOP_LOGGER

loggerSharedState

private final LoggerSharedState loggerSharedState

instrumentationScopeInfo

private final InstrumentationScopeInfo instrumentationScopeInfo

loggerEnabled

private final boolean loggerEnabled

Constructor Details

SdkLogger

SdkLogger(LoggerSharedState loggerSharedState,
 InstrumentationScopeInfo instrumentationScopeInfo,
 LoggerConfig loggerConfig)

Method Details

logRecordBuilder

public LogRecordBuilder logRecordBuilder()

Description copied from interface: Logger

Return a LogRecordBuilder to emit a log record.

IMPORTANT: this should be used to write appenders to bridge logs from logging frameworks (e.g. SLF4J, Log4j, JUL, Logback, etc). It is NOT a replacement for an application logging framework, and should not be used by application developers.

Build the log record using the LogRecordBuilder setters, and emit via LogRecordBuilder.emit().

Specified by:

logRecordBuilder in interface Logger

getInstrumentationScopeInfo

InstrumentationScopeInfo getInstrumentationScopeInfo()

isEnabled

public boolean isEnabled()

Description copied from interface: ExtendedLogger

Returns true if the logger is enabled.

This allows callers to avoid unnecessary compute when nothing is consuming the data. Because the response is subject to change over the application, callers should call this before each call to Logger.logRecordBuilder().

Specified by:

isEnabled in interface ExtendedLogger