Logging for Kotlin SDK

This page explains how to configure logging in the PubNub Kotlin Software Development Kit (SDK) using SLF4J and popular backends.

How to enable logging

Pubnub implements swappable logging using SLF4J, which allows you to switch different logging frameworks (logback, log4j, slf4j-simple, commons-logging, java.util.logging) easily. All the logging calls using SLF4J API will be delegated to the underlying logging framework.

Implementations of the SLF4J API satisfy most logging requirements. If you require specific logging functionality, you can create your own logger by implementing the CustomLogger interface. Then, pass the implementation to the SDK with the customLoggers parameter.

For more information, refer to Configuration.

Implement logging on Android

To implement logging on Android you need to add the following dependency to the project.

• SLF4J Android dependency

The logs will appear in Logcat.

Implement logging using log4j

To implement logging using log4j you need to add the following references to the project. Using log4j you can log to console or a file or both.

• log4j-slf4j2 file which acts as a bridge between slf4j and log4j.
• log4j-api file, which provides the underlying logging framework API.
• log4j-core file, which provides the underlying logging framework Implementation.

See this example:

Implement logging using slf4j-simple

To implement logging using slf4j-simple you need to add the following references to the project.

• SLF4J API dependency
• SLF4J-Simple dependency which provides the underlying logging framework

Along with these references you need to add the simplelogger.properties file in the CLASSPATH.

See this example:

Example usage of slf4j-simple

Implement logging using logback-classic

To implement logging using logback, you need to add the following references to the project.

• Logback classic and logback-core jar files which provide the underlying logging framework
• Logback core dependency which provides the underlying logging framework

See an sample logback.xml logback config file:

See this example:

Implement logging using java.util.logging

To implement logging using java.util.logging you need to add the following references to the project.

• SLF4J API dependency
• SLF4J-JDK14 dependency which acts as a bridge between slf4j and java

JVM runtime provides the underlying logging framework.

Implement logging using commons-logging

To implement logging using commons-logging you need to add the following references to the project.

• SLF4J API dependency
• SLF4J-JCL dependency which acts as a bridge between slf4j and common-logging
• commons-logging dependency which acts as an abstraction layer

The underlying logging framework is chosen dynamically by commons-logging.

No logging

To implement no logging you have two options:

• Add the SLF4J API dependency which is the SLF4J API and nothing else.

• Add the SLF4J API dependency and then add a reference to SLF4J-nop dependency.