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

iOS+ Android Android (NDK) Flutter Unity

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

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

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

1. Добавьте Firebase в свой проект Apple, если вы ещё этого не сделали. Если у вас нет приложения Apple, вы можете скачать пример приложения .

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

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

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

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

Шаг 1 : Добавьте Crashlytics SDK в свое приложение

Используйте Swift Package Manager для установки и управления зависимостями Firebase.

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

1. В Xcode откройте проект приложения и перейдите в Файл > Добавить пакеты .
2. При появлении запроса добавьте репозиторий Firebase Apple Platforms SDK:

  https://github.com/firebase/firebase-ios-sdk.git

Примечание: в новых проектах следует использовать версию SDK по умолчанию (последнюю), но при необходимости можно выбрать и более старую версию.
3. Выберите библиотеку Crashlytics .
4. Чтобы воспользоваться журналами навигации , добавьте в приложение Firebase SDK для Google Analytics . Убедитесь, что Google Analytics включен в вашем проекте Firebase.
5. Добавьте флаг -ObjC в раздел «Другие флаги компоновщика» настроек сборки вашей целевой системы.
6. (только для macOS) В файле Info.plist добавьте ключ NSApplicationCrashOnExceptions и задайте для него значение YES .
7. После завершения Xcode автоматически начнет разрешать и загружать ваши зависимости в фоновом режиме.

Далее настраиваем модуль Firebase:

1. Импортируйте модуль Firebase в структуру App или UIApplicationDelegate :

   Быстрый

   import Firebase

   Objective-C

   @import Firebase;

2. Настройте общий экземпляр FirebaseApp , обычно в методе делегата вашего приложения application(_:didFinishLaunchingWithOptions:) :

   Быстрый

   // Use the Firebase library to configure APIs.
   FirebaseApp.configure()

   Objective-C

   // Use the Firebase library to configure APIs.
   [FIRApp configure];

Шаг 2 : Настройте Xcode для автоматической загрузки файлов dSYM

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

1. Откройте рабочее пространство Xcode вашего проекта, затем выберите файл проекта в левом навигаторе.

2. В списке ЦЕЛИ выберите основную цель сборки.

3. Откройте вкладку «Параметры сборки» , затем выполните следующие шаги, чтобы Xcode создавал файлы dSYM для ваших сборок.

   1. Нажмите Все , затем выполните поиск по debug information format .

   2. Установите формат отладочной информации на DWARF with dSYM File для всех типов сборок.

4. Откройте вкладку «Фазы сборки» , затем выполните следующие шаги, чтобы Xcode мог обработать ваши dSYM-файлы и загрузить файлы.

   1. Нажмите > «Новая фаза сценария выполнения» .

      Убедитесь, что эта новая фаза запуска скрипта является последней фазой сборки вашего проекта; в противном случае Crashlytics не сможет правильно обрабатывать dSYM-файлы.

   2. Разверните новый раздел «Выполнить сценарий» .

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

   3. В поле скрипта (расположенном под меткой Shell ) добавьте следующий скрипт запуска.

      Этот скрипт обрабатывает файлы dSYM вашего проекта и загружает их в Crashlytics .

      "${BUILD_DIR%/Build/*}/SourcePackages/checkouts/firebase-ios-sdk/Crashlytics/run"

   4. В разделе «Входные файлы» добавьте пути к расположению следующих файлов:

      ${DWARF_DSYM_FOLDER_PATH}/${DWARF_DSYM_FILE_NAME}

      ${DWARF_DSYM_FOLDER_PATH}/${DWARF_DSYM_FILE_NAME}/Contents/Resources/DWARF/${PRODUCT_NAME}

      ${DWARF_DSYM_FOLDER_PATH}/${DWARF_DSYM_FILE_NAME}/Contents/Info.plist

      $(TARGET_BUILD_DIR)/$(UNLOCALIZED_RESOURCES_FOLDER_PATH)/GoogleService-Info.plist

      $(TARGET_BUILD_DIR)/$(EXECUTABLE_PATH)

      Если в настройках сборки вашего проекта есть ENABLE_USER_SCRIPT_SANDBOXING=YES и ENABLE_DEBUG_DYLIB=YES , то включите следующее:

      ${DWARF_DSYM_FOLDER_PATH}/${DWARF_DSYM_FILE_NAME}/Contents/Resources/DWARF/${PRODUCT_NAME}.debug.dylib

      Понять, зачем нужны местоположения этих файлов

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

      • Указав местоположение файлов dSYM вашего проекта, Crashlytics сможет обрабатывать файлы dSYM.
      • Указав расположение созданного вами файла GoogleService-Info.plist Crashlytics сможет связать dSYM-файлы с вашим приложением Firebase.
      • Указав расположение исполняемого файла приложения, вы сможете предотвратить дублирование загрузки одного и того же dSYM-файла. Обратите внимание, что исполняемые файлы приложения не загружаются .

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

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

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

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

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

   SwiftUI

   Button("Crash") {
     fatalError("Crash was triggered")
   }

   UIKit

   Быстрый

   import UIKit
   
   class ViewController: UIViewController {
     override func viewDidLoad() {
         super.viewDidLoad()
   
         // Do any additional setup after loading the view, typically from a nib.
   
         let button = UIButton(type: .roundedRect)
         button.frame = CGRect(x: 20, y: 50, width: 100, height: 30)
         button.setTitle("Test Crash", for: [])
         button.addTarget(self, action: #selector(self.crashButtonTapped(_:)), for: .touchUpInside)
         view.addSubview(button)
     }
   
     @IBAction func crashButtonTapped(_ sender: AnyObject) {
         let numbers = [0]
         let _ = numbers[1]
     }
   }

   Objective-C

   #import "ViewController.h"
   
   @implementation ViewController
   ‐ (void)viewDidLoad {
       [super viewDidLoad];
   
       // Do any additional setup after loading the view, typically from a nib.
   
       UIButton* button = [UIButton buttonWithType:UIButtonTypeRoundedRect];
       button.frame = CGRectMake(20, 50, 100, 30);
       [button setTitle:@"Test Crash" forState:UIControlStateNormal];
       [button addTarget:self action:@selector(crashButtonTapped:)
           forControlEvents:UIControlEventTouchUpInside];
       [self.view addSubview:button];
   }
   
   ‐ (IBAction)crashButtonTapped:(id)sender {
       @[][1];
   }
   
   @end

2. Создайте и запустите свое приложение в Xcode с отключенным отладчиком Xcode.

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

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

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

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

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

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

   3. После сбоя вашего приложения запустите его еще раз из Xcode, чтобы ваше приложение могло отправить отчет о сбое в Firebase.

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

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

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

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

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