README.md

🪵 Logger

Minimalistic and concise Logger for Kotlin Multiplatform from one of my projects, shared with the awesome Kotlin community.

Usage

// Initialize
class App : Application() {
    override fun onCreate() {
        initializeLogger {
            registerPrintlnSink() // used by default if no sinks are configured
            registerMemoryRingSink()
            registerAndroidLogSink()
            loggableLevel = if (isDebugBuild) Everything else InfoAndSevere
        }
    }
}

// Use logger
private const val TAG = "Reader"

class Reader(private val bufferSize: Int) {

    init {
        i(TAG) { "created: size=$bufferSize" } // info
        d(TAG) { "created: size=$bufferSize" } // debug
    }

    suspend fun readData() {
        try {
            httpClient.get("read-data")
        } catch (e: Exception) {
            w(TAG, e) { "data reading failed" } // warning
            e(TAG, e) // error
        }
    }
}

iOS usage

init() {
    LogKt.initializeLogger { builder in
        builder.registerIosLogSink(logPrinter: LogPrinterCompanion.shared.Default)
    }
}

private let TAG = "SampleApp"
LogKt.d(tag: TAG) { "debug message" }

Android usage

override fun onCreate() {
    initializeLogger {
        registerAndroidLogSink()
    }
}

Desktop usage

fun main() {
    initializeLogger {
        registerPrintlnSink()
    }
}

Browser usage

fun main() {
    initializeLogger {
        registerConsoleLogSink()
    }
}

How to

Disable logger for a class

// Create a named tag instance instead of a string-tag
private val tag = namedTag("ScaleAnimation")

// Use the tag in log-functions
d(tag) { "animation started" }
d(tag) { "scale: ${scale.value}" }
...

// Set a loggable level to disable unwanted logs for this tag
private val tag = namedTag("ScaleAnimation", LoggableLevel.Nothing)

Use class name for tags

class Reader {
    private val tag = classTag<Reader>()

    init {
        d(tag) { "created" }
    }
}

How to use it in my project?

In gradle/libs.versions.toml

[versions]
kotlin = "2.0.20"
logger = "0.7"

[libraries]
logger = { module = "de.halfbit:logger", version.ref = "logger" }

[plugins]
kotlin-multiplatform = { id = "org.jetbrains.kotlin.multiplatform", version.ref = "kotlin" }

In shared/build.gradle.kts

plugins {
    alias(libs.plugins.kotlin.multiplatform)
}

kotlin {
    sourceSets {
        commonMain.dependencies {
            implementation(libs.logger)
        }
    }
}

Publish to maven Central

1. Bump version in root.publication.gradle.kts
2. ./gradlew clean build publishAllPublicationsToCentralRepository

Publish to local maven

1. Set X.X-SNAPSHOT version in root.publication.gradle.kts
2. ./gradlew clean build publishToMavenLocal

License

Copyright 2024 Sergej Shafarenka, www.halfbit.de

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

   http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.