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

iOS+ Android Flutter Unity

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

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

• Настройте свое приложение для регистрации пользовательских ключей , пользовательских сообщений журнала и идентификаторов пользователей .

• Автоматически получайте журналы навигации , если ваше приложение использует Firebase SDK для Google Analytics . Эти журналы позволяют отслеживать действия пользователя, приводящие к событию в вашем приложении, собранному Crashlytics .

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

Примечание: Для приложений Flutter отчёты о критических ошибках отправляются в 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 позволяет регистрировать нефатальные исключения и отправлять их вам при следующем сообщении о фатальном событии или при перезапуске приложения.

Примечание: Crashlytics хранит только восемь последних зарегистрированных нефатальных исключений. Если ваше приложение генерирует более восьми, старые исключения теряются. Этот счётчик сбрасывается каждый раз при генерации фатального исключения, поскольку это приводит к отправке отчёта в 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'],
);

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

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

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

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

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

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

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

Примечание: Crashlytics поддерживает максимум 64 пары «ключ/значение». После достижения этого порога дополнительные значения не сохраняются. Размер каждой пары «ключ/значение» может составлять до 1 КБ.

Используйте метод экземпляра 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 ».

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

Используйте 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 может автоматически собирать отчёты для этого пользователя.

   FirebaseCrashlytics.instance.setCrashlyticsCollectionEnabled(true);
   

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

Примечание: Если сбор данных для пользователя отключен, Crashlytics будет хранить информацию о сбоях локально на устройстве. Если сбор данных будет впоследствии включен, вся информация о сбоях, хранящаяся на устройстве, будет отправлена ​​в Crashlytics для обработки.

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

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

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

Примечание: Отключение доступа к данным также приводит к удалению информации о ваших проблемах. Изменения вступают в силу в течение 24 часов.