7.0.7

kotlin-logging/io.github.oshai.kotlinlogging

Package-level declarations

Types

interface Appender

ConsoleOutputAppender

class ConsoleOutputAppender : FormattingAppender

object ConsoleOutputAppender : FormattingAppender

class ConsoleOutputAppender : FormattingAppender

class DarwinKLogger(val name: String, val underlyingLogger: os_log_t) : KLogger, DelegatingKLogger<os_log_t>

DefaultMessageFormatter

class DefaultMessageFormatter(includePrefix: Boolean = true) : Formatter

DelegatingKLogger

interface DelegatingKLogger<T>

interface Formatter

FormattingAppender

abstract class FormattingAppender : Appender

interface ~~KLoggable~~

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

interface KLogger

A Logger interface with Lazy message evaluation example:

open class ~~KLogging~~ : KLoggable

A class with logging capabilities usage example:

data class KLoggingEvent(val level: Level, val marker: Marker?, val loggerName: String, val message: String? = null, val cause: Throwable? = null, val payload: Map<String, Any?>? = null)

KLoggingEventBuilder

class KLoggingEventBuilder

object KMarkerFactory

A platform independent factory to create markers.

object KotlinLogging

KotlinLoggingConfiguration

object KotlinLoggingConfiguration

expect object KotlinLoggingConfiguration

actual object KotlinLoggingConfiguration

actual object KotlinLoggingConfiguration

actual object KotlinLoggingConfiguration

enum Level : Enum<Level>

object Levels

interface Marker

A platform independent marker to enrich log statements.

open class ~~NamedKLogging~~(name: String) : KLoggable

A class with logging capabilities and explicit logger name

Properties

DefaultAppender

actual val DefaultAppender: Appender

expect val DefaultAppender: Appender

Functions

isLoggingEnabled

fun Level.isLoggingEnabled(): Boolean

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: