Настройте отчеты о сбоях Firebase Crashlytics


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

Сообщать о неперехваченных исключениях

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

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

  await Firebase.initializeApp();
  bool weWantFatalErrorRecording = true;
  FlutterError.onError = (errorDetails) {
    if(weWantFatalErrorRecording){
      FirebaseCrashlytics.instance.recordFlutterFatalError(errorDetails);
    } else {
      FirebaseCrashlytics.instance.recordFlutterError(errorDetails);
    }
  };

  runApp(MyApp());
}

Асинхронные ошибки

Асинхронные ошибки не улавливаются платформой Flutter:

ElevatedButton(
  onPressed: () async {
    throw Error();
  }
  ...
)

Чтобы отловить такие ошибки, вы можете использовать обработчик 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());

}

Ошибки вне Flutter

Чтобы перехватывать ошибки, возникающие вне контекста Flutter, установите прослушиватель ошибок в текущем Isolate : 

Isolate.current.addErrorListener(RawReceivePort((pair) async {
  final List<dynamic> errorAndStacktrace = pair;
  await FirebaseCrashlytics.instance.recordError(
    errorAndStacktrace.first,
    errorAndStacktrace.last,
    fatal: true,
  );
}).sendPort);

Сообщить об обнаруженных исключениях

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

Используйте метод recordError для записи нефатальных исключений в блоках catch вашего приложения. Например:

await FirebaseCrashlytics.instance.recordError(
  error,
  stackTrace,
  reason: 'a non-fatal error'
);

// Or you can use:
await FirebaseCrashlytics.instance.recordFlutterError(errorDetails);

Вы также можете захотеть записать дополнительную информацию об ошибке, что возможно с помощью свойства information :

await FirebaseCrashlytics.instance.recordError(
  error,
  stackTrace,
  reason: 'a non-fatal error',
  information: ['further diagnostic information about the error', 'version 2.0'],
);

Эти исключения отображаются как нефатальные проблемы в консоли Firebase . Сводка проблем содержит всю информацию о состоянии, которую вы обычно получаете при сбоях, а также разбивку по версиям и аппаратным устройствам.

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

Добавить пользовательские ключи

Пользовательские ключи помогают вам получить конкретное состояние вашего приложения, приводящее к сбою. Вы можете связать произвольные пары ключ/значение с отчетами о сбоях, а затем использовать пользовательские ключи для поиска и фильтрации отчетов о сбоях в консоли Firebase .

  • На панели управления Crashlytics вы можете искать проблемы, соответствующие пользовательскому ключу.

  • Просматривая конкретную проблему в консоли, вы можете просмотреть связанные пользовательские ключи для каждого события (подвкладка «Ключи» ) и даже отфильтровать события по пользовательским ключам (меню «Фильтр» вверху страницы).

Используйте метод экземпляра setCustomKey для установки пар ключ/значение. Вот несколько примеров: 

// Set a key to a string.
FirebaseCrashlytics.instance.setCustomKey('str_key', 'hello');

// Set a key to a boolean.
FirebaseCrashlytics.instance.setCustomKey("bool_key", true);

// Set a key to an int.
FirebaseCrashlytics.instance.setCustomKey("int_key", 1);

// Set a key to a long.
FirebaseCrashlytics.instance.setCustomKey("int_key", 1L);

// Set a key to a float.
FirebaseCrashlytics.instance.setCustomKey("float_key", 1.0f);

// Set a key to a double.
FirebaseCrashlytics.instance.setCustomKey("double_key", 1.0);

Добавить пользовательские сообщения журнала

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

Используйте log , чтобы выявить проблемы. Например: 

FirebaseCrashlytics.instance.log("Higgs-Boson detected! Bailing out");

Установить идентификаторы пользователей

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

Чтобы добавить идентификаторы пользователей в отчеты, назначьте каждому пользователю уникальный идентификатор в форме идентификационного номера, токена или хеш-значения:

FirebaseCrashlytics.instance.setUserIdentifier("12345");

Если вам когда-нибудь понадобится очистить идентификатор пользователя после его установки, сбросьте значение на пустую строку. Очистка идентификатора пользователя не удаляет существующие записи Crashlytics . Если вам нужно удалить записи, связанные с идентификатором пользователя, обратитесь в службу поддержки Firebase .

Получить навигационные журналы

