kotlin-logging/io.github.oshai.kotlinlogging/KLogger

KLogger

actual interface KLogger
actual typealias KLogger = ActualKLogger
actual interface KLogger : ActualKLogger

A Logger interface with Lazy message evaluation example:

logger.info{"this is $lazy evaluated string"}
Content copied to clipboard
actual typealias KLogger = ActualKLogger
expect interface KLogger

A Logger interface with Lazy message evaluation example:

logger.info{"this is $lazy evaluated string"}
Content copied to clipboard

Functions

catching
Link copied to clipboard
actual abstract fun <T : Throwable> catching(throwable: T)

Add a log message indicating an exception is caught along with the stack trace.

abstract fun <T : Throwable> catching(throwable: T)

Add a log message indicating an exception is caught along with the stack trace.

expect abstract fun <T : Throwable> catching(throwable: T)

Add a log message indicating an exception is caught along with the stack trace.

debug
Link copied to clipboard
actual abstract fun debug(msg: () -> Any?)
actual abstract fun debug(marker: Marker?, msg: () -> Any?)

Lazy add a log message if isDebugEnabled is true

actual abstract fun debug(t: Throwable?, msg: () -> Any?)
actual abstract fun debug(marker: Marker?, t: Throwable?, msg: () -> Any?)

Lazy add a log message with throwable payload if isDebugEnabled is true

abstract fun debug(msg: () -> Any?)
abstract fun debug(marker: Marker?, msg: () -> Any?)

Lazy add a log message if isDebugEnabled is true

abstract fun debug(t: Throwable?, msg: () -> Any?)
abstract fun debug(marker: Marker?, t: Throwable?, msg: () -> Any?)

Lazy add a log message with throwable payload if isDebugEnabled is true

abstract fun debug(msg: String?)

Log a message at the DEBUG level.

abstract fun debug(marker: Marker?, msg: String?)

Log a message with the specific Marker at the DEBUG level.

abstract fun debug(msg: String?, arg: Any?)

Log a message at the DEBUG level according to the specified msg and argument.

abstract fun debug(msg: String?, vararg arguments: Any?)
abstract fun debug(msg: String?, arg1: Any?, arg2: Any?)

Log a message at the DEBUG level according to the specified msg and arguments.

abstract fun debug(msg: String?, t: Throwable?)

Log an exception (throwable) at the DEBUG level with an accompanying message.

abstract fun debug(marker: Marker?, msg: String?, arg: Any?)
abstract fun debug(marker: Marker?, msg: String?, vararg arguments: Any?)
abstract fun debug(marker: Marker?, msg: String?, t: Throwable?)
abstract fun debug(marker: Marker?, msg: String?, arg1: Any?, arg2: Any?)

This method is similar to .debug method except that the marker data is also taken into consideration.

expect abstract fun debug(msg: () -> Any?)

Lazy add a log message if isDebugEnabled is true

expect abstract fun debug(marker: Marker?, msg: () -> Any?)

Lazy add a log message with a marker if isDebugEnabled is true

expect abstract fun debug(t: Throwable?, msg: () -> Any?)

Lazy add a log message with throwable payload if isDebugEnabled is true

expect abstract fun debug(marker: Marker?, t: Throwable?, msg: () -> Any?)

Lazy add a log message with a marker and throwable payload if isDebugEnabled is true

entry
Link copied to clipboard
actual abstract fun entry(vararg arguments: Any?)

Add a log message with all the supplied parameters along with method name

abstract fun entry(vararg arguments: Any?)

Add a log message with all the supplied parameters along with method name

expect abstract fun entry(vararg arguments: Any?)

Add a log message with all the supplied parameters along with method name

error
Link copied to clipboard
actual abstract fun error(msg: () -> Any?)
actual abstract fun error(marker: Marker?, msg: () -> Any?)

Lazy add a log message if isErrorEnabled is true

actual abstract fun error(t: Throwable?, msg: () -> Any?)
actual abstract fun error(marker: Marker?, t: Throwable?, msg: () -> Any?)

Lazy add a log message with throwable payload if isErrorEnabled is true

abstract fun error(msg: () -> Any?)
abstract fun error(marker: Marker?, msg: () -> Any?)

Lazy add a log message if isErrorEnabled is true

abstract fun error(t: Throwable?, msg: () -> Any?)
abstract fun error(marker: Marker?, t: Throwable?, msg: () -> Any?)

