Monitor your Flutter mobile app

Review the requirements

Before you install the Flutter agent, make sure your Flutter app meets these version requirements:

• Flutter 2.5.0 or higher
• Dart versions 2.16.2 or higher, up to but not including 3.0.0
• For Android-native apps:
  • Android API 24 or higher
  • See Android-native requirements
• For iOS-native apps:
  • See iOS-native requirements

Add the Flutter agent to your project

First, you'll need to add the Flutter agent into your dart project. In your pubspec.yaml, add the following to dependencies:

dependencies:
  newrelic_mobile: 0.0.1

Copy your application token

The application token is used for New Relic to authenticate your Flutter app's data. To view and copy your application token in the New Relic UI:

1. Go to one.newrelic.com, click Integrations & Agents, then click Mobile.

2. Select your Flutter app.

3. Go to Settings > Application and copy the displayed Application token.

   You'll add this application token in the next step.

Configure your Flutter project

In your Flutter project, open main.dart and add the following code:

import 'package:newrelic_mobile/newrelic_mobile.dart';

var appToken = "";
if (Platform.isAndroid) {
  appToken = "ANDROID_APP_TOKEN"; // Replace with your application token copied from the New Relic UI.
} else if (Platform.isIOS) {
  appToken ="IOS_APP_TOKEN"; // Replace with your application token copied from the New Relic UI.
}

Config config = Config(
  accessToken: appToken,
  //Android Specific
  // Optional: Enable or disable collection of event data.
  analyticsEventEnabled: true,
  // Optional: Enable or disable reporting successful HTTP requests to the MobileRequest event type.
  networkErrorRequestEnabled: true,
  // Optional: Enable or disable reporting network and HTTP request errors to the MobileRequestError event type.
  networkRequestEnabled: true,
  // Optional: Enable or disable crash reporting.
  crashReportingEnabled: true,
  // Optional: Enable or disable interaction tracing. Trace instrumentation still occurs, but no traces are harvested. This will disable default and custom interactions.
  interactionTracingEnabled: true,
  // Optional: Enable or disable capture of HTTP response bodies for HTTP error traces and MobileRequestError events.
  httpResponseBodyCaptureEnabled: true,
  // Optional: Enable or disable agent logging.
  loggingEnabled: true,
  // iOS specific
  // Optional: Enable or disable automatic instrumentation of WebViews
  webViewInstrumentation: true,
  //Optional: Enable or disable Print Statements as Analytics Events
  printStatementAsEventsEnabled : true,
  // Optional: Enable or disable automatic instrumentation of HTTP Request
  httpInstrumentationEnabled:true,
  // Optional: Enable or disable reporting data using different endpoints for US government clients
  fedRampEnabled: false,
  // Optional: Enable or disable offline data storage when no internet connection is available.
  offlineStorageEnabled: true,
  // iOS Specific
  // Optional: Enable or disable background reporting functionality.
  backgroundReportingEnabled: false,
  // iOS Specific
  // Optional: Enable or disable to use our new, more stable, event system for iOS agent.
  newEventSystemEnabled: false,
  // Optional: Enable or disable distributed tracing.
  distributedTracingEnabled: true,
);

NewrelicMobile.instance.start(config, () {
  runApp(MyApp());
});

class MyApp extends StatelessWidget {
  ...
}

Make sure you paste your application token(s) into appToken = "" in the code above. If you deployed your hybrid app to both iOS and Android platforms, you'll need to add two separate tokens: one for iOS and one for Android.

(Android-only) Configure your Android app

If you have an Android-native app, you'll need make the following changes:

1. Add the following changes to apply the Gradle plugin:

   If your project is using plugin DSL (Flutter 3.16 or higher), make the following changes:

   1. In android/settings.gradle:

      plugins {
          id "dev.flutter.flutter-plugin-loader" version "1.0.0"
          id "com.android.application" version "7.4.2" apply false
          id "org.jetbrains.kotlin.android" version "1.7.10" apply false
          id "com.newrelic.agent.android" version "7.5.1" apply false // <-- include this
      }

      Copy

   2. In android/app/build.gradle:

      plugins {
          id "com.android.application"
          id "kotlin-android"
          id "dev.flutter.flutter-gradle-plugin"
          id "com.newrelic.agent.android"  //<-- include this
      }

      Copy

• Or, if your project is older, you can use the legacy newrelic plugin ID by adding this snippet:

  buildscript {
    ...
    repositories {
      ...
      mavenCentral()
    }
    dependencies {
      ...
      classpath "com.newrelic.agent.android:agent-gradle-plugin:7.5.1"
    }
  }

  Copy

  Apply the NewRelic plugin to the top of the android/app/build.gradle file:

  apply plugin: "com.android.application"
  apply plugin: 'newrelic' // <-- include this

  Copy
  2. 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" />

  Copy