Skip to content

Latest commit

 

History

History
116 lines (80 loc) · 4.34 KB

README.md

File metadata and controls

116 lines (80 loc) · 4.34 KB
Raw

Instabug for Flutter

pub package

A Flutter plugin for Instabug.

Available Features

Feature Status
Bug Reporting ✅
Crash Reporting ✅
App Performance Monitoring ✅
In-App Replies ✅
In-App Surveys ✅
Feature Requests ✅
  • ✅ Stable
  • ⚙️ Under active development

Integration

Installation

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

Initializing Instabug

Initialize the SDK in your main function. This starts the SDK with the default behavior and sets it to be shown when the device is shaken.

import 'package:instabug_flutter/instabug_flutter.dart';

void main() {
  WidgetsFlutterBinding.ensureInitialized();

  Instabug.init(
    token: 'APP_TOKEN',
    invocationEvents: [InvocationEvent.shake],
  );

  runApp(MyApp());
}

⚠️ If you're updating the SDK from versions prior to v11, please check our migration guide.

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.

void main() {
  runZonedGuarded(
    () {
      WidgetsFlutterBinding.ensureInitialized();

      Instabug.init(
        token: 'APP_TOKEN',
        invocationEvents: [InvocationEvent.shake],
      );

      FlutterError.onError = (FlutterErrorDetails details) {
        Zone.current.handleUncaughtError(details.exception, details.stack!);
      };

      runApp(MyApp());
    },
    CrashReporting.reportCrash,
  );
}

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()],
 ));

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, please refer to the Instabug Dart IO Http Client repository.

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.