Log4K
Lightweight logging library for Kotlin/Multiplatform. Supports Android, iOS, JavaScript and plain JVM environments.
Download
Artifacts are published to Maven Central:
repositories {
mavenCentral()
}
dependencies {
implementation("de.peilicke.sascha:log4k:1.0.1")
}
Usage
Logging messages is straightforward, the Log object provides the usual functions you'd expect:
Log.verbose("FYI")
Log.debug("Debugging ${foo.bar}")
Log.info("Nice to know")
Log.warn("Warning about $stuff ...")
Log.error("Oops!")
Log.assert("Something went wrong!", throwable)
The log output includes the function name and line and pretty-prints exceptions on all supported platforms:
I/Application.onCreate: Log4K rocks!
Configuration (Android example)
To only output messages with log-level info and above, you can configure the console logger in your Application class:
class MyApplication : Application() {
override fun onCreate() {
super.onCreate()
Log.loggers.add(ConsoleLogger().apply {
if (!BuildConfig.DEBUG) {
minimumLogLevel = Log.Level.Info
}
})
}
}
Custom logger (Android Crashlytics example)
The library provides a cross-platform ConsoleLogger by default. Custom loggers can easily be added. For instance, to send only ERROR and ASSERT messages to Crashlytics in production builds, you could do the following:
class MyApplication : Application() {
override fun onCreate() {
super.onCreate()
Log.loggers += when {
BuildConfig.DEBUG -> ConsoleLogger()
else -> CrashlyticsLogger()
}
}
private class CrashlyticsLogger : Logger() {
override fun print(level: Log.Level, tag: String, message: String?, throwable: Throwable?) {
val priority = when (level) {
Log.Level.Verbose -> VERBOSE
Log.Level.Debug -> DEBUG
Log.Level.Info -> INFO
Log.Level.Warning -> WARN
Log.Level.Error -> ERROR
Log.Level.Assert -> ASSERT
}
if (priority >= ERROR) {
FirebaseCrashlytics.getInstance().log("$priority $tag $message")
throwable?.let { FirebaseCrashlytics.getInstance().recordException(it) }
}
}
}
}
Users
License
Copyright 2019 Sascha Peilicke
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.
1 Mar 22, 2022
37 Dec 29, 2022
2 Dec 14, 2022
7 Jul 17, 2022
1 Dec 30, 2021
28 Nov 14, 2022
60 Dec 18, 2022
83 Oct 30, 2022
4 May 10, 2022
14 Nov 15, 2022
4 Aug 6, 2022
2 May 8, 2022
29 Dec 15, 2022
151 Jan 1, 2023
2 May 15, 2022
1 Nov 3, 2022
121 Dec 26, 2022
203 Nov 18, 2022