Журналы навигации позволяют лучше понять взаимодействие пользователя с вашим приложением, которое привело к сбою, несмертельному событию или событию ANR. Эти журналы могут быть полезны при попытке воспроизвести и отладить проблему.

Журналы навигации основаны на Google Analytics, поэтому для получения журналов навигации вам необходимо включить Google Analytics для вашего проекта Firebase и добавить Firebase SDK для Google Analytics в свое приложение. Как только эти требования будут выполнены, навигационные журналы автоматически включаются в данные о событии на вкладке «Журналы», когда вы просматриваете подробности проблемы.

Analytics SDK автоматически регистрирует событие screen_view , которое позволяет в журналах навигации отображать список экранов, просмотренных до сбоя, нефатального события или события ANR. Хлебный журнал screen_view содержит параметр firebase_screen_class .

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

Обратите внимание, что вы можете контролировать сбор и использование данных Google Analytics , включая данные, заполняющие журналы навигации.

Включить подписку на получение отчетов

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

  1. Отключите автоматический сбор:

    платформы Apple

    Добавьте новый ключ в файл Info.plist :

    • Ключ: FirebaseCrashlyticsCollectionEnabled
    • Значение: false

    Андроид

    В блоке application вашего файла AndroidManifest.xml добавьте тег meta-data , чтобы отключить автоматический сбор:

    <meta-data
    android:name="firebase_crashlytics_collection_enabled"
    android:value="false" />

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

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

    FirebaseCrashlytics.instance.setCrashlyticsCollectionEnabled(true);

Управление данными Crash Insights

Crash Insights помогает вам решать проблемы, сравнивая анонимные трассировки стека со трассировками из других приложений Firebase и сообщая вам, является ли ваша проблема частью более широкой тенденции. Для многих проблем Crash Insights даже предоставляет ресурсы, которые помогут вам устранить сбой.

Crash Insights использует агрегированные данные о сбоях для выявления общих тенденций стабильности. Если вы предпочитаете не делиться данными своего приложения, вы можете отказаться от Crash Insights в меню Crash Insights в верхней части списка проблем Crashlytics в консоли Firebase .

,


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

Сообщать о неперехваченных исключениях

Вы можете автоматически поймать все «фатальные» ошибки, которые бросают в рамку Flutter, переопределяя FlutterError.onError с FirebaseCrashlytics.instance.recordFlutterFatalError . В качестве альтернативы, чтобы также поймать «не фатальные» исключения, переопределить FlutterError.onError с FirebaseCrashlytics.instance.recordFlutterError : 

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

  await Firebase.initializeApp();
  bool weWantFatalErrorRecording = true;
  FlutterError.onError = (errorDetails) {
    if(weWantFatalErrorRecording){
      FirebaseCrashlytics.instance.recordFlutterFatalError(errorDetails);
    } else {
      FirebaseCrashlytics.instance.recordFlutterError(errorDetails);
    }
  };

  runApp(MyApp());
}

Асинхронные ошибки

Асинхронные ошибки не поймают флаттер -структуру:

ElevatedButton(
  onPressed: () async {
    throw Error();
  }
  ...
)

Чтобы поймать такие ошибки, вы можете использовать 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());

}

Ошибки за пределами трепета

Чтобы поймать ошибки, которые происходят вне контекста Flutter, установите прослушиватель ошибок в текущем Isolate : 

Isolate.current.addErrorListener(RawReceivePort((pair) async {
  final List<dynamic> errorAndStacktrace = pair;
  await FirebaseCrashlytics.instance.recordError(
    errorAndStacktrace.first,
    errorAndStacktrace.last,
    fatal: true,
  );
}).sendPort);

Отчет поймал исключения

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

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

await FirebaseCrashlytics.instance.recordError(
  error,
  stackTrace,
  reason: 'a non-fatal error'
);

// Or you can use:
await FirebaseCrashlytics.instance.recordFlutterError(errorDetails);

Вы также можете войти в систему дополнительной информации об ошибке, которая возможна с помощью information :

await FirebaseCrashlytics.instance.recordError(
  error,
  stackTrace,
  reason: 'a non-fatal error',
  information: ['further diagnostic information about the error', 'version 2.0'],
);

Эти исключения появляются в виде нерадостных проблем в консоли Firebase . Сводка выпуска содержит всю информацию о состоянии, которую вы обычно получаете из сбоев, а также сбои по версии и аппаратному устройству.

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

