Install the Android agent

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.

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

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

buildscript {
  repositories {
    mavenCentral()
  }

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

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
  }
}

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:

1. Create a newrelic.properties file in your app-level directory (ex: /projectname/app/newrelic.properties).

2. In this new file, add the following line, replacing GENERATED_TOKEN with your actual token:

   com.newrelic.application_token=GENERATED_TOKEN

   Copiar

3. 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).