Kotlin (Multiplatform) logging facade for idiomatic logging in Kotlin with appenders for all supported KMP platforms.
implementation("net.codinux.log:klf:1.6.2")
For native images use
implementation("net.codinux.log:klf-graal:1.6.2")
which substitutes calls to reflection. (As otherwise each class for which a Logger gets created would need to be annotated with @RegisterForReflection.)
With version 1.6.0 the project has been renamed from kmp-log to klf and the Kotlin version changed from 1.8 to 1.9.
Projects targeting Kotlin 1.8 therefore should use net.codinux.log:kmp-log:1.5.1.
package com.example.service
import net.codinux.log.logger
class OrderService {
private val log by logger() // automatically uses declaring class / OrderService::class.name as logger name
fun showUsage() {
log.info { "Message with ${heavyCalculation()}" } // lambda and therefor heavyCalculation() gets only called if INFO level is enabled
log.error(e) { "An error occurred" } // e is a throwable
}
}The log lambdas like info { }, warn { }, ... are only called if the according log level is enabled.
Therefor there's no need for String formats like log.info("Message with %s", heavyCalculation()) as "Message with ${heavyCalculation()}" of example above gets only called if INFO level is enabled.
With by logger() the logger name gets automatically derived from declaring class. In above example it would by "com.example.service.OrderService".
And the logger instance gets instantiated lazily on its first usage (or never if it never gets called).
If the logger is declared in a companion object automatically the enclosing class gets used as logger name
(like in the following example OrderService instead of OrderService.Companion).
Except on JavaScript, there the logger name will always be "Companion".
import net.codinux.log.logger
class OrderService {
companion object {
private val log by logger() // automatically uses enclosing class = OrderService::class.name as logger name (except on JavaScript)
}
}package com.example.service
import net.codinux.log.LoggerFactory
class OrderService {
private val log = LoggerFactory.getLogger(OrderService::class)
// or by setting logger name (tag) via a string
private val logByName = LoggerFactory.getLogger("OrderService")
fun showUsage() {
log.info("An info message: $detailedMessage") // string get directly concatenated whether INFO level is enabled or not
logByName.error("An error occurred", e) // e is a throwable
}
}You might ask why is there no overload with format arguments like fun info(message: String, exception: Throwable? = null, vararg arguments: Any).
This is due to the restrictions of Kotlin multiplatform as there's no String.format() available (also the format specifier differ, e.g. %s on the JVM and %@ on iOS and macOS).
So if you like to format the log message, please use lambda variants.
Since version 1.5.0 klf also supports static Loggers:
package com.example.service
import net.codinux.log.LoggerFactory
class OrderService {
fun showUsage() {
Log.info<OrderService> { "Message with ${heavyCalculation()}" }
Log.errorOrderService(e) { "An error occurred" } // e is a throwable
// or set the logger tag explicitly:
Log.info(loggerName = "OrderService") { "Message with ${heavyCalculation()}" }
}
}klf by ships with a lot of log appenders. Depending on the platform by default these appenders are used:
If slf4j is on the classpath: slf4j.
Otherwise: Console (println())
Logcat
If available (iOS 10.0+, iPadOS 10.0+, macOS 10.12+, Mac Catalyst 13.1+, tvOS 10.0+, watchOS 3.0+): OSLog
Otherwise: NSLog
JavaScript Console (console.log() / console.error() / ...)
Console (println())
You can also use add your custom log appender by implementing Appender interface:
LoggerFactory.addAppender(CustomAppender()) // CustomAppender implements Appender interfaceIf you dislike above default appenders and want to control logger creation entirely implement ILoggerFactory and call:
LoggerFactory.setLoggerFactory(MyCustomLoggerFactory())Version 1.1.3 added experimental support for WASM Browser. While it should work in most circumstances, there is explicitly currently no support for multithreaded applications due to lack of synchronization mechanisms in Kotlin WASM.
klf has some convenience functions if values should get added to MDC (Mapped Diagnostic Context) only for the next log message and should then automatically get cleared again:
log.withMdc("key1" to "value1", "key2" to "value2").info { "Info" }Or
runWithMdc("key1" to "value1") {
log.info { "Info" }
}The terminology is mostly identical with slf4j / logback.
Primary facade to create a Logger, e.g.
private val log = LoggerFactory.getLogger(OrderService::class).
klf ships with two LoggerFactories:
- Slf4jLoggerFactory that delegates logging to slf4j, so that on JVM any logging framework that implements slf4j can be used. Gets automatically used if slf4j is on the classpath and its ILoggerFactory implementation is any other than NOPLoggerFactory.
- DefaultLoggerFactory that delegates logging to system's default log appender (see Log appenders).
Interface to log messages at different levels (Info, Error, ...) , e.g.
log.error(e) { "Calculating Fibonacci numbers for $number failed" }.
- If a messages gets accepted by a Logger, Appender do the actual work of 'writing' log messages.
- Multiple appender can be defined so that one logged messages e.g. gets written to console, to a file (only available via a slf4j compatible logging framework), to Elasticsearch, Loki, ...
- All Loggers use the same appenders. (It's not possible to set an appender for a specific Logger like as logback.)
- Except ConsoleAppender klf doesn't implement any Appender itself but delegates on to native loggers like Logcat, OSLog, JavaScript Console, slf4j, ...
Copyright 2023 codinux GmbH & Co. KG
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.