Начните работу с Firebase Crashlytics


В этом кратком руководстве описывается, как настроить Firebase Crashlytics в вашем приложении с помощью плагина Crashlytics Flutter, чтобы вы могли получать подробные отчеты о сбоях в консоли Firebase .

Настройка Crashlytics включает использование как инструмента командной строки, так и вашей IDE. Чтобы завершить настройку, вам нужно будет принудительно выдать тестовое исключение, чтобы отправить ваш первый отчет о сбое в Firebase.

Прежде чем начать

  1. Если вы еще этого не сделали, настройте и инициализируйте Firebase в своем проекте Flutter.

  2. Рекомендуется : чтобы автоматически получать журналы навигации для понимания действий пользователя, приводящих к сбою, нефатальному событию или событию ANR, вам необходимо включить Google Analytics в вашем проекте Firebase.

    • Если в вашем существующем проекте Firebase не включен Google Analytics , вы можете включить Google Analytics на вкладке «Интеграции» вашего > Настройки проекта в консоли Firebase .

    • Если вы создаете новый проект Firebase, включите Google Analytics во время процесса создания проекта.

    Обратите внимание, что журналы навигации доступны для всех платформ Android и Apple, поддерживаемых Crashlytics (кроме watchOS).

Шаг 1 : Добавьте Crashlytics в свой проект Flutter

  1. Из корня вашего проекта Flutter выполните следующую команду, чтобы установить плагин Flutter для Crashlytics .

    Чтобы воспользоваться журналами breadcrumb , также добавьте плагин Flutter для Google Analytics в свое приложение. Убедитесь, что Google Analytics включен в вашем проекте Firebase.

    flutter pub add firebase_crashlytics && flutter pub add firebase_analytics

  2. Из корневого каталога вашего проекта Flutter выполните следующую команду:

    flutterfire configure

    Выполнение этой команды гарантирует, что конфигурация Firebase вашего приложения Flutter будет обновлена, а для Android добавит в ваше приложение необходимый плагин Crashlytics Gradle.

  3. После завершения пересоберите свой проект Flutter:

    flutter run

  4. (Необязательно) Если ваш проект Flutter использует флаг --split-debug-info (и, по желанию, также флаг --obfuscate ), для отображения читаемых трассировок стека для ваших приложений требуются дополнительные шаги.

    • Платформы Apple: убедитесь, что ваш проект использует рекомендуемую конфигурацию версии (Flutter 3.12.0+ и плагин Flutter Crashlytics 3.3.4+), чтобы ваш проект мог автоматически генерировать и загружать символы Flutter (файлы dSYM) в Crashlytics .

    • Android: Используйте Firebase CLI (v.11.9.0+) для загрузки отладочных символов Flutter. Вам необходимо загрузить отладочные символы , прежде чем сообщать о сбое из-за обфусцированной сборки кода.

      Из корневого каталога вашего проекта Flutter выполните следующую команду:

      firebase crashlytics:symbols:upload --app=FIREBASE_APP_ID PATH/TO/symbols

      • FIREBASE_APP_ID : ваш идентификатор приложения Firebase Android (не имя вашего пакета)
        Пример идентификатора приложения Firebase Android: 1:567383003300:android:17104a2ced0c9b9b

      • PATH/TO /symbols : тот же каталог, который вы передаете флагу --split-debug-info при сборке приложения.

Шаг 2 : Настройка обработчиков сбоев

Вы можете автоматически перехватывать все ошибки, возникающие в среде Flutter, переопределив FlutterError.onError с помощью FirebaseCrashlytics.instance.recordFlutterFatalError :

void main() async {
  WidgetsFlutterBinding.ensureInitialized();

  await Firebase.initializeApp();

  // Pass all uncaught "fatal" errors from the framework to Crashlytics
  FlutterError.onError = FirebaseCrashlytics.instance.recordFlutterFatalError;

  runApp(MyApp());
}

Чтобы перехватывать асинхронные ошибки, которые не обрабатываются фреймворком Flutter, используйте PlatformDispatcher.instance.onError :

Future<void> main() async {
    WidgetsFlutterBinding.ensureInitialized();
    await Firebase.initializeApp();
    FlutterError.onError = (errorDetails) {
      FirebaseCrashlytics.instance.recordFlutterFatalError(errorDetails);
    };
    // Pass all uncaught asynchronous errors that aren't handled by the Flutter framework to Crashlytics
    PlatformDispatcher.instance.onError = (error, stack) {
      FirebaseCrashlytics.instance.recordError(error, stack, fatal: true);
      return true;
    };
    runApp(MyApp());

}

Примеры обработки других типов ошибок см. в разделе Настройка отчетов о сбоях .

Шаг 3 : Принудительный тестовый сбой для завершения настройки

Чтобы завершить настройку Crashlytics и увидеть начальные данные на панели управления Crashlytics консоли Firebase , необходимо принудительно вызвать тестовое исключение.

  1. Добавьте в свое приложение код, который можно использовать для принудительного вызова тестового исключения.

    Если вы добавили обработчик ошибок, который вызывает FirebaseCrashlytics.instance.recordError(error, stack, fatal: true) в Zone верхнего уровня, вы можете использовать следующий код, чтобы добавить в свое приложение кнопку, при нажатии которой будет выдаваться тестовое исключение:

    TextButton(
    onPressed: () => throw Exception(),
    child: const Text("Throw Test Exception"),
),

  2. Создайте и запустите свое приложение.

  3. Принудительно вызовите тестовое исключение, чтобы отправить первый отчет вашего приложения:

    1. Откройте приложение на тестовом устройстве или эмуляторе.

    2. В своем приложении нажмите кнопку тестового исключения, которую вы добавили с помощью кода выше.

  4. Перейдите на панель управления Crashlytics консоли Firebase , чтобы увидеть краш вашего теста.

    Если вы обновили консоль, но через пять минут сбой теста так и не появился, включите ведение журнала отладки, чтобы проверить, отправляет ли ваше приложение отчеты о сбоях.


И все! Crashlytics теперь отслеживает сбои в вашем приложении, а на Android — нефатальные ошибки и ANR. Посетите панель управления Crashlytics , чтобы просмотреть и изучить все ваши отчеты и статистику.

Следующие шаги