Skip to main content
Version: 1.0.2

Integrate Appxiom SDK as a Gradle Library in Android

Integrating Appxiom SDK into your Android project using Gradle enables real-time monitoring, crash reporting, and advanced analytics for your mobile applications. This guide provides clear, step-by-step instructions for both Groovy and Kotlin DSL, ensuring compatibility with all modern Android build systems and maximizing your app’s reliability and performance.

Step 1: Add Appxiom Maven Repository to Project-level settings.gradle​

To start Appxiom SDK integration, add the Appxiom Maven repository to your settings.gradle or settings.gradle.kts file:

dependencyResolutionManagement {
    repositoriesMode.set(RepositoriesMode.FAIL_ON_PROJECT_REPOS)
    repositories {
        google()
        mavenCentral()
        maven {
            url "https://appxiom-android.s3.us-west-1.amazonaws.com"
        }
    }
}

Step 2: Add Appxiom SDK Dependencies to App-level build.gradle​

Add the following dependencies to your app-level build.gradle or build.gradle.kts file inside the dependencies block:

releaseImplementation('tech.appxiom:appxiomcore:x.x.x@aar') {
    transitive = true;
}

debugImplementation('tech.appxiom:appxiomdebug:x.x.x@aar') {
    transitive = true;
}

Alternative: Using Version Catalogs (libs.versions.toml)​

For modern Gradle projects using version catalogs, you can define Appxiom SDK dependencies in your gradle/libs.versions.toml file:

[versions]
appxiom = "x.x.x"

[libraries]
appxiom-core = { group = "tech.appxiom", name = "appxiomcore", version.ref = "appxiom" }
appxiom-debug = { group = "tech.appxiom", name = "appxiomdebug", version.ref = "appxiom" }
releaseImplementation(libs.appxiom.core) {
    transitive = true
}

debugImplementation(libs.appxiom.debug) {
    transitive = true
}

Benefits of Version Catalogs:

  • Centralized version management across modules
  • Type-safe dependency references
  • Better IDE support and autocomplete
  • Easier dependency updates

Why Use Appxiom SDK?​

  • Real-time monitoring of bugs and its analytics for Android apps
  • Automatic detection of memory leaks, crashes, and performance issues
  • Easy integration with both Groovy and Kotlin DSL
  • Supports both debug and release build types
  • Seamless compatibility with modern Android build systems
  • Enhanced reliability and performance for your mobile applications

Frequently Asked Questions (FAQs)​

Q: Which Gradle files do I need to update to add Appxiom SDK?
A. Update your project-level settings.gradle (or settings.gradle.kts) and your app-level build.gradle (or build.gradle.kts).

Q: What is the Appxiom Maven repository URL?
A. The repository URL is https://appxiom-android.s3.us-west-1.amazonaws.com/.

Q: What is the difference between AppxiomCore and AppxiomDebug?
A. AppxiomCore is for release builds and provides core monitoring features. AppxiomDebug is for debug builds and includes additional features such as automatic object-level memory leak detection.

Q: How do I find the latest version of Appxiom SDK?
A. Refer the release notes for the latest version number.

Q: My build fails after adding Appxiom dependencies. What should I check?
A. Ensure the Maven repository is correctly added to your project-level settings file and that you are using the correct dependency coordinates and version.

Q: Can I use Appxiom SDK with Gradle version catalogs (libs.versions.toml)?
A. Yes, Appxiom SDK fully supports Gradle version catalogs. Define the SDK versions in your gradle/libs.versions.toml file and reference them using libs.appxiom.core and libs.appxiom.debug in your build files.

Q: Can I use Appxiom SDK in both Groovy and Kotlin DSL projects?
A. Yes, Appxiom SDK supports both Groovy and Kotlin DSL for Gradle configuration.

Q: Do I need to configure ProGuard or R8 rules for Appxiom?
A. Check the official documentation for any required ProGuard or R8 rules, especially if you are using code shrinking or obfuscation.