Skip to main content

Adding the Android Embrace SDK

tip

For a sample integration, check out the Kotlin and Java apps in the Embrace demo apps repo.

Add Embrace as a dependency

This is how you add embrace plugin to your project.

Depending on how you configured your project, add the following to your settings.gradle:

pluginManagement {
repositories {
mavenCentral()
}

plugins {
id 'io.embrace.swazzler' version "${swazzler_version}" apply false
}
}

Where swazzler_version is defined in gradle.properties for better organization.

swazzler_version=6.6.0

We are loading the plugin, but not applying it yet.

Then, on the app/build.gradle add the following:

plugins {
id 'io.embrace.swazzler'
}

Legacy approach

With the introduction of Pluigns DSL users should have little reason to use the legacy method of applying plugins. If you’re still using legacy code for applying plugins, this is how you should add embrace plugin.

The Embrace SDK is available on Maven Central. Make the following changes in your project's build.gradle file to add the Embrace SDK to your app.

buildscript {
repositories {
mavenCentral()
google()
}
dependencies {
classpath 'io.embrace:embrace-swazzler:6.6.0'
}
}

Then, apply the Embrace swazzler plugin in your app/build.gradle file. Also, specify that the Embrace SDK uses Java 8 features with the compileOptions settings.

apply plugin: 'com.android.application'
apply plugin: 'embrace-swazzler'

repositories {
mavenCentral()
google()
}

android {
...
compileOptions {
sourceCompatibility JavaVersion.VERSION_1_8
targetCompatibility JavaVersion.VERSION_1_8
}
...
}

The Swazzler works as a support process during build time for the Embrace SDK to work properly during run time. It performs a few key functions:

  • Adds the Embrace SDK dependencies to the app's dependency list.
  • Injects a build info JSON file for the SDK to parse during run time. This specifies an internal Embrace build UUID, build app ID, and the build variant.
  • Runs a code transformation / injection over specified bytecode class files to add hooks that the SDK uses to capture certain data.
  • Injects ProGuard rules for the SDK to work properly when a build type is set to be minified.
Note on Permissions

You'll need to set the following permissions so the Embrace SDK can send events and monitor connectivity.

  • android.permission.INTERNET
  • android.permission.ACCESS_NETWORK_STATE

Add a dependency to modules or libraries you want to call Embrace from (optional)

If you have an app that uses internal modules or libraries, you must specify the Embrace SDK dependency directly in your module's Gradle file

implementation 'io.embrace:embrace-android-sdk:6.6.0'

You still need to apply the Swazzler plugin in the app's Gradle file (apply plugin: 'embrace-swazzler') and verify that the Swazzler version set in your project Gradle file is the same as the version set for the SDK in the module’s Gradle file.

Add the config file

Add a config file to configure the Embrace SDK. This file must be named embrace-config.json and should be placed in app/src/main. The config file supports many more options than those shown in the example below, but for the initial integration, only the two settings listed below are needed.

{
"app_id": "xxxxx",
"api_token": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
}
info

Your app ID and API token are available on the Embrace dashboard.


NDK crash capture

info

If your app is written entirely in Java and Kotlin, you do not need to enable NDK crash capture to capture crashes in your code.

If your app has native components, you can enable NDK crash capture. Simply add the ndk_enabled setting to your config file.

{
"app_id": "xxxxx",
"api_token": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
"ndk_enabled": true
}

Next, you'll be creating your first session.