Install the Android agent

To install the Android agent, we recommend you follow our guided install:

Go to one.newrelic.com > Integrations & Agents > Mobile > Android.
Follow the guided install steps to set up your Android agent.
Wait a few minutes, then view your data by going to one.newrelic.com > All capabilities > Mobile > (select your app).

Manually install the Android agent

The steps below are outlined in our guided install. Note that even if you manually install the agent, you'll still need to create a New Relic app and obtain the generated application token. This token is essential for the agent to send data to New Relic.

Add the Android agent plugin to your project.

Regarding the location of the plugin, you have two options:

Recommended: Using the Gradle plugin DSL
- Starting with agent version 7.6.0, the Android agent plugin is available on the Gradle Plugin Portal as a community plugin. The Gradle plugin DSL simpifies adding plugin dependencies to apps.
- This method involves adding the agent plugin dependency to your project's plugins DSL block.
Legacy Plugin ID (newrelic)
- For older projects or specific use cases, you can use the legacy plugin ID.
- This method involves adding the agent as a dependency to your project's build script, specifying the MavenCentral repository.

Follow the detailed steps below for your chosen installation method.

The recommended approach for managing plugin dependencies in Gradle utilizes the plugins DSL block. This section details applying the fully qualified form of the plugin ID (com.newrelic.agent.android) within this structure.

Declare the New Relic plugin to the top-level build.gradle(.kts) file using the Gradle Plugin Portal plugin ID:

plugins {
  // for binary Gradle plugins that need to be resolved
  id("com.newrelic.agent.android") version "AGENT_VERSION" apply false
}

Make sure to replace AGENT_VERSION with your agent version number. We strongly recommend you use the latest version.

Apply the plugin explicitly to the app-level build file (and any sub-modules intended for instrumentation) using the following syntax:

plugins {
  id("com.newrelic.agent.android")
}

For detailed information on applying plugins within Gradle, refer to the Gradle documentation.

The Android agent plugin is available on MavenCentral and uses the legacy plugin ID newrelic for compatibility with older projects. If you choose to leverage this legacy ID for an existing app, you'll need to explicitly configure the classpath to MavenCentral. This ensures Gradle can locate the plugin during your build process. For further details on various methods for resolving plugins, refer to the Gradle documentation.

To prefer MavenCentral over the Gradle Plugin Portal, you need to make the following changes to Gradle files:

Add this snippet to your top-level build.gradle(.kts) file:

buildscript {
  repositories {
    mavenCentral()
  }

  // not required if plugin classpath in resolutionStrategy{} below
  dependencies {
    classpath "com.newrelic.agent.android:agent-gradle-plugin:AGENT_VERSION"
  }
}

Add this snippet to your settings.gradle(.kts) file through the pluginManagement {} block:

pluginManagement {
  repositories {
    mavenCentral()  // adds repo for NewRelic artifacts
  }
  resolutionStrategy {
    eachPlugin {
      // not required if using `classpath dependency` above
      if (requested.id.id.startsWith("newrelic") || requested.id.id.startsWith("com.newrelic.agent.android"))) {
        useModule("com.newrelic.agent.android:agent-gradle-plugin:${AGENT_VERSION}")
      }
    }
  }
  plugins {
     id("newrelic") apply false
  }
}

Make sure to replace AGENT_VERSION with your agent version number. We strongly recommend you use the latest version.

Apply the plugin to the app-level build file, as well as any other sub-module to be instrumented:

plugins {
  id("newrelic")
}

In your AndroidManifest.xml file, add the following permissions:

<uses-permission android:name="android.permission.INTERNET" />
<uses-permission android:name="android.permission.ACCESS_NETWORK_STATE" />

In your main Activity class within the onCreate method, add this import statement:

import com.newrelic.agent.android.NewRelic;

Note: You must add this import statement to the Activity class. We don’t support starting the agent in other classes.

In the onCreate method, add the following line, making sure to replace GENERATED_TOKEN with your actual app token (created during the guided install):

NewRelic.withApplicationToken("GENERATED_TOKEN").start(this.getApplicationContext());

(Optional) Additional configurations for Proguard/Dexguard

If you use ProGuard or Dexguard for code shrinking, follow these steps:

Create a newrelic.properties file in your app-level directory (ex: /projectname/app/newrelic.properties).
In this new file, add the following line, replacing GENERATED_TOKEN with your actual token:
```
com.newrelic.application_token=GENERATED_TOKEN
```
Follow the steps decribed on Configure ProGuard or DexGuard for Android apps.

Clean your project, then run your app in an emulator or device to generate traffic. Wait a few minutes as your agent captures that data.

View your app's data on New Relic by going to one.newrelic.com > All capabilities > Mobile > (select an app).

What's next?

Congratulations! You've successfully installed the Android agent. You have a few options for next steps:

Configure agent behavior during Gradle builds with the New Relic Gradle plugin.
Upgrade the Android agent SDK to keep your Android agent up to date.
Having problems with your Android installation? Follow the troubleshooting procedures.

Android 4.x: Multidex support

Mobile monitoring for Android versions older than Android 5.0 (API level 21) use the Dalvik runtime to execute app code. By default, Dalvik limits apps to a single classes.dex bytecode file per APK. To get around this limitation, you must enable multidex support. Then you can use the multidex support library, which becomes part of the primary DEX file of your app. The library manages access to the additional DEX files and their containing code.

When building each DEX file for a multidex app, the build tools perform complex decision making to determine which classes are needed in the primary DEX file so that your app can start successfully. If, during start up, the required classes aren't available in the primary DEX file, your app will crash with the error java.lang.NoClassDefFoundError.

If you see the java.lang.NoClassDefFoundError error, then you must manually specify these additional classes as required in the primary DEX file:

Create a proguard.multidex.config file within the /app folder of your project. Update mypackage to reflect your package name.

####################
# keep class names #
####################

#Keep New Relic in the main dex
-keep class com.newrelic.** { *; }
-keep class com.mypackage.activities.** { *; }

Merge the following code into the app-level build.gradle file:
```
android {
  defaultConfig{
    …
    multiDexKeepProguard file("proguard.multidex.config")
  }
}
```
For more information, see the Android Developers documentation on declaring classes required in the primary DEX file.

Manually install the Android agent

(Recommended) Apply the plugin using the plugins DSL block

Apply the plugin using the buildscript{} block

What's next?

Android 4.x: Multidex support

Troubleshoot the java.lang.NoClassDefFoundError error

Install the Android agent

Manually install the Android agent .css-21sua1{background:none;border:none;width:0;padding:0;}

Apply the plugin using the buildscript{} block

What's next?

Android 4.x: Multidex support

Troubleshoot the java.lang.NoClassDefFoundError error

Manually install the Android agent