Sentry SDK for Flutter: A Comprehensive Guide to Monitoring Errors and Crashes

The Sentry SDK for Flutter empowers developers to track and report errors and crashes in their Flutter applications. By integrating with Sentry's robust platform, developers can gain valuable insights into their application's performance and stability, enabling them to quickly identify and resolve issues.

Usage

To utilize the Sentry SDK for Flutter, follow these steps:

Obtain a DSN: Register for a Sentry.io account and acquire a Data Source Name (DSN). This DSN will be used to configure the Sentry SDK.
Install the Package: Install the sentry_flutter package from pub.dev using the following command:

flutter pub add sentry_flutter

Initialize the SDK: Initialize the Sentry SDK with the following code:

import 'package:sentry_flutter/sentry_flutter.dart';

Future main() async {
  await SentryFlutter.init(
    (options) {
      options.dsn = 'https://[email protected]/add-your-dsn-here';
    },
  );
}

Tracking Navigation Events

To track navigation events in your Flutter app, add the SentryNavigatorObserver to your MaterialApp, WidgetsApp, or CupertinoApp:

import 'package:flutter/material.dart';
import 'package:sentry_flutter/sentry_flutter.dart';

// ...

MaterialApp(
  navigatorObservers: [
    SentryNavigatorObserver(),
  ],
  // other parameters
);

// ...

Tracking HTTP Events

To capture HTTP events, you can use the SentryHttp class:

import 'package:sentry_flutter/sentry_flutter.dart';

// ...

final http = SentryHttp();
http.captureHttpTransaction(event);

// ...

Performance Tracing for AssetBundles

For performance tracing of AssetBundles, use the SentryAssetBundle:

import 'package:flutter/material.dart';
import 'package:sentry_flutter/sentry_flutter.dart';

// ...

runApp(
  DefaultAssetBundle(
    bundle: SentryAssetBundle(),
    child: MyApp(),
  ),
);

// ...

Known Limitations

In debug mode, Flutter removes layout-related errors.
If split-debug-info is enabled, manual upload of Debug Symbols is necessary.

Tips for Catching Errors

Employ try/catch blocks.
For Futures, use the catchError block.
Flutter-specific errors are automatically captured.
For Isolate errors, use isolate.addSentryErrorListener().