pub package flutter build code coverage

NOTE: While sentry package provides a low-level functionality to report exceptions from Dart/Flutter code, flutter_sentry plugin (which also uses sentry package behind the scenes!) aims at full integration with Flutter ecosystem, automatically including Flutter application details in reports and catching crashes in native code, including other Flutter plugins and Flutter itself

Setup

  1. Add flutter_sentry to your pubspec.yaml:

    dependencies:
      flutter_sentry: ^0.1.0
    
  2. Find out a DSN value from Sentry.io and add it to native platforms:

    NOTE: if you forget to add DSN to the platform code, or do it incorrectly, the application will encounter a fatal crash on startup on that platform.

    • iOS: in ios/Runner/Info.plist:

      <dict>
        ... existing configuration parameters ...
        <key>SentryDSN</key>
        <string>value you got from sentry.io</string>
      </dict>
      
    • Android: in android/app/src/main/AndroidManifest.xml:

      <application>
        <meta-data
            android:name="io.sentry.dsn"
            android:value="value you got from sentry.io" />
      

      You can also enable debug logging for Sentry Android library if it's not working as intended:

        <meta-data
            android:name="io.sentry.debug"
            android:value="true" />
      

      NOTE: make sure to add <meta-data> tag directly under <application> (and not for example <activity>).

  3. Finally, wrap your runApp() call in FlutterSentry.wrap() like this:

    import 'package:flutter_sentry/flutter_sentry.dart';
    
    Future<void> main() => FlutterSentry.wrap(
         () async {
           // Optionally other initializers, like Firebase.
    
           runApp(App());
         },
         dsn: 'value you got from sentry.io',
       );
    

Why do I have to specify DSN in multiple places?

You might be wondering why a DSN value can't be specified in a single place and then exchanged between platforms and Dart/Flutter code via a MethodChannel. The reason for that is, native code and Flutter initialize in parallel, before MethodChannel is available, and if a crash happens before MethodChannel is ready... that part of application is on its own.

That said, we want to minimize the installation burden. While the plugin is still in development, we may eventually introduce a way to configure the value once and have it copied to all platforms at build time. Stay tuned!

Libraries

flutter_sentry