Instabug for Flutter

pub package

A Flutter plugin for Instabug.

⚠️ While this plugin is currently in beta, it's safe to start using it and ship apps with it to production. If you'd like to give us feedback or create a pull request, we would highly appreciate it!

Available Features

FeatureStatus
Bug Reporting
Crash Reporting
In-App Chat
In-App Surveys
Feature Requests
  • ✅ Stable
  • ⚙️ Under active development
  • ⚠ Not available yet

Integration

Creating a Flutter app on the Instabug dashboard isn't possible yet. Create a React Native app instead.

Installation

  1. Add Instabug to your pubspec.yaml file.
dependencies:
    instabug_flutter:
  1. Install the package by running the following command.
flutter packages get

Using Instabug

  1. To start using Instabug, import it into your Flutter app.
import 'package:instabug_flutter/Instabug.dart';
  1. 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. Ignore this if you're building for Android only.
Instabug.start('APP_TOKEN', [InvocationEvent.shake]);
  1. Add the following Maven repository to your project level build.gradle
allprojects {
	repositories {
	    maven {
	        url "https://sdks.instabug.com/nexus/repository/instabug-cp"
	    }
	}
}

Make sure to replace app_token with your application token.

  1. If your app supports Android, create a new Java class that extends FlutterApplication and add it to your AndroidManifest.xml.
<application
    android:name=".CustomFlutterApplication"
    ...
</application>
  1. 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);

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.

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.

Libraries

BugReporting
Chats
FeatureRequests
Instabug
InstabugLog
NetworkLogger
Replies
Surveys
http_client_logger
instabug_custom_http_client
network_data