Instrument an Android Application Manually

To instrument Android Applications, you need to first build the application for the platform you are using and then add the instrumentation code.  

To get started, follow the instructions below:

1. Build the Android Application
2. Instrument the Android Application 

Build the Android Application

To build your application, follow the instructions for your platform:

• Gradle/Android Studio
• Maven
• Ant

If you are fetching the AppDynamics Android SDK from the AppDynamics Download page, see Download Manually.

Gradle/Android Studio

Complete the following steps to configure the build for your Android application:

1. Confirm the compatibility of your Gradle, Android Tools with the AppDynamics plugin versions.
2. Install the Android Agent.
3. Activate the plugin.

Install the Android Agent

Use the native package system to install the Android Agent. In the app module build.gradle, add the class path of the AppDynamics Gradle Plugin to the build path dependencies clause. Use com.appdynamics:appdynamics-gradle-plugin:4.5.+ unless you need to use another version of the AppDynamics plugin for compatibility between your Gradle and Android Tools. 

buildscript {
    repositories {
        jcenter()
    }
    dependencies {
        classpath 'com.android.tools.build:gradle:1.1.0'
        classpath 'com.appdynamics:appdynamics-gradle-plugin:4.5.+' // this line added for AppDynamics
    }
}
allprojects {
    repositories {
        jcenter()
    }
}

Activate the Plugin

In your module-level build.gradle, add the adeum plugin immediately after the com.android.application plugin, so that it looks similar to the example below:

apply plugin: 'com.android.application'
apply plugin: 'adeum' // this line added for AppDynamics

If your application is a Maven Project:

1. Add the following code to the <dependencies> section:

   <dependency>
      <groupId>com.appdynamics</groupId>
      <artifactId>appdynamics-runtime</artifactId>
      <version>1.0</version>
   </dependency>

   TEXT

2. Add the following code to the <plugins> section:

   <plugin>
       <groupId>com.appdynamics</groupId>
       <artifactId>appdynamics-maven-plugin</artifactId>
       <version>1.0</version>
       <executions>
           <execution>
               <phase>compile</phase>
               <goals>
                   <goal>adinject</goal>
               </goals>
           </execution>
       </executions>
   </plugin>

   TEXT

Instrument the Android Application

After you have completed building your application, follow the steps below:

1. Get the Application Key
2. Add the Required Permissions
3. Modify the Source
4. Run the Build

Get Application Key

After you completed the Getting Started Wizard, you were given an EUM App Key. You will need this key when you modify the source code. In some cases, multiple mobile applications can share the same key.

If you have completed the Getting Started Wizard, but don't have your EUM App Key, see Get Your Application Key.

Add the Required Permissions

Open your application's AndroidManifest.xml file and verify that it has these permissions:

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

If both of these permissions are not present, add them.

Modify the Source

1. In the source file that defines your application's primary Activity, add the following import:

   import com.appdynamics.eumagent.runtime.Instrumentation;

   JAVA

2. In your primary Activity's onCreate() method, add the following lines, passing in the EUM App Key from step 2 above: 

   Instrumentation.start(<EUM_APP_KEY>, getApplicationContext());

   JAVA

3. Save the file. 
   Your code should look something like this.

   import com.appdynamics.eumagent.runtime.Instrumentation;
   ...
   @Override public void onCreate(Bundle savedInstanceState) {
     Instrumentation.start(<EUM_APP_KEY>, getApplicationContext());
     ...
   }

   JAVA

4. Configure the Android Agent to report metrics and screenshots to the SaaS EUM Server and Screenshot Service in your region when initializing the agent with the methods withCollectorURL and withScreenshotURL. (If you are using an on-premises EUM Server, see Customize the Agent Configuration for implementation details.)

   import com.appdynamics.eumagent.runtime.Instrumentation;
   ...
   @Override public void onCreate(Bundle savedInstanceState) {
     Instrumentation.start(AgentConfiguration.builder()
       .withAppKey("<EUM_APP_KEY>")
       .withContext(getApplicationContext())
       // The default SaaS EUM Server and Screenshot Service are in the Americas, 
       // so you can omit the following settings if you are in the Americas.
       .withCollectorURL("https://col.eum-appdynamics.com")
       .withScreenshotURL("https://image.eum-appdynamics.com/")
       .build());
     ...
   }

   JAVA

   import com.appdynamics.eumagent.runtime.Instrumentation;
   ...
   @Override public void onCreate(Bundle savedInstanceState) {
     Instrumentation.start(AgentConfiguration.builder()
       .withAppKey("<EUM_APP_KEY>")
       .withContext(getApplicationContext())
       // Configure the iOS Agent to report the metrics and screenshots to 
       // the SaaS EUM Server in EMEA.
       .withCollectorURL("https://fra-col.eum-appdynamics.com")
       .withScreenshotURL("https://fra-image.eum-appdynamics.com/")
       .build());
     ...
   }

   JAVA

   import com.appdynamics.eumagent.runtime.Instrumentation;
   ...
   @Override public void onCreate(Bundle savedInstanceState) {
     Instrumentation.start(AgentConfiguration.builder()
       .withAppKey("<EUM_APP_KEY>")
       .withContext(getApplicationContext())
       // Configure the iOS Agent to report the metrics and screenshots to 
       // the SaaS EUM Server in APAC.
       .withCollectorURL("https://syd-col.eum-appdynamics.com")
       .withScreenshotURL("https://syd-image.eum-appdynamics.com/")
       .build());
     ...
   }

   JAVA
   
   

Verify the Instrumentation

See Verify the Android Instrumentation for build and verification instructions.

Upgrade the Android Mobile Agent

As new features are added to the agent, you will need to upgrade the Android SDK in your app.

To upgrade, you simply update the build file for your platform: 

• Gradle/Android Studio

• Maven

The process of installing and updating the latest Android SDK is the same.