Skip to main content

SDK setup for SDK libraries

This guide shows the steps to set up the Kotzilla SDK in your Android SDK library.

Before starting, your application must be registered on the Kotzilla Platform:

Once your app is registered and the type is selected, follow the steps below to integrate the SDK, capture analytics, and start debugging and monitoring your app.

Step 1 - Setup Kotzilla SDK (SDK Library for Android)​

1.1 Kotzilla project configuration file​

Download the kotzilla.json configuration file for your library module and place it in the following directory:

Module (app module) Gradle file: <project>/<app-module>

This file contains your API key, version, and SDK configuration for shared code.

1.2 Set up the SDK​

The instructions below use Version Catalog configuration by default.

If your project uses the traditional Gradle setup, please check the documentation here for specific instructions.

note

Kotzilla SDK is available on both Maven Central and the Kotzilla public repository. More information on how to configure access to the Kotzilla repository is available here

Add the following lines to your libs.versions.toml file:

[versions]
kotzilla = "1.2.2" // Check the latest version available below

[libraries]
kotzilla-sdk = { group = "io.kotzilla", name = "kotzilla-sdk", version.ref = "kotzilla" }
# If needed for Ktor 3:
# kotzilla-sdk-ktor3 = { group = "io.kotzilla", name = "kotzilla-sdk-ktor3", version.ref = "kotzilla" }

[plugins]
kotzilla = { id = "io.kotzilla.kotzilla-plugin", version.ref = "kotzilla" }
info

The latest version of the kotzilla-sdk is: Maven Central

Set up the Kotzilla Plugin in your project root-level Gradle file (<project>/build.gradle.kts):

plugins {
    alias(libs.plugins.kotzilla) apply false
}

In your app module Gradle file (<project>/<app-module>/build.gradle.kts), add:

plugins {
    alias(libs.plugins.kotzilla)
}

dependencies {
    implementation(libs.kotzilla.sdk)
    // If using Ktor 3:
    // implementation(libs.kotzilla.sdk.ktor3)
}
note
  • implementation(libs.kotzilla.sdk) is the core Kotzilla SDK, required for analytics and other features.
  • If your project uses Ktor 3, uncomment the second line to include the Ktor 3 compatible SDK.

1.3 Sync Gradle​

Sync your project in Android Studio or IntelliJ IDEA to apply the changes.

Step 2 - SDK Library for Android​

Initialize the Kotzilla SDK in your library Koin configuration and attach the instance to your modules:

// Add kotzilla analytics
val instance = KotzillaCoreSDK()
    .setup(context.apiKey(), context.getVersion())
    .connect()

startKoin {
    analyticsLogger(sdkInstance = instance)
    modules(...)
}

Step 3 - Go To Dashboard​

Now that the SDK is configured, you can build and run your app to start capturing data from a first user session.

Once you've stopped the app:

  • Click Check your data to confirm everything is being collected correctly.
  • Then click Go to Dashboard to view your app’s performance and configuration insights.