Monitor your Flutter application | New Relic Documentation

Our New Relic Flutter agent monitors your Flutter mobile app and provides deep insights into your app's performance, errors, and user experience. Once you install and configure the Flutter agent, you'll be able to:

Capture Dart errors: Identify and fix problems quickly.
Track network requests: See how your app interacts with the backend.
Use distributed tracing: Drill down into handled exceptions and find the root cause.
Create custom events and metrics: Understand how your users interact with your app.

Summary view of a flutter app in New Relic

one.newrelic.com > All capabilities > Mobile > (select an app) > Summary: View Flutter data, track HTTP requests and errors, and monitor how your app is performing over time.

Install the Flutter agent

To install the Flutter agent, follow our guided install, located directly in the UI.

If you need to install the agent manually, follow these steps:

Step 1 of 5

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

Step 2 of 5

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

Step 3 of 5

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:

Go to one.newrelic.com, click Add data, then click Mobile.
Select your Flutter app.
Go to Settings > Application and copy the displayed Application token. You'll add this application token in the next step.

Step 4 of 5

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,
        );
    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.

Step 5 of 5

(Android-only) Configure your Android app

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

Add the following changes to your app's android/build.gradle file:

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

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

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

Add INTERNET and ACCESS_NETWORK_STATE permissions in your AndroidManifest.xml file:

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

And you're done! You should start seeing data in New Relic within 5 minutes.

Customize the agent instrumentation

Need to customize your agent instrumentation? Our public mobile SDK API methods let you collect custom data, configure default settings, and more.

The following customizations are available for the Flutter agent.

If you want to...	Use this method
Record breadcrumbs to track app activity that may be helpful for troubleshooting crashes.	Record breadcrumbs
Track a method as an interaction.	Start interactions Stop interactions
Record custom metrics.	Record custom metrics
Record errors.	Record errors
Record custom attributes and events.	There are several ways to report custom attributes and events: Record custom attributes Increment session attribute count Remove an attribute Remove all attributes Record custom events Set the maximum size of an event pool Set maximum time the agent stores events in memory Get a current session's ID Set a custom user ID to associate with events and attributes For more about which would be the best method to use and why, see Add custom data.
Track custom network requests and failures.	Track HTTP requests Track failing HTTP requests
Shut down the agent.	Shut down the agent.
Enable/disable default mobile monitoring settings.	Enable/disable monitoring features
Run a test crash report.	Test crash reporting

Troubleshoot HTTP errors

Missing HTTP data in the UI?

After installing the Flutter agent, wait at least 5 minutes. If no HTTP data appears on the HTTP errors and HTTP requests UI pages, make sure you are not overriding HttpOverrides.global inside your Flutter app.

Query Flutter log data

New Relic stores your Flutter logs as custom events. You can query these logs and build dashboards for them using this NRQL query:

SELECT * FROM `Mobile Dart Console Events` SINCE 30 MINUTES AGO

For more information on NRQL queries, see Introduction to NRQL.