Добавьте пользовательские ключи

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

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

  • Когда вы просматриваете конкретную проблему в консоли, вы можете просмотреть связанные с ними пользовательские клавиши для каждого события (подтаба Keys ) и даже отфильтровать события по пользовательским ключам (меню фильтра в верхней части страницы).

Используйте метод экземпляра setCustomKey , чтобы установить пары клавиш/значение. Вот несколько примеров: 

// Set a key to a string.
FirebaseCrashlytics.instance.setCustomKey('str_key', 'hello');

// Set a key to a boolean.
FirebaseCrashlytics.instance.setCustomKey("bool_key", true);

// Set a key to an int.
FirebaseCrashlytics.instance.setCustomKey("int_key", 1);

// Set a key to a long.
FirebaseCrashlytics.instance.setCustomKey("int_key", 1L);

// Set a key to a float.
FirebaseCrashlytics.instance.setCustomKey("float_key", 1.0f);

// Set a key to a double.
FirebaseCrashlytics.instance.setCustomKey("double_key", 1.0);

Добавить пользовательские сообщения журнала

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

Используйте log , чтобы помочь определить проблемы. Например: 

FirebaseCrashlytics.instance.log("Higgs-Boson detected! Bailing out");

Установите идентификаторы пользователей

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

Чтобы добавить идентификаторы пользователей в ваши отчеты, назначьте каждому пользователю уникальный идентификатор в форме идентификационного номера, токена или хешированного значения:

FirebaseCrashlytics.instance.setUserIdentifier("12345");

Если вам когда -нибудь нужно будет очистить идентификатор пользователя после его установки, сбросьте значение в пустую строку. Очистка идентификатора пользователя не удаляет существующие записи Crashlytics . Если вам нужно удалить записи, связанные с идентификатором пользователя, свяжитесь с поддержкой Firebase .

Получите бревна для хлебной крошки

Журналы Breadcrumb дают вам лучшее понимание взаимодействий, которые пользователь имел с вашим приложением, ведущим к сбою, не-лечебным или ANR события. Эти журналы могут быть полезны при попытке воспроизвести и отладить проблему.

Журналы Breadcrumb работают от Google Analytics, поэтому для получения журналов Breadcrumb вам необходимо включить Google Analytics для вашего проекта Firebase и добавить Firebase SDK для Google Analytics в ваше приложение. Как только эти требования будут выполнены, журналы Breadcrumb автоматически включаются в данные события на вкладке журналов , когда вы просмотрите детали проблемы.

Analytics SDK автоматически регистрирует событие screen_view , которое позволяет журналам Breadcrumb отображать список экранов, просмотренных перед сбоем, не-фатальными или ANR событие. Журнал screen_view Breadcrumb содержит параметр firebase_screen_class .

Журналы Breadcrumb также заполняются любыми пользовательскими событиями , которые вы вручную войдут в сеанс пользователя, включая данные параметров события. Эти данные могут помочь показать серию действий пользователя, ведущих к сбою, не фатальническому или ANR событию.

Обратите внимание, что вы можете управлять сбором и использованием данных Google Analytics , которые включают данные, которые заполняют журналы Breadcrumb.

Включить отчеты

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

  1. Отключить автоматическую коллекцию изначально:

    Apple Платформы

    Добавьте новый ключ в свой файл Info.plist :

    • Ключ: FirebaseCrashlyticsCollectionEnabled
    • Значение: false

    Андроид

    В блоке application вашего файла AndroidManifest.xml добавьте meta-data тег для отключения автоматической коллекции:

    <meta-data
    android:name="firebase_crashlytics_collection_enabled"
    android:value="false" />

  2. Включите коллекцию для выбора пользователей, вызывая переопределение сбора данных Crashlytics Data.

    Стоимость переопределения сохраняется в течение запуска вашего приложения, поэтому Crashlytics может автоматически собирать отчеты. Чтобы отказаться от автоматической отчетности по сбою, пройти false в качестве значения переопределения. При установке на false новое значение не применяется до следующего запуска приложения.

    FirebaseCrashlytics.instance.setCrashlyticsCollectionEnabled(true);

Управлять данными о сбоях

Crash Insights поможет вам решить проблемы, сравнивая ваши анонимные трассировки стека с трассами от других приложений Firebase и сообщив вам, является ли ваша проблема частью более широкой тенденции. Для многих проблем Crash Insights даже предоставляет ресурсы, чтобы помочь вам отладить аварию.

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