Logging library experiment with a usage pattern similar to Timber, featuring platform-specific implementations and custom seedlings. Supports automatic log tagging, Kotlin extensions, and seamless migration from Timber.
Timber like logging implementation for Kotlin Multiplatform.
This library was built as a practical experiment with Kotlin Multiplatform and specifically the new single module approach. Despite Kotlin's excellent documentation it was unclear how to properly publish all artifacts to Maven such as sources and documentation. Hopefully this project provides a more complete template for others to use.
Arbor follows a very similar usage pattern to Timber. Key differences exist in feature support and terminology which was done purely because I had a thesaurus laying around.
Seedlings are platform specific logging implementations such as using Logcat in Android, NSLog in iOS, and println in JavaScript.
Android
Arbor.sow(LogCatSeedling())
JavaScript
Arbor.sow(Seedling())
JVM
Arbor.sow(Seedling())
iOS
Arbor.sow(Seedling())
Custom seedlings can be created from the com.toxicbakery.logging.ISeedling interface.
All logging is triggered from the Arbor static methods which supports debug, info, verbose, warning, error, and wtf. Logging calls are passed to the underlying branch implementation and finally to the sown seedling instances.
Arbor.d("Hello World!")
Log tagging is automatic on Android but can be easily overridden.
Arbor.tag("Custom Tag").i("My Log with a tag.")
While Arbor supports writing string concatenations, leveraging Kotlin concatenations leads to strings being evaluated regardless of if they will be logged. In release that means CPU cycles may be wasted towards logging that is ultimately never printed. The arbor Kotlin extension leverages functions to work around this.
Debug message
arbor { "Debug" }
Changing the log level
arbor(LogLevel.E) { "Error" }
Levering custom tags via Arbor branches
val tag = Arbor.tag("MyTag")
arbor(branch = tag) { "Custom Tag" }
Arbor is a Kotlin Multiplatform project support multiple target platforms.
Supported Platforms:
Kotlin
implementation("com.toxicbakery.logging:arbor:3.+")
Android
implementation("com.toxicbakery.logging:arbor-android:3.+")
Surfaced from shared tags and platforms — no rankings paid for.