Follow these steps to get your EUM App Key and instrument your React Native application.


  • React Native >= 0.60 and <= 0.70.6

  • (iOS only): Pod and Xcode deployment targets must be >= 11. Find the pod target version in the Podfile in <your_react_native_app>/ios/.

Get Your Application Key

From the Controller's Getting Started Wizard, create either an iOS or an Android application. You will be given a EUM App Key that you will use to instrument your application. 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.

Eject Your React Native Application

 If you created your React Native application with one of the commands in the following table, you must eject the application:

CommandWhy Ejection Is Needed


This command lets you quickly set up and run a Native React application with no configuration. However, it does not provide the whole development environment required by the React Native Agent.

expo init

Currently, the React Native Agent module does not support Expo projects.

If you created your app with create-react-native-app, use npm to eject the app. If you used expo, run the expo command below to eject the app.

From your project directory, run the command appropriate for your use case:

 npm run eject
expo eject

Install the React Native Agent

This module injects the native AppDynamics agents into your application and offers a JavaScript bridge to the Instrumentation management interface.

  1. Install the React Native Agent using any of the following commands:

    npm install --save @appdynamics/react-native-agent
    yarn add @appdynamics/react-native-agent

  2. Build the configuration to enable the build-time instrumentation of your application:

    node node_modules/@appdynamics/react-native-agent/bin/cli.js install

    The React Native Agent CLI assumes you've kept the default project structure created with the react-native CLI tools.

If the above commands failed, see manually install the React Native package. Otherwise, proceed to Add Permissions (Android Only).

Manually Install the React Native Package (Optional)

Most users do not have to manually install the package, but the command above may fail if you heavily modified your iOS and Android projects.

Follow these steps to manually install the React Native package:

  1. Add the following line to your android/build.gradle:

    apply from: '../node_modules/@appdynamics/react-native-agent/android/adeum.gradle'
  2. Make sure the file settings.gradle contains a reference to the Appdynamics agent module as shown below.

    include ':@appdynamics_react-native-agent'
    project(':@appdynamics_react-native-agent').projectDir = new File(rootProject.projectDir, '../node_modules/@appdynamics/react-native-agent/android')
  3. Also, android/app/build.gradle should contain a reference to the Appdynamics agent module.

    dependencies {
        implementation project(':@appdynamics_react-native-agent')
        // ...

For iOS, confirm that the following file exist:

FileFile LocationExample

node_modules directory


Make sure to add libsqlite3 to your project as explained in Add Required Libraries (iOS Only).

Add Permissions (Android Only)

Add the following permissions to your app's AndroidManifest.xml (which should be located under android/app/src/main/).

  <manifest xmlns:android=""

    // Add the following:
    <uses-permission android:name="android.permission.ACCESS_NETWORK_STATE"/>
    // ...

The React Native Agent tries to minimize its network footprint. Without this permission, the agent always assumes poor network conditions and some metrics may not get reported.

Instrument Your Application Code

In the index.js file of your React application:

  1. At the top of the file near the other import statements, add the following line of code to import the agent:

     import {Instrumentation} from '@appdynamics/react-native-agent';

    1. n the same file and in the global scope, initialize the instrumentation with the following, making sure to replace <EUM_APP_KEY> with a string containing your EUM App Key.

          appKey: <EUM_APP_KEY>,

      Whenever possible, we recommend you call  Instrumentation.start in a context that permits awaiting for this async call and even enabling verbose logging for better debugging:

      async function startInstrumentation() {
        await Instrumentation.start({
          appKey: <EUM_APP_KEY>,
          loggingLevel: LoggingLevel.VERBOSE
  2. Verify that your index.js file looks similar to the following:

    import App from './src/App';
    import {AppRegistry} from 'react-native';
    import {name as appName} from './app.json';
    import {Instrumentation} from '@appdynamics/react-native-agent';  
        appKey: 'YOUR-APP-KEY',
    AppRegistry.registerComponent(appName, () => App);
  3. (For older React Native setup builds) If you have use_frameworks! defined in your ios/Podfile, we recommend adding the following:

    $ toggleADEUMRNStaticFramework = true

Build and Run Your React Native Applications (Optional)

  1. Run the command to build and run the app for your platform.

     react-native run-android
    react-native run-ios 
  2. Verify the implementation in the Controller UI. See Confirm the Mobile Agent Connection to the Controller.

Point to an On-Premises EUM Server (Optional)

To use an on-premises EUM Server, pass the URL to the on-premises EUM Server when you initialize the instrumentation with the EUM App Key from Get Your Application Key.

     appKey: <EUM_APP_KEY>,
     collectorURL: <COLLECTOR_URL>