kotlin-logging/io.github.oshai.kotlinlogging

Package-level declarations

Types

ActualKLogger

interface ActualKLogger

Appender

interface Appender

ConsoleOutputAppender

object ConsoleOutputAppender : Appender

DefaultMessageFormatter

object DefaultMessageFormatter : Formatter

Formatter

interface Formatter

KLoggable

interface KLoggable

An interface representing class with logging capabilities implemented using a logger obtain a logger with logger() method

KLogger

actual interface KLogger

actual typealias KLogger = ActualKLogger

actual interface KLogger : ActualKLogger

A Logger interface with Lazy message evaluation example:

actual typealias KLogger = ActualKLogger

expect interface KLogger

A Logger interface with Lazy message evaluation example:

KLogging

open class KLogging : KLoggable

A class with logging capabilities usage example:

KMarkerFactory

object KMarkerFactory

A platform independent factory to create markers.

KotlinLogging

object KotlinLogging

KotlinLoggingConfiguration

object KotlinLoggingConfiguration

Level

enum Level : Enum<Level>

Levels

object Levels

Marker

interface Marker

A platform independent marker to enrich log statements.

NamedKLogging

open class NamedKLogging(name: String) : KLoggable

A class with logging capabilities and explicit logger name

OSLogAppender

open class OSLogAppender : Appender

OSLogSubsystemAppender

class OSLogSubsystemAppender(val subsystem: String) : OSLogAppender

SimpleNativeTest

class SimpleNativeTest

Functions

isEnabledForLevel

fun KLogger.isEnabledForLevel(level: Level): Boolean

Returns whether this Logger is enabled for a given Level.

isLoggingEnabled

fun Level.isLoggingEnabled(): Boolean

logger

fun KotlinLogging.logger(): ReadOnlyProperty<Any?, KLogger>

The JS way to define a logger without explicit name

withLoggingContext

inline fun <T> withLoggingContext(vararg pair: Pair<String, String?>, restorePrevious: Boolean = true, body: () -> T): T

Use a vary number of pairs in MDC context. Example:

inline fun <T> withLoggingContext(pair: Pair<String, String?>, restorePrevious: Boolean = true, body: () -> T): T

Use a pair in MDC context. Example:

inline fun <T> withLoggingContext(map: Map<String, String?>, restorePrevious: Boolean = true, body: () -> T): T

Use a map in MDC context. Example:

Properties

DefaultAppender

expect val DefaultAppender: Appender