index.mdx

title	description	caseStyle	supportLevel	sdk	fallbackPlatform	categories
Flutter	Sentry's Flutter SDK enables automatic reporting of errors and performance data in your application.	camelCase	production	sentry.dart.flutter	dart	mobile browser desktop

On this page, we get you up and running with Sentry's Flutter SDK.

If you don't already have an account and Sentry project established, head over to sentry.io, then return to this page.

Features

In addition to capturing errors, you can monitor interactions between multiple services or applications by enabling tracing. You can also collect and analyze performance profiles from real users with profiling.

Select which Sentry features you'd like to install in addition to Error Monitoring to get the corresponding installation and configuration instructions below.

Install

<OnboardingOptionButtons options={[ 'error-monitoring', 'performance', 'profiling', ]} />

Sentry captures data by using an SDK within your application's runtime. These are platform-specific and allow Sentry to have a deep understanding of how your application works.

To install, run @sentry/wizard:

brew install getsentry/tools/sentry-wizard && sentry-wizard -i flutter

npx @sentry/wizard@latest -i flutter

Sentry Wizard will patch your project accordingly, though you can set up manually if you prefer. You only need to patch the project once. Then you can add the patched files to your version control system.

• Configure the SDK with your DSN and performance monitoring options in your main.dart file.
• Update your pubspec.yaml with the sentry_flutter and sentry_dart_plugin packages.
• Add an example error to verify your setup.

Configure

Configuration should happen as early as possible in your application's lifecycle.

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

Future<void> main() async {
  await SentryFlutter.init(
    (options) {
      options.dsn = '___PUBLIC_DSN___';
      // Set tracesSampleRate to 1.0 to capture 100% of transactions for tracing.
      // We recommend adjusting this value in production.
      options.tracesSampleRate = 1.0;
      // The sampling rate for profiling is relative to tracesSampleRate
      // Setting to 1.0 will profile 100% of sampled transactions:
      // Note: Profiling alpha is available for iOS and macOS since SDK version 7.12.0
      options.profilesSampleRate = 1.0;
      // Adds request headers and IP for users,
      // visit: https://docs.sentry.io/platforms/dart/guides/flutter/data-management/data-collected/ for more info
      options.sendDefaultPii = true;
    },
    appRunner: () => runApp(
      SentryWidget(
        child: MyApp(),
      ),
    ),
  );

  // you can also configure SENTRY_DSN, SENTRY_RELEASE, SENTRY_DIST, and
  // SENTRY_ENVIRONMENT via Dart environment variable (--dart-define)
}

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

Future<void> main() async {
  // The SDK creates it's own custom zone on web for automatic error and breadcrumb tracking on web.
  // This could lead to zone mismatch errors if you needed to call `WidgetsBinding.ensureInitialized()` before Sentry in a cusom zone.
  // With `Sentry.runZonedGuarded` you still get convenient auto error and breadcrumb tracking and can also call `WidgetsBinding.ensureInitialized()` before Sentry.
  Sentry.runZonedGuarded(() async {
    WidgetsBinding.ensureInitialized();

    // Errors before init will not be handled by Sentry

    await SentryFlutter.init(
      (options) {
        options.dsn = '___PUBLIC_DSN___';
        // Set tracesSampleRate to 1.0 to capture 100% of transactions for tracing.
        // We recommend adjusting this value in production.
        options.tracesSampleRate = 1.0;
        // The sampling rate for profiling is relative to tracesSampleRate
        // Setting to 1.0 will profile 100% of sampled transactions:
        // Note: Profiling alpha is available for iOS and macOS since SDK version 7.12.0
        options.profilesSampleRate = 1.0;
      },
      appRunner: () => runApp(
        SentryWidget(
          child: MyApp(),
        ),
      ),
    );
  } (error, stackTrace) {
    // Automatically sends errors to Sentry, no need to do any
    // captureException calls on your part.
    // On top of that, you can do your own custom stuff in this callback.
  });

  // you can also configure SENTRY_DSN, SENTRY_RELEASE, SENTRY_DIST, and
  // SENTRY_ENVIRONMENT via Dart environment variable (--dart-define)
}

Verify

Verify that your app is sending events to Sentry by adding the following snippet, which includes an intentional error. You should see the error reported in Sentry within a few minutes.

import 'package:sentry/sentry.dart';

try {
  throw Exception('Sentry Test Exception');
} catch (exception, stackTrace) {
  await Sentry.captureException(
    exception,
    stackTrace: stackTrace,
  );
}

Next Steps

• Learn about the features of Sentry's Flutter SDK
• Add readable stack traces to errors
• Add performance instrumentation to your app