arch-lumber
1.2.0indexedLightweight, type-safe logging with a simple API, multiple levels, prebuilt DebugOaks for common backends, composable thread-safe Oak system and easy extensibility.
2
Stars
1
Used by
dependents
—
Health
/ 100
Arch Lumber
Arch Lumber is a Kotlin Multiplatform logging library with a small public API and platform-specific
DebugOak defaults.
Requirements
- Kotlin
2.4.0 - Gradle wrapper
9.5.1 - JDK
21via the Gradle toolchain and Foojay resolver - Android
minSdk 20andcompileSdk 36 - Use the project wrapper instead of a local Gradle install
What it does
Lumberis the logging entry pointLumber.Oakis the extension point for custom sinksDebugOakgives you platform defaults out of the box- tagged facades keep context across calls, while quiet and length options stay one-shot
Documentation Maintenance
- Keep KDoc aligned with the shipped contract of public APIs.
- Update MkDocs pages and the generated Dokka HTML when setup, usage, API, compatibility, or platform behavior changes.
- Keep dependency versions, Android compatibility notes, and toolchain references aligned with project configuration.
- Generate release changelogs from the diff between the previous tag and the release tag.
- Keep contributor-facing guidance in
CONTRIBUTING.md.
Quick Start
Lumber.plant(DebugOak())
Lumber.info("App started")
Installation
dependencies {
implementation("io.github.matheus-corregiari:arch-lumber:<latest>")
}
Core API
Plant an oak
Lumber.plant(DebugOak())
Log a message
Lumber.debug("User %s signed in", userName)
Lumber.warn("Cache miss for %s", cacheKey)
Lumber.error(exception, "Operation failed")
Add context
val authLog = Lumber.tag("Auth")
authLog.info("Session created")
authLog.info("Session refreshed")
Write a custom oak
class AnalyticsOak : Lumber.Oak() {
override fun isLoggable(tag: String?, level: Lumber.Level) = level >= Lumber.Level.Info
override {
Analytics.track(level.name, tag, message, error)
}
}
Lumber.plant(AnalyticsOak())
Platform behavior
| Target | Default DebugOak output |
|---|
Target compatibility
Docs
Future Enhancements
- add a first-class structured logging adapter
- add a file-backed oak example for long-running apps
- add richer Android log filtering examples
- add release-note automation so changelog pages are generated from commits
- add platform-specific docs snippets for Android, JVM, Apple, JS, and WasmJS
License
Copyright 2025 Matheus Corregiari
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.