Lumberjack#

repositories {
    maven { url "https://jitpack.io" }
}

// use the latest version of the library
val lumberjack = "<LATEST-VERSION>" 

// include necessary modules

// core module
implementation("com.github.MFlisar.Lumberjack:core:$lumberjack")

// lumberjack module
implementation("com.github.MFlisar.Lumberjack:implementation-lumberjack:$lumberjack")
implementation("com.github.MFlisar.Lumberjack:logger-console:$lumberjack")
implementation("com.github.MFlisar.Lumberjack:logger-file:$lumberjack")

// timber module
implementation("com.github.MFlisar.Lumberjack:implementation-timber:$lumberjack")
implementation("com.github.MFlisar.Lumberjack:logger-timber-console:$lumberjack")
implementation("com.github.MFlisar.Lumberjack:logger-timber-file:$lumberjack")

// extension module
implementation("com.github.MFlisar.Lumberjack:extension-feedback:$lumberjack")
implementation("com.github.MFlisar.Lumberjack:extension-notification:$lumberjack")
implementation("com.github.MFlisar.Lumberjack:extension-viewer:$lumberjack")
implementation("com.github.MFlisar.Lumberjack:extension-composeviewer:$lumberjack")

// wherever you want use one of L.* functions for logging
// all the functions are implemented as inline functions with lambdas - this means,
// everything inside the lambda is only executed if the log is really ussed

L.d { "a debug log" }
L.e { "a error log" }
L.e(e)
L.e(e) { "an exception log with an additonal message" }
L.v { "TEST-LOG - Verbose log..." }
L.d { "TEST-LOG - Debug log..." }
L.i { "TEST-LOG - Info log..." }
L.w { "TEST-LOG - Warn log..." }
L.e { "TEST-LOG - Error log..." }
L.wtf { "TEST-LOG - WTF log..." }

// optional tags work like following
L.tag("LEVEL").d { "Tagged log message..." }

// you can log something optionally like following
L.logIf { false }?.d { "This will never be logged because logIf evaluates to false..." }

// manual log levels
L.log(Level.DEBUG) { "Debug level log via L.log instead of L.d" }

// if desired you can enable/disable all logs completely 
// e.g. in a release build like following 
// => you probably would want to do this inside the application after the init of Lumberjack
L.enable(BuildConfig.DEBUG)

// Alternatively every logger does support an enabled flag as well
val consoleLogger = ConsoleLogger(enabled = BuildConfig.DEBUG)
val fileLogger = FileLogger(enabled = !BuildConfig.DEBUG, ...)

class ConsoleLogger(
    override var enabled: Boolean = true,
    override val filter: LumberjackFilter = DefaultLumberjackFilter
) : ILumberjackLogger {

    override fun log(
        level: Level,
        tag: String?,
        time: Long,
        fileName: String,
        className: String,
        methodName: String,
        line: Int,
        msg: String?,
        throwable: Throwable?
    ) {
        val link = "(${fileName}:${line})"
        val log = listOfNotNull(
            msg,
            link.takeIf { throwable == null },
            throwable?.stackTraceToString()?.let { "\n$it" }
        ).joinToString(" ")
        Log.println(level.priority, tag, log)
    }

}