newrelic_mobile

New Relic Flutter Agent

This agent allows you to instrument Flutter apps with help of native New Relic Android and iOS agents. The New Relic SDKs collect crashes, network traffic, and other information for hybrid apps using native components.

Features

• Capture Dart errors
• Network Request tracking
• Distributed Tracing
• Future errors tracking
• Capture interactions and the sequence in which they were created
• Pass user information to New Relic to track user sessions
• Screen tracking via NavigationObserver
• Capture print and debug print statement as Logs
• Capture Offline Events and Exception
• Capture Background Reporting Events

Current Support:

• Android API 24+

• iOS:

  Agent Version	Minimum iOS Version
  < 1.1.17	iOS 10+
  1.1.17 – 1.1.21	iOS 16+
  >= 1.2.0	iOS 15+

• Depends on New Relic iOS/XCFramework and Android agents

• Flutter Web: Compiles without errors (monitoring is no-op, use New Relic Browser Agent for web monitoring)

Requirements

• Flutter ">= 2.5.0"
• Dart ">=2.16.2 <4.0.0"
• IOS native requirements
• Android native requirements

Web Platform Support

As of version 1.1.20, this package supports compilation for Flutter Web (including WASM). However, monitoring functionality is only available on native mobile platforms (iOS/Android).

• On mobile platforms: Full New Relic Mobile SDK functionality
• On web platforms: All methods are no-ops (compile without errors, but don't collect data)

For web application monitoring, use the New Relic Browser Agent instead.

See WEB_SUPPORT.md for more details.

Installation

Install NewRelic plugin into your dart project by adding it to dependecies in your pubspec.yaml

dependencies:
  newrelic_mobile: 1.1.20
  

Flutter Setup

1. Now open your main.dart and add the following code to launch NewRelic (don't forget to put proper application tokens):

import 'package:newrelic_mobile/newrelic_mobile.dart';


  var appToken = "";

  if (Platform.isAndroid) {
    appToken = "<android app token>";
  } else if (Platform.isIOS) {
    appToken = "<ios app token>";
  }

  Config config =
      Config(accessToken: appToken,

      //Android Specific
      // Optional:Enable or disable collection of event data.
      analyticsEventEnabled: true,

      // Optional:Enable or disable reporting network and HTTP request errors to the MobileRequestError event type.
      networkErrorRequestEnabled: true,

      // Optional:Enable or disable reporting successful HTTP requests to the MobileRequest 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/Disable automatic instrumentation of WebViews
      webViewInstrumentation: true,
      
      //Optional: Enable or Disable Print Statements as Analytics Events
      printStatementAsEventsEnabled : true,

       // Optional:Enable/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,

        // Optional: Log Level for Agent Logs.
         logLevel: LogLevel.DEBUG,
);

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

  class MyApp extends StatelessWidget {
  ....

2. Alternatively, you can manually set up error tracking and resource tracking. Because NewRelic Mobile Start calls WidgetsFlutterBinding.ensureInitialized, if you are not using NewRelic Mobile Start, you need to call this method prior to calling NewrelicMobile.instance.startAgent.

if (Platform.isAndroid) {
  appToken = AppConfig.androidToken;
} else if (Platform.isIOS) {
  appToken = AppConfig.iOSToken;
}

Config config = Config(
    accessToken: appToken,
    analyticsEventEnabled: true,
    networkErrorRequestEnabled: true,
    networkRequestEnabled: true,
    crashReportingEnabled: true,
    interactionTracingEnabled: true,
    httpResponseBodyCaptureEnabled: true,
    loggingEnabled: true,
    webViewInstrumentation: true,
    printStatementAsEventsEnabled: true,
    httpInstrumentationEnabled:true,distributedTracingEnabled: true);



runZonedGuarded(() async {
WidgetsFlutterBinding.ensureInitialized();
FlutterError.onError = NewrelicMobile.onError;
await NewrelicMobile.instance.startAgent(config);
runApp(MyApp());
}, (Object error, StackTrace stackTrace) {
NewrelicMobile.instance.recordError(error, stackTrace);
});

AppToken is platform-specific. You need to generate the seprate token for Android and iOS apps.

Screen Tracking Events

In order to track navigation events you have to add the NewRelicNavigationObserver to your MaterialApp, WidgetsApp or CupertinoApp.

You should provide a name to route settings: RouteSettings(name: 'Your Route Name'). The root route name / will be replaced by root "/" for clarity's sake.

import 'package:newrelic_mobile/newrelic_navigation_observer.dart';

//....

MaterialApp(
  navigatorObservers: [
    NewRelicNavigationObserver(),
  ],
  // other parameters
)

GoRouter Instrumentation

When using the go_router[https://pub.dev/packages/go_router] library, the automatic routing instrumentation can be enabled by adding an instance of NewRelicNavigationObserver to your application's GoRouter.observers:

//....

import 'package:go_router/go_router.dart';
import 'package:newrelic_mobile/newrelic_navigation_observer.dart';


final router = GoRouter(
  routes: ...,
    observers: [NewRelicNavigationObserver()],
);

Android Setup

1. Add the following changes to Apply Gradle Plugin:

If you are using Plugins DSL (Flutter 3.16 or Later) to Apply the NewRelic Gradle Plugin, make the following changes:

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.8.2" apply false // <-- include this
}

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
}

Or, if you are using the traditional way to apply the plugin:

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

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

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

Usage

See the examples below, and for more detail, see New Relic IOS SDK doc or Android SDK .

startInteraction(String actionName) Future;

Track a method as an interaction.

InteractionId is string.

endInteraction(String interactionId): void;

End an interaction (Required). This uses the string ID for the interaction you want to end. This string is returned when you use startInteraction().

          var id = await NewrelicMobile.instance.startInteraction("Getting Data from Service");
              try {
                var dio = Dio();
                var response = await dio.get(
                    'https://reqres.in/api/users?delay=15');
                   print(response);
                  NewrelicMobile.instance.endInteraction(id);
                  Timeline.finishSync();
              } catch (e) {
                print(e);
              }

[setAttribute] (https://docs.newrelic.com/docs/mobile-monitoring/new-relic-mobile-ios/ios-sdk-api)(String name, dynamic value) : void;

Creates a session-level attribute shared by multiple mobile event types. Overwrites its previous value and type each time it is called.

    NewrelicMobile.instance.setAttribute('RNCustomAttrNumber', 37);

setUserId(String userId): void;

Set a custom user identifier value to associate user sessions with analytics events and attributes.

    NewrelicMobile.instance.setUserId("RN12934");

recordBreadcrumb(String name,{Map<String, dynamic>? eventAttributes}): void;

Track app activity/screen that may be helpful for troubleshooting crashes.

    NewrelicMobile.instance.recordBreadcrumb("Button Got Pressed on Screen 3"),

recordCustomEvent(String eventType,{String eventName = "", Map<String, dynamic>? eventAttributes}): void;

Creates and records a custom event for use in New Relic Insights.

    NewrelicMobile.instance.recordCustomEvent("Major",eventName: "User Purchase",eventAttributes: {"item1":"Clothes","price":34.00}),
          child: const Text('Record Custom Event'),

setMaxEventBufferTime(int maxBufferTimeInSec) void;

Sets the event harvest cycle length.

    NewrelicMobile.instance.setMaxEventBufferTime(200);

setMaxEventPoolSize(int maxSize): void;

Sets the maximum size of the event pool.

    NewrelicMobile.instance.setMaxEventPoolSize(10000);

noticeHttpTransaction(String url,String httpMethod,int statusCode,int startTime,int endTime,int bytesSent,int bytesReceived,Map<String, dynamic>? traceData,{String responseBody = ""}): void;

Tracks network requests manually. You can use this method to record HTTP transactions, with an option to also send a response body.

    NewrelicMobile.instance.noticeHttpTransaction("https://cb6b02be-a319-4de5-a3b1-361de2564493.mock.pstmn.io/searchpage", "GET",200, 1000, 2000,100,300,null,responseBody: "This is Test Payload");

noticeNetworkFailure(String url,String httpMethod,int startTime,int endTime,NetworkFailure errorCode): void;

Records network failures. If a network request fails, use this method to record details about the failures. In most cases, place this call inside exception handlers, such as catch blocks. Supported failures are: Unknown, BadURL, TimedOut, CannotConnectToHost, DNSLookupFailed, BadServerResponse, SecureConnectionFailed.

   NewrelicMobile.instance.noticeNetworkFailure("https://cb6b02be-a319-4de5-a3b1-361de2564493.mock.pstmn.io/searchpage", "GET", 1000, 2000,'Test Network Failure', NetworkFailure.dnsLookupFailed);

recordMetric(name: string, category: string, value?: number, countUnit?: string, valueUnit?: string): void;

Records custom metrics (arbitrary numerical data), where countUnit is the measurement unit of the metric count and valueUnit is the measurement unit for the metric value. If using countUnit or valueUnit, then all of value, countUnit, and valueUnit must all be set.

       NewrelicMobile.instance.recordMetric("testMetric", "Test Champ",value: 12.0);
       NewrelicMobile.instance.recordMetric("testMetric1", "TestChamp12",value: 10,valueUnit: MetricUnit.BYTES,countUnit: MetricUnit.PERCENT);

currentSessionId(): Promise;

Returns the current session ID. This method is useful for consolidating monitoring of app data (not just New Relic data) based on a single session definition and identifier.

    var sessionId = await NewrelicMobile.instance.currentSessionId();

setAttribute(name: string, value: boolean | number | string): void;

Creates a session-level attribute shared by multiple mobile event types. Overwrites its previous value and type each time it is called.

   NewrelicMobile.instance.setAttribute("FlutterCustomAttrNumber",value :5.0);

removeAttribute(name: string, value: boolean | number | string): void;

This method removes the attribute specified by the name string..

   NewrelicMobile.instance.removeAttribute("FlutterCustomAttrNumber");

incrementAttribute(name: string, value?: number): void;

Increments the count of an attribute with a specified name. Overwrites its previous value and type each time it is called. If the attribute does not exists, it creates a new attribute. If no value is given, it increments the value by 1.

    NewrelicMobile.instance.incrementAttribute("FlutterCustomAttrNumber");
    NewrelicMobile.instance.incrementAttribute("FlutterCustomAttrNumber",value :5.0);

shutdown() : void;

Shut down the agent within the current application lifecycle during runtime.

    NewrelicMobile.instance.shutdown();

addHTTPHeadersTrackingFor() : void;

This API allows you to add any header field strings to a list that gets recorded as attributes with networking request events. After header fields have been added using this function, if the headers are in a network call they will be included in networking events in NR1.

     NewrelicMobile.instance.addHTTPHeadersTrackingFor(["Car","Music"]);

logInfo(String message) : void

Logs an informational message to the New Relic log.

    NewrelicMobile.instance.logInfo("This is an informational message");

logError(String message) : void

Logs an error message to the New Relic log.

     NewrelicMobile.instance.logError("This is an error message");

logVerbose(String message) : void

Logs a verbose message to the New Relic log.

     NewrelicMobile.instance.logVerbose("This is a verbose message");

logWarning(String message) : void

Logs a warning message to the New Relic log.

     NewrelicMobile.instance.logWarning("This is a warning message");

logDebug(String message) : void

Logs a debug message to the New Relic log.

     NewrelicMobile.instance.logDebug("This is a debug message");

log(LogLevel level, String message) : void

Logs a message to the New Relic log with a specified log level.

     NewrelicMobile.instance.log(LogLevel.Info, "This is an informational message");

logAll(Exception exception,Map<String, dynamic>? attributes) : void

Logs an exception with attributes to the New Relic log.

       NewrelicMobile.instance.logAll(Exception("This is an exception"),
                          {"BreadNumValue": 12.3 ,
                            "BreadStrValue": "FlutterBread",
                            "BreadBoolValue": true ,
                            "message": "This is a message with attributes" }
       );

logAttributes(Dictionary<string, object> attributes) : void

Logs a message with attributes to the New Relic log.

           NewrelicMobile.instance.logAttributes(
                            {"BreadNumValue": 12.3 ,
                            "BreadStrValue": "FlutterBread",
                            "BreadBoolValue": true ,
                            "message": "This is a message with attributes" }
                      );

logAttributes(Dictionary<string, object> attributes) : void

Logs a message with attributes to the New Relic log.

           NewrelicMobile.instance.logAttributes(
                            {"BreadNumValue": 12.3 ,
                            "BreadStrValue": "FlutterBread",
                            "BreadBoolValue": true ,
                            "message": "This is a message with attributes" }
                      );

crashNow({String name}) : void

Throws a demo run-time exception to test New Relic crash reporting.

           NewrelicMobile.instance.crashNow(name: "This is a crash");
            NewrelicMobile.instance.crashNow();

Manual Error reporting

You can register non fatal exceptions using the following method with Custom Attributes:

try {
  some_code_that_throws_error();
} catch (ex) {
NewrelicMobile.instance
        .recordError(error, StackTrace.current, attributes: attributes);
}

Troubleshoot

No Http data appears:

Problem After installing the Flutter agent and waiting at least 5 minutes, no http data appears in New Relic UI.

Solution If no http data appears after you wait at least five minutes, check you are not overriding HttpOverrides.global inside your flutter app.

Crash reports may not be sent when ProGuard rules are not properly configured for New Relic in hybrid Android applications.

Solution: Ensure proper ProGuard rules are added to your ProGuard configuration file. See "Configuring ProGuard Rules" in setup documentation.

Uploading dSYM files

Our iOS agent includes a Swift script intended to be run from a build script in your target's build phases in XCode. The script automatically uploads dSYM files in the background (or converts your dSYM to the New Relic map file format), and then performs a background upload of the files needed for crash symbolication to New Relic.

To invoke this script during an XCode build:

1. Copy the dsym-upload-tools folder from this repository: https://github.com/newrelic/newrelic-ios-agent-spm, to your projects SRCROOT folder first.
2. In Xcode, select your project in the navigator, then click on the application target.
3. Select the Build Phases tab in the settings editor.
4. Click the + icon above Target Dependencies and choose New Run Script Build Phase. Ensure the new build script is the very last build script.
5. Add the following lines of code to the new phase and replace APP_TOKEN with your iOS application token.
   1. If there is a checkbox below Run script that says "Run script: Based on Dependency analysis" please make sure it is not checked.

Flutter agent 1.0.2 or higher

With the ios agent 7.4.6 release, the XCFramework no longer includes the dsym-upload-tools. You can find the dsym-upload-tools in the dsym-upload-tools folder of the https://github.com/newrelic/newrelic-ios-agent-spm Swift Package Manager repository. Please copy the dsym-upload-tools directory into your application source code directory by copying the XCFramework into your project or using Cocoapods if you're integrating the New Relic iOS Agent. Use the run script below in your Xcode build phases to perform symbol upload steps during app builds in Xcode.

ARTIFACT_DIR="${BUILD_DIR%Build/*}"
SCRIPT=`/usr/bin/find "${SRCROOT}" "${ARTIFACT_DIR}" -type f -name run-symbol-tool | head -n 1`
/bin/sh "${SCRIPT}" "APP_TOKEN"

Note: The automatic script requires bitcode to be disabled. You should clean and rebuild your app after adding the script.

Missing dSYMs

The automatic script will create an upload_dsym_results.log file in your project's iOS directory, which contains information about any failures that occur during symbol upload.

If dSYM files are missing, you may need to check Xcode build settings to ensure the file is being generated. Frameworks which are built locally have separate build settings and may need to be updated as well.

Build settings:

Debug Information Format : Dwarf with dSYM File
Deployment Postprocessing: Yes
Strip Linked Product: Yes
Strip Debug Symbols During Copy : Yes

Configure app launch times

To measure app launch time, you can refer to the following documentation for both Android and iOS platforms.

Support

New Relic hosts and moderates an online forum where customers, users, maintainers, contributors, and New Relic employees can discuss and collaborate:

New Relic Explorers Hub topic

Contribute

We encourage your contributions to improve newrelic-flutter-agent! Keep in mind that when you submit your pull request, you'll need to sign the CLA via the click-through using CLA-Assistant. You only have to sign the CLA one time per project.

If you have any questions, or to execute our corporate CLA (which is required if your contribution is on behalf of a company), drop us an email at opensource@newrelic.com.

A note about vulnerabilities

As noted in our security policy, New Relic is committed to the privacy and security of our customers and their data. We believe that providing coordinated disclosure by security researchers and engaging with the security community are important means to achieve our security goals.

If you believe you have found a security vulnerability in this project or any of New Relic's products or websites, we welcome and greatly appreciate you reporting it to New Relic through our bug bounty program.

If you would like to contribute to this project, review these guidelines.

To all contributors, we thank you! Without your contribution, this project would not be what it is today. We also host a community project page dedicated to New Relic Flutter Agent .

License

newrelic-flutter-agent is licensed under the Apache 2.0 License.

newrelic-flutter-agent also uses source code from third-party libraries. Full details on which libraries are used and the terms under which they are licensed can be found in the third-party notices document.