Lazy add a log message with throwable payload if isErrorEnabled is true

abstract fun error(msg: String?)

Log a message at the ERROR level.

abstract fun error(marker: Marker?, msg: String?)

Log a message with the specific Marker at the ERROR level.

abstract fun error(msg: String?, arg: Any?)

Log a message at the ERROR level according to the specified msg and argument.

abstract fun error(msg: String?, vararg arguments: Any?)
abstract fun error(msg: String?, arg1: Any?, arg2: Any?)

Log a message at the ERROR level according to the specified msg and arguments.

abstract fun error(msg: String?, t: Throwable?)

Log an exception (throwable) at the ERROR level with an accompanying message.

abstract fun error(marker: Marker?, msg: String?, arg: Any?)
abstract fun error(marker: Marker?, msg: String?, vararg arguments: Any?)
abstract fun error(marker: Marker?, msg: String?, t: Throwable?)
abstract fun error(marker: Marker?, msg: String?, arg1: Any?, arg2: Any?)

This method is similar to .error method except that the marker data is also taken into consideration.

expect abstract fun error(msg: () -> Any?)

Lazy add a log message if isErrorEnabled is true

expect abstract fun error(marker: Marker?, msg: () -> Any?)

Lazy add a log message with a marker if isErrorEnabled is true

expect abstract fun error(t: Throwable?, msg: () -> Any?)

Lazy add a log message with throwable payload if isErrorEnabled is true

expect abstract fun error(marker: Marker?, t: Throwable?, msg: () -> Any?)

Lazy add a log message with a marker and throwable payload if isErrorEnabled is true

exit
Link copied to clipboard
actual abstract fun exit()

Add log message indicating exit of a method

actual abstract fun <T> exit(result: T): T

Add a log message with the return value of a method

abstract fun exit()

Add log message indicating exit of a method

abstract fun <T> exit(result: T): T

Add a log message with the return value of a method

expect abstract fun exit()

Add log message indicating exit of a method

expect abstract fun <T> exit(result: T): T

Add a log message with the return value of a method

info
Link copied to clipboard
actual abstract fun info(msg: () -> Any?)
actual abstract fun info(marker: Marker?, msg: () -> Any?)

Lazy add a log message if isInfoEnabled is true

actual abstract fun info(t: Throwable?, msg: () -> Any?)
actual abstract fun info(marker: Marker?, t: Throwable?, msg: () -> Any?)

Lazy add a log message with throwable payload if isInfoEnabled is true

abstract fun info(msg: () -> Any?)
abstract fun info(marker: Marker?, msg: () -> Any?)

Lazy add a log message if isInfoEnabled is true

abstract fun info(t: Throwable?, msg: () -> Any?)
abstract fun info(marker: Marker?, t: Throwable?, msg: () -> Any?)

Lazy add a log message with throwable payload if isInfoEnabled is true

abstract fun info(msg: String?)

Log a message at the INFO level.

abstract fun info(marker: Marker?, msg: String?)

Log a message with the specific Marker at the INFO level.

abstract fun info(msg: String?, arg: Any?)

Log a message at the INFO level according to the specified msg and argument.

abstract fun info(msg: String?, vararg arguments: Any?)
abstract fun info(msg: String?, arg1: Any?, arg2: Any?)

Log a message at the INFO level according to the specified msg and arguments.

abstract fun info(msg: String?, t: Throwable?)

Log an exception (throwable) at the INFO level with an accompanying message.

abstract fun info(marker: Marker?, msg: String?, arg: Any?)
abstract fun info(marker: Marker?, msg: String?, vararg arguments: Any?)
abstract fun info(marker: Marker?, msg: String?, t: Throwable?)
abstract fun info(marker: Marker?, msg: String?, arg1: Any?, arg2: Any?)

This method is similar to .info method except that the marker data is also taken into consideration.

expect abstract fun info(msg: () -> Any?)

Lazy add a log message if isInfoEnabled is true

expect abstract fun info(marker: Marker?, msg: () -> Any?)

Lazy add a log message with a marker if isInfoEnabled is true

expect abstract fun info(t: Throwable?, msg: () -> Any?)

Lazy add a log message with throwable payload if isInfoEnabled is true

expect abstract fun info(marker: Marker?, t: Throwable?, msg: () -> Any?)

