Logging APIs in Kotlin SDK

This guide walks you through the logging APIs available in the Kotlin SDK.

Overview

The Kotlin SDK provides a flexible and configurable logging mechanism that helps you:

• Monitor and debug the SDK’s behavior.
• Get fine-grained control over the amount of information to be recorded by leveraging multiple log levels.
• Set up and use a custom logging mechanism and log your own messages by leveraging the SDK’s logging APIs.

Set the log level

You can define the log level using LoggerAnalytics by passing the value for the logLevel parameter. It controls the verbosity of the logs printed by the SDK and helps filter out logs based on their importance.

The Kotlin SDK supports the following log levels:

The following snippet shows you how to set a VERBOSE log level:

LoggerAnalytics.logLevel = Logger.LogLevel.VERBOSE

LoggerAnalytics.INSTANCE.setLogLevel(Logger.LogLevel.VERBOSE);

Set custom logs

The Kotlin SDK provides a LoggerAnalytics instance that you can use to set custom logs for the SDK. It is helpful when the SDK logs need to be printed in a custom plugin.

The SDK provides the following methods for printing different levels of log messages:

// Verbose log message
LoggerAnalytics.verbose("This is a verbose log message providing detailed internal information.")

// Debug log message
LoggerAnalytics.debug("Debugging info: API request started.")

// Info log message
LoggerAnalytics.info("SDK initialized successfully.")

// Warn log message
LoggerAnalytics.warn("Low memory warning detected.")

// Error log message
LoggerAnalytics.error("Failed to fetch user data: Network error.")  

// Verbose log message
LoggerAnalytics.INSTANCE.verbose("This is a verbose log message providing detailed internal information.")

// Debug log message
LoggerAnalytics.INSTANCE.verbose("Debugging info: API request started.")

// Info log message
LoggerAnalytics.INSTANCE.verbose("SDK initialized successfully.")

// Warn log message
LoggerAnalytics.INSTANCE.verbose("Low memory warning detected.")

// Error log message
LoggerAnalytics.INSTANCE.verbose("Failed to fetch user data: Network error.") 

Use a custom logger

You can create and use a custom logger that is used by the SDK to log messages—this is helpful in cases where you don’t want to rely on the SDK’s default logger.

For the Kotlin SDK, you can inherit the Logger interface to create a custom Logger class and then pass its instance to the setLogger API.

For example, follow these steps to use the Timber library for logging:

1. Create a custom logger class:

class MyCustomLogger : Logger {
    private val tag = "MyCustomTag"

    override fun verbose(log: String) {
        Timber.tag(tag).v(log)
    }

    override fun debug(log: String) {
        Timber.tag(tag).d(log)
    }

    override fun info(log: String) {
        Timber.tag(tag).i(log)
    }

    override fun warn(log: String) {
        Timber.tag(tag).w(log)
    }

    override fun error(log: String, throwable: Throwable?) {
        Timber.tag(tag).e(throwable, log)
    }
}

import androidx.annotation.NonNull;
import com.rudderstack.sdk.kotlin.core.internals.logger.Logger;
public class JavaCustomLogger implements Logger {
    private final String TAG = "MyCustomTag";
    @Override
    public void verbose(@NonNull String log) {
        System.out.println(TAG + ": Verbose: " + log);
    }
    @Override
    public void debug(@NonNull String log) {
        System.out.println(TAG + ": Debug: " + log);
    }
    @Override
    public void info(@NonNull String log) {
        System.out.println(TAG + ": Info: " + log);
    }
    @Override
    public void warn(@NonNull String log) {
        System.out.println(TAG + ": Warn: " + log);
    }
    @Override
    public void error(@NonNull String log, Throwable throwable) {
        System.out.println(TAG + ": Error: " + log);
    }
}

2. Add the custom logger class to LoggerAnalytics, as shown:

LoggerAnalytics.setLogger(MyCustomLogger())

LoggerAnalytics.INSTANCE.setLogger(new JavaCustomLogger());

Questions? Contact us by email or on Slack