Instabug for Flutter

A Flutter plugin for Instabug.

Available Features

Feature	Status
Bug Reporting	✅
Crash Reporting	✅
In-App Chat	✅
In-App Surveys	✅
Feature Requests	✅

• ✅ Stable
• ⚙️ Under active development

Integration

Installation

1. Add Instabug to your pubspec.yaml file.

dependencies:
      instabug_flutter:

2. Install the package by running the following command.

flutter packages get

Initializing Instabug

To start using Instabug, import it into your Flutter app.

import 'package:instabug_flutter/Instabug.dart';

• iOS

  Initialize the SDK in initState(). This line enables the SDK with the default behavior and sets it to be shown when the device is shaken.

Instabug.start('APP_TOKEN', [InvocationEvent.shake]);

• Android

1. Add the following Maven repository to your project level build.gradle

allprojects {
	repositories {
	    maven {
	        url "https://sdks.instabug.com/nexus/repository/instabug-cp"
	    }
	}
}

2. Create a new Java class that extends FlutterApplication and add it to your AndroidManifest.xml.

<application
    android:name=".CustomFlutterApplication"
    ...
</application>

3. In your newly created CustomFlutterApplication class, override onCreate() and add the following code.

ArrayList<String> invocationEvents = new ArrayList<>();
invocationEvents.add(InstabugFlutterPlugin.INVOCATION_EVENT_SHAKE);
new InstabugFlutterPlugin().start(CustomFlutterApplication.this, "APP_TOKEN", invocationEvents);

Crash reporting

Instabug automatically captures every crash of your app and sends relevant details to the crashes page of your dashboard.

⚠️ Crashes will only be reported in release mode and not in debug mode.

1. Import the following into your main.dart:

import 'package:instabug_flutter/CrashReporting.dart';

2. Replace void main() => runApp(MyApp()); with the following snippet.

   Recommended:

   void main() async {
     FlutterError.onError = (FlutterErrorDetails details) {
       Zone.current.handleUncaughtError(details.exception, details.stack);
     };
     runZonedGuarded<Future<void>>(() async {
       runApp(MyApp());
     }, (Object error, StackTrace stackTrace) {
       CrashReporting.reportCrash(error, stackTrace);
     });
   }
   

   For Flutter versions prior to 1.17:

   void main() async {
     FlutterError.onError = (FlutterErrorDetails details) {
       Zone.current.handleUncaughtError(details.exception, details.stack);
     };
     runZoned<Future<void>>(() async {
       runApp(MyApp());
     }, onError: (dynamic error, StackTrace stackTrace) {
       CrashReporting.reportCrash(error, stackTrace);
     });
   }
   

Repro Steps

Repro Steps list all of the actions an app user took before reporting a bug or crash, grouped by the screens they visited in your app.

To enable this feature, you need to add InstabugNavigatorObserver to the navigatorObservers :

 runApp(MaterialApp(
   navigatorObservers: [InstabugNavigatorObserver()],
 ));

⚠️ Screenshots in repro steps on android is not currently supported.

Network Logging

You can choose to attach all your network requests to the reports being sent to the dashboard. To enable the feature when using the dart:io package HttpClient, use the custom Instabug client:

InstabugCustomHttpClient client = InstabugCustomHttpClient();

and continue to use the package normally to make your network requests:

client.getUrl(Uri.parse(URL)).then((request) async {
      var response = await request.close();
});

We also support the packages http and dio. For details on how to enable network logging for these external packages, refer to the Instabug Dart Http Adapter and the Instabug Dio Interceptor repositories.

Microphone and Photo Library Usage Description (iOS Only)

Instabug needs access to the microphone and photo library to be able to let users add audio and video attachments. Starting from iOS 10, apps that don’t provide a usage description for those 2 permissions would be rejected when submitted to the App Store.

For your app not to be rejected, you’ll need to add the following 2 keys to your app’s info.plist file with text explaining to the user why those permissions are needed:

• NSMicrophoneUsageDescription
• NSPhotoLibraryUsageDescription

If your app doesn’t already access the microphone or photo library, we recommend using a usage description like:

• "<app name> needs access to the microphone to be able to attach voice notes."
• "<app name> needs access to your photo library for you to be able to attach images."

The permission alert for accessing the microphone/photo library will NOT appear unless users attempt to attach a voice note/photo while using Instabug.