Lazy add a log message with a marker and throwable payload if isInfoEnabled is true

Link copied to clipboard
abstract fun isDebugEnabled(marker: Marker?): Boolean

Similar to .isDebugEnabled method except that the marker data is also taken into account.

Link copied to clipboard
fun KLogger.isEnabledForLevel(level: Level): Boolean

Returns whether this Logger is enabled for a given Level.

Link copied to clipboard
abstract fun isErrorEnabled(marker: Marker?): Boolean

Similar to .isErrorEnabled method except that the marker data is also taken into consideration.

Link copied to clipboard
abstract fun isInfoEnabled(marker: Marker?): Boolean

Similar to .isInfoEnabled method except that the marker data is also taken into consideration.

Link copied to clipboard
abstract fun isLoggingOff(marker: Marker?): Boolean

Similar to .isLoggingOff method except that the marker data is also taken into consideration.

Link copied to clipboard
abstract fun isTraceEnabled(marker: Marker?): Boolean

Similar to .isTraceEnabled method except that the marker data is also taken into account.

Link copied to clipboard
abstract fun isWarnEnabled(marker: Marker?): Boolean

Similar to .isWarnEnabled method except that the marker data is also taken into consideration.

throwing
Link copied to clipboard
actual abstract fun <T : Throwable> throwing(throwable: T): T

Add a log message indicating an exception will be thrown along with the stack trace.

abstract fun <T : Throwable> throwing(throwable: T): T

Add a log message indicating an exception will be thrown along with the stack trace.

expect abstract fun <T : Throwable> throwing(throwable: T): T

Add a log message indicating an exception will be thrown along with the stack trace.

trace
Link copied to clipboard
actual abstract fun trace(msg: () -> Any?)
actual abstract fun trace(marker: Marker?, msg: () -> Any?)

Lazy add a log message if isTraceEnabled is true

actual abstract fun trace(t: Throwable?, msg: () -> Any?)
actual abstract fun trace(marker: Marker?, t: Throwable?, msg: () -> Any?)

Lazy add a log message with throwable payload if isTraceEnabled is true

abstract fun trace(msg: () -> Any?)
abstract fun trace(marker: Marker?, msg: () -> Any?)

Lazy add a log message if isTraceEnabled is true

abstract fun trace(t: Throwable?, msg: () -> Any?)
abstract fun trace(marker: Marker?, t: Throwable?, msg: () -> Any?)

Lazy add a log message with throwable payload if isTraceEnabled is true

abstract fun trace(msg: String?)

Log a message at the TRACE level.

abstract fun trace(marker: Marker?, msg: String?)

Log a message with the specific Marker at the TRACE level.

abstract fun trace(msg: String?, arg: Any?)

Log a message at the TRACE level according to the specified msg and argument.

abstract fun trace(msg: String?, vararg arguments: Any?)
abstract fun trace(msg: String?, arg1: Any?, arg2: Any?)

Log a message at the TRACE level according to the specified msg and arguments.

abstract fun trace(msg: String?, t: Throwable?)

Log an exception (throwable) at the TRACE level with an accompanying message.

abstract fun trace(marker: Marker?, msg: String?, arg: Any?)
abstract fun trace(marker: Marker?, msg: String?, vararg arguments: Any?)
abstract fun trace(marker: Marker?, msg: String?, t: Throwable?)
abstract fun trace(marker: Marker?, msg: String?, arg1: Any?, arg2: Any?)

This method is similar to .trace method except that the marker data is also taken into consideration.

expect abstract fun trace(msg: () -> Any?)

Lazy add a log message if isTraceEnabled is true

expect abstract fun trace(marker: Marker?, msg: () -> Any?)

Lazy add a log message with a marker if isTraceEnabled is true

expect abstract fun trace(t: Throwable?, msg: () -> Any?)

Lazy add a log message with throwable payload if isTraceEnabled is true

expect abstract fun trace(marker: Marker?, t: Throwable?, msg: () -> Any?)

Lazy add a log message with a marker and throwable payload if isTraceEnabled is true

warn
Link copied to clipboard
actual abstract fun warn(msg: () -> Any?)
actual abstract fun warn(marker: Marker?, msg: () -> Any?)

Lazy add a log message if isWarnEnabled is true

actual abstract fun warn(t: Throwable?, msg: () -> Any?)
actual abstract fun warn(marker: Marker?, t: Throwable?, msg: () -> Any?)

Lazy add a log message with throwable payload if isWarnEnabled is true

abstract fun warn(msg: () -> Any?)
abstract fun warn(marker: Marker?, msg: () -> Any?)

Lazy add a log message if isWarnEnabled is true

abstract fun warn(t: Throwable?, msg: () -> Any?)
abstract fun warn(marker: Marker?, t: Throwable?, msg: () -> Any?)

Lazy add a log message with throwable payload if isWarnEnabled is true

abstract fun warn(msg: String?)

Log a message at the WARN level.

abstract fun warn(marker: Marker?, msg: String?)

Log a message with the specific Marker at the WARN level.

abstract fun warn(msg: String?, arg: Any?)

Log a message at the WARN level according to the specified msg and argument.

abstract fun warn(msg: String?, vararg arguments: Any?)
abstract fun warn(msg: String?, arg1: Any?, arg2: Any?)

Log a message at the WARN level according to the specified msg and arguments.

abstract fun warn(msg: String?, t: Throwable?)

Log an exception (throwable) at the WARN level with an accompanying message.

abstract fun warn(marker: Marker?, msg: String?, arg: Any?)
abstract fun warn(marker: Marker?, msg: String?, vararg arguments: Any?)
abstract fun warn(marker: Marker?, msg: String?, t: Throwable?)
abstract fun warn(marker: Marker?, msg: String?, arg1: Any?, arg2: Any?)

This method is similar to .warn method except that the marker data is also taken into consideration.

expect abstract fun warn(msg: () -> Any?)

Lazy add a log message if isWarnEnabled is true

expect abstract fun warn(marker: Marker?, msg: () -> Any?)

Lazy add a log message with a marker if isWarnEnabled is true

expect abstract fun warn(t: Throwable?, msg: () -> Any?)

Lazy add a log message with throwable payload if isWarnEnabled is true

expect abstract fun warn(marker: Marker?, t: Throwable?, msg: () -> Any?)

Lazy add a log message with a marker and throwable payload if isWarnEnabled is true

Properties

isDebugEnabled
Link copied to clipboard
actual abstract val isDebugEnabled: Boolean

Is the logger instance enabled for the DEBUG level?

abstract val isDebugEnabled: Boolean

Is the logger instance enabled for the DEBUG level?

expect abstract val isDebugEnabled: Boolean

Is the logger instance enabled for the DEBUG level?

isErrorEnabled
Link copied to clipboard
actual abstract val isErrorEnabled: Boolean

Is the logger instance enabled for the ERROR level?

abstract val isErrorEnabled: Boolean

Is the logger instance enabled for the ERROR level?

expect abstract val isErrorEnabled: Boolean

Is the logger instance enabled for the ERROR level?

isInfoEnabled
Link copied to clipboard
actual abstract val isInfoEnabled: Boolean

Is the logger instance enabled for the INFO level?

abstract val isInfoEnabled: Boolean

Is the logger instance enabled for the INFO level?

expect abstract val isInfoEnabled: Boolean

Is the logger instance enabled for the INFO level?

isLoggingOff
Link copied to clipboard
actual abstract val isLoggingOff: Boolean

Is the logger instance OFF?

abstract val isLoggingOff: Boolean

Is the logger instance OFF?

expect abstract val isLoggingOff: Boolean

Is the logger instance OFF?

isTraceEnabled
Link copied to clipboard
actual abstract val isTraceEnabled: Boolean

Is the logger instance enabled for the TRACE level?

abstract val isTraceEnabled: Boolean

Is the logger instance enabled for the TRACE level?

expect abstract val isTraceEnabled: Boolean

Is the logger instance enabled for the TRACE level?

isWarnEnabled
Link copied to clipboard
actual abstract val isWarnEnabled: Boolean

Is the logger instance enabled for the WARN level?

abstract val isWarnEnabled: Boolean

Is the logger instance enabled for the WARN level?

expect abstract val isWarnEnabled: Boolean

Is the logger instance enabled for the WARN level?

name
Link copied to clipboard
actual abstract val name: String

Return the name of this Logger instance.

abstract val name: String

Return the name of this Logger instance.

expect abstract val name: String

Return the name of this Logger instance.

Link copied to clipboard
abstract val underlyingLogger: Any

The actual logger executing logging