Install

Sentry captures data by using an SDK within your application’s runtime. Add the following to your pubspec.yaml

pubspec.yaml

dependencies:
  sentry_flutter: ^8.11.0

Configure SDK

Import sentry_flutter and initialize it

Flutter Profiling alpha is available for iOS and macOS since SDK version 7.12.0.

main.dart

import 'package:sentry_flutter/sentry_flutter.dart';

Future<void> main() async {
  await SentryFlutter.init(
    (options) {
      options.dsn = '<https://c480a967661b8c0018ffad013636ef97@o4508471653302272.ingest.us.sentry.io/4508471654612992>';
      // 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:
      options.profilesSampleRate = 1.0;
    },
    appRunner: () => runApp(const MyApp()),
  );

  // or define SENTRY_DSN via Dart environment variable (--dart-define)
}

You can configure the SENTRY_DSN, SENTRY_RELEASE, SENTRY_DIST, and SENTRY_ENVIRONMENT via the Dart environment variables passing the --dart-define flag to the compiler, as noted in the code sample.

To monitor performance, you need to add extra instrumentation as described in the Tracing section below.

Verify

Create an intentional error, so you can test that everything is working. In the example below, pressing the button will throw an exception:

child: ElevatedButton(
  onPressed: () {
    throw Exception('This is test exception');
  },
  child: const Text('Verify Sentry Setup'),
)

Tracing

You'll be able to monitor the performance of your app using the SDK. For example:

import 'package:sentry/sentry.dart';

void execute() async {
  final transaction = Sentry.startTransaction('processOrderBatch()', 'task');

  try {
    await processOrderBatch(transaction);
  } catch (exception) {
    transaction.throwable = exception;
    transaction.status = const SpanStatus.internalError();
  } finally {
    await transaction.finish();
  }
}

Future<void> processOrderBatch(ISentrySpan span) async {
  // span operation: task, span description: operation
  final innerSpan = span.startChild('task', description: 'operation');

  try {
    // omitted code
  } catch (exception) {
    innerSpan.throwable = exception;
    innerSpan.status = const SpanStatus.notFound();
  } finally {
    await innerSpan.finish();
  }
}

To learn more about the API and automatic instrumentations, check out the tracing documentation.

Additional Information