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


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

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

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

Сообщить об исключениях

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

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

Вы можете регистрировать исключения в C#, используя следующий метод: 

Crashlytics.LogException(Exception ex);

Вы можете регистрировать ожидаемые исключения в блоках try/catch вашей игры: 

try {
    myMethodThatThrows();
} catch (Exception e) {
   Crashlytics.LogException(e);
   // handle your exception here!
}

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

Для неперехваченных исключений , которые не приводят к сбою вашей игры (например, неперехваченные исключения C# в игровой логике), вы можете заставить Crashlytics SDK сообщать о них как о фатальных событиях , установив для свойства Crashlytics.ReportUncaughtExceptionsAsFatal значение true при инициализации Crashlytics в проекте Unity. . Об этих событиях сообщается в Crashlytics в режиме реального времени, без необходимости перезапуска игры конечному пользователю.

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

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

void Start() {
    // Since there is no try-block surrounding this call, if an exception is thrown,
    // it is considered unexpected.
    // Setting `Crashlytics.ReportUncaughtExceptionsAsFatal = true`
    // will ensure that such cases are reported as fatals.
    thirdPartyMethodThatMayThrow();
}

Включите отчеты GWP-ASan для устранения проблем с повреждением памяти.

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

  • Вы можете просмотреть эти данные на новой вкладке «Трассы стека памяти», если щелкнуть сведения о проблеме на панели управления Crashlytics .

  • Вы также можете использовать новый сигнал и фильтр «Отчет GWP-ASan», чтобы быстро просмотреть все проблемы с этими данными.

Вы можете получать отчеты о памяти GWP-ASan, если ваше приложение использует последнюю версию Crashlytics SDK для Unity (v10.7.0+) и в нем явно включен GWP-ASan (требуется изменить манифест приложения Android ). Если в вашем приложении есть код C++, вы можете протестировать настройку GWP-ASan, используя пример собственного кода в документации Android .

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

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

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

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

Crashlytics.SetCustomKey(string key, string value);

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

Зарегистрированные сообщения связаны с вашими данными о сбоях и отображаются на панели управления Firebase Crashlytics при просмотре конкретного сбоя. 

Crashlytics.Log(string message);

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

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

Crashlytics.SetUserId(string identifier);

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

Журналы навигации позволяют лучше понять взаимодействие пользователя с вашим приложением, которое привело к сбою, несмертельному событию или событию 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 только для выбранных пользователей, вызовите переопределение сбора данных Crashlytics во время выполнения. Значение переопределения сохраняется при запуске вашего приложения, поэтому Crashlytics может автоматически собирать отчеты. Чтобы отказаться от автоматического сообщения о сбоях, передайте false в качестве значения переопределения. Если установлено значение false , новое значение не применяется до следующего запуска приложения. 

Crashlytics.IsCrashlyticsCollectionEnabled = true

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

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

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