core/dev.mtctx.foresst.logger

Package-level declarations

Types

ANSI

object ANSI

DefaultLoggingStrategies

class DefaultLoggingStrategies(coroutineScope: CoroutineScope, mutex: Mutex)

Logger

class Logger(config: LoggerConfig)

LoggerCallerInfo

data class LoggerCallerInfo(val className: String, val lineNumber: Int)

LoggerConfig

data class LoggerConfig(val name: String = "Foresst", val logsDirectory: Path = LoggerUtils.logsDir, val coroutineScope: CoroutineScope = CoroutineScope(ForesstDispatchers.Logger + SupervisorJob()), val format: (timestamp: String, strategyName: String, loggerName: String, content: Array<out Any>) -> String = { timestamp, strategyName, loggerName, content -> "[$timestamp] - $strategyName - $loggerName - ${content.joinToString { it.toString() }}" }, val logChannelSize: Int = Channel.UNLIMITED, val logChannel: Channel<LogMessage> = Channel(logChannelSize), val logRotation: LoggerDSL.LogRotation.Config = LoggerDSL.LogRotation.Config(true, 30.days, 1.days))

LoggerDSL

class LoggerDSL

LoggerUtils

object LoggerUtils

LogMessage

data class LogMessage(val content: Array<out Any>, val logToConsole: Boolean, val timestamp: Instant = Clock.System.now(), val strategy: LoggingStrategy)

UseSynchronousFunctionsWithCaution

@Target(allowedTargets = [AnnotationTarget.FUNCTION])

annotation class UseSynchronousFunctionsWithCaution

Functions

createLogger

fun createLogger(): Logger

fun createLogger(block: LoggerDSL.() -> Unit): Logger

getCallerInfo

@JvmOverloads

fun getCallerInfo(skipDepth: Int = 2): LoggerCallerInfo