https://github.com/sergejsha/logger
Minimalistic, fast and configurable Logger for Kotlin Multiplatform.
https://github.com/sergejsha/logger
kotlin-multiplatform logging-library
Last synced: 5 months ago
JSON representation
Minimalistic, fast and configurable Logger for Kotlin Multiplatform.
- Host: GitHub
- URL: https://github.com/sergejsha/logger
- Owner: sergejsha
- License: apache-2.0
- Created: 2024-07-10T14:27:34.000Z (almost 2 years ago)
- Default Branch: master
- Last Pushed: 2025-12-21T18:38:30.000Z (7 months ago)
- Last Synced: 2025-12-23T06:21:29.685Z (7 months ago)
- Topics: kotlin-multiplatform, logging-library
- Language: Kotlin
- Homepage:
- Size: 859 KB
- Stars: 64
- Watchers: 1
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://central.sonatype.com/artifact/de.halfbit/logger)
# 🪵 Logger
Minimalistic and concise Logger for Kotlin Multiplatform from one of my projects,
shared with the awesome Kotlin community.
# Architecture
# Usage
```kotlin
// 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
```swift
init() {
LogKt.initializeLogger { builder in
builder.registerIosLogSink(logPrinter: LogPrinterCompanion.shared.Default)
}
}
private let TAG = "SampleApp"
LogKt.d(tag: TAG) {
"debug message"
}
```
## Android usage
```kotlin
override fun onCreate() {
initializeLogger {
registerAndroidLogSink()
}
}
```
## Desktop usage
```kotlin
fun main() {
initializeLogger {
registerPrintlnSink()
}
}
```
## Browser usage
```kotlin
fun main() {
initializeLogger {
registerConsoleLogSink()
}
}
```
# How to
## Disable logger for a class
```kotlin
// 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
```kotlin
class Reader {
private val tag = classTag()
init {
d(tag) { "created" }
}
}
```
# How to use it in my project?
In `gradle/libs.versions.toml`
```toml
[versions]
kotlin = "2.3.0"
logger = "0.10"
[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`
```kotlin
plugins {
alias(libs.plugins.kotlin.multiplatform)
}
kotlin {
sourceSets {
commonMain.dependencies {
implementation(libs.logger)
}
}
}
```
# Publish to maven Central
1. Bump version in `build.gradle.kts` of the root project
2. `./gradlew clean build releaseToMavenCentral`
# License
```
Copyright 2024-2026 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.
```