README updates
1 file changed
tree: 8ab135e564a083d8ccdaede0f812416516de6448
  1. log4j-api-kotlin/
  2. log4j-api-kotlin-sample/
  3. src/
  4. .gitignore
  5. .travis.yml
  6. checkstyle-header.txt
  7. checkstyle-import-control.xml
  8. checkstyle-suppressions.xml
  9. checkstyle.xml
  10. findbugs-exclude-filter.xml
  11. Jenkinsfile
  12. LICENSE.txt
  13. NOTICE.txt
  14. pom.xml

Apache Log4j 2 Kotlin API

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.

Build Status


Gradle users can add the following dependencies to their build.gradle file:


compile "org.apache.logging.log4j:log4j-api-kotlin:1.0"
compile "org.apache.logging.log4j:log4j-api:2.8.2"
compile "org.apache.logging.log4j:log4j-core:2.8.2"




Log4j Kotlin API requires at least Java 7. 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.


Apache Log4j 2 is distributed under the Apache License, version 2.0.


How to download Log4j, and how to use it from SBT, Maven, Ivy and Gradle.

Issue Tracking

Issues, bugs, and feature requests should be submitted to the JIRA issue tracking system for this project.

Pull request on GitHub are welcome, but please open a ticket in the JIRA issue tracker first, and mention the JIRA issue in the Pull Request.

Building From Source

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.