Sentry Dart SDK

The sentry_firebase_remote_config package allows you to track changes to Firebase boolean values as feature flags in Sentry.io. This integration helps you monitor how remote configuration changes impact your application's error rates and performance.

Prerequisites

1. A Sentry.io account and a DSN.
2. The firebase_remote_config package installed in your project.
3. The sentry_flutter (or sentry) package installed in your project.

Setup Steps

1. Initialize Firebase in your application.
2. Create an instance of FirebaseRemoteConfig.
3. Initialize the Sentry SDK using SentryFlutter.init (or Sentry.init for pure Dart).
4. Create a SentryFirebaseRemoteConfigIntegration instance, passing your FirebaseRemoteConfig instance.
5. Add the integration to your Sentry options using options.addIntegration().

Configuration Options

When creating the SentryFirebaseRemoteConfigIntegration, you can configure the activateOnConfigUpdated property:

• activateOnConfigUpdated: (bool) Determines if the integration should automatically call remoteConfig.activate() when the configuration is updated. By default, this is true. If you manage activation manually, set this to false to avoid conflicts.

import 'package:firebase_core/firebase_core.dart';
import 'package:flutter/material.dart';
import 'package:sentry_flutter/sentry_flutter.dart';
import 'package:sentry_firebase_remote_config/sentry_firebase_remote_config.dart';
import 'firebase_options.dart';

Future<void> main() async {
  WidgetsFlutterBinding.ensureInitialized();
  await Firebase.initializeApp(
    options: DefaultFirebaseOptions.currentPlatform,
  );

  final remoteConfig = FirebaseRemoteConfig.instance;
  await remoteConfig.setConfigSettings(RemoteConfigSettings(
    fetchTimeout: const Duration(minutes: 1),
    minimumFetchInterval: const Duration(hours: 1),
  ));

  await SentryFlutter.init(
    (options) {
      options.dsn = 'https://example@sentry.io/add-your-dsn-here';

      final sentryFirebaseRemoteConfigIntegration = SentryFirebaseRemoteConfigIntegration(
        firebaseRemoteConfig: remoteConfig,
        // Don't call `await remoteConfig.activate();` when firebase config is updated. Per default this is true.
        activateOnConfigUpdated: false,
      );
      options.addIntegration(sentryFirebaseRemoteConfigIntegration);
    },
  );

  runApp(const RemoteConfigApp());
}

To monitor HTTP requests, performance tracing, and errors in your dio networking layer, use the sentry_dio package.

Setup Steps

1. Sign up for a Sentry.io account and obtain your DSN.
2. Install the sentry and sentry_dio packages via pub.dev.
3. Initialize the Sentry SDK using Sentry.init.
4. Call dio.addSentry() on your Dio instance.

Critical Requirement

dio.addSentry() must be the last initialization step of your Dio setup. If you call it earlier, subsequent Dio configuration steps might overwrite the Sentry configuration.

Features

Depending on your configuration, this integration provides:

• Performance tracing: Tracks the duration and lifecycle of HTTP requests.
• HTTP breadcrumbs: Automatically logs HTTP activity to the Sentry breadcrumb trail.
• Automatic error capturing: Captures exceptions resulting from invalid HTTP status codes or parsing errors.

import 'package:sentry/sentry.dart';
import 'package:sentry_dio/sentry_dio.dart';
import 'package:dio/dio.dart';

Future<void> main() async {
  await Sentry.init(
    (options) {
      options.dsn = 'https://example@sentry.io/example';
    },
    appRunner: initDio, // Init your App.
  );
}

void initDio() {
  final dio = Dio();
  /// This *must* be the last initialization step of the Dio setup, otherwise
  /// your configuration of Dio might overwrite the Sentry configuration.
  dio.addSentry();
}