| commit | 8e34749e87aea3eada850e1de4f48dfa7542d5c8 | [log] [tgz] |
|---|---|---|
| author | Matt Sicker <mattsicker@apache.org> | Sun Jan 29 19:06:55 2023 -0600 |
| committer | Matt Sicker <mattsicker@apache.org> | Sun Jan 29 19:06:55 2023 -0600 |
| tree | 578b58e1834c84b2f15a32976f52b42a19af05ce | |
| parent | 84a915aaf7fda502f4c88adfef58904227e60444 [diff] |
Remove outdated comments
Log4j Kotlin API is a Kotlin logging facade based on Log4j 2. Log4j Kotlin API provides Log4j 2 as its default logging implementation, but this is not strictly required (e.g., this API can also be used with Logback or other Log4j 2 API provider implementations). Idiomatic Kotlin features are provided as an alternative to using the Log4j 2 Java API.
By sending a pull request you grant the Apache Software Foundation sufficient rights to use and release the submitted work under the Apache license. You grant the same rights (copyright license, patent license, etc.) to the Apache Software Foundation as if you have signed a Contributor License Agreement. For contributions that are judged to be non-trivial, you will be asked to actually signing a Contributor License Agreement.
Users should refer to Maven, Ivy and Gradle Artifacts on the Log4j website for instructions on how to include Log4j into their project using their chosen build tool.
Using the Kotlin API is as simple as mixing in the Logging interface to your class. Example:
import org.apache.logging.log4j.kotlin.Logging class MyClass: BaseClass, Logging { fun doStuff() { logger.info("Doing stuff") } fun doStuffWithUser(user: User) { logger.info { "Doing stuff with ${user.name}." } } }
The Logging interface can also be mixed into object declarations, including companions. This is generally preferable over the previous approach as there is a single logger created for every instance of the class.
import org.apache.logging.log4j.kotlin.Logging class MyClass: BaseClass { companion object : Logging // ... }
Alternatively, a more traditional style can be used to instantiate a logger instance:
import org.apache.logging.log4j.kotlin class MyClass: BaseClass { val logger = logger() // ... }
The function logger() is an extension function on the Any type (or more specifically, any type T that extends Any).
The Kotlin‘s Log4j 2 User’s Guide is available here.
Log4j Kotlin API requires at least Java 8. This also requires Log4j 2 API, but it is specified as transitive dependencies automatically if you are using SBT, Maven, Gradle, or some other similar build system. This also requires Log4j 2 Core (or possibly an other implementation of Log4j 2 API) as a runtime dependency. Some Log4j 2 Core features require optional dependencies which are documented in the Log4j 2 manual.
The Kotlin API requires the full kotlin-reflect dependency in order to name loggers appropriately, and optionally kotlinx-coroutines-core to set the mapped diagnostic context for a coroutine.
The Kotlin dependencies are not exposed transitively -- for maximum compatibility logging-log4j-kotlin is built with Kotlin 1.3, producing binaries that should be forward compatible. For maximum compat, the Kotlin dependencies are “provided” i.e. consumers of this library need to depend on them directly rather than transitively, thus avoiding version clashes.
Apache Log4j 2 is distributed under the Apache License, version 2.0.
How to download Log4j, and how to use it from Maven, Ivy and Gradle. You can access the latest development snapshot by using the Maven repository https://repository.apache.org/snapshots, see Snapshot builds.
Issues, bugs, and feature requests should be submitted to the GitHub issues page for this project.
Pull request on GitHub are welcome; corresponding GitHub issues should be referenced in the PR.
Log4j Kotlin API requires Maven 3 and Java 8 to build. To install to your local Maven repository, execute the following:
mvn install
We love contributions! Take a look at our contributing page.