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

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

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

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

Если вы еще этого не сделали, добавьте Firebase в свой проект Apple. Если у вас нет приложения Apple, вы можете загрузить образец приложения .
Рекомендуется : чтобы автоматически получать навигационные журналы и понимать действия пользователей, приведшие к сбою, нефатальному событию или событию ANR, вам необходимо включить Google Analytics в своем проекте Firebase.
- Если в вашем существующем проекте Firebase не включен Google Analytics , вы можете включить Google Analytics на вкладке «Интеграции» вашего аккаунта. > Настройки проекта в консоли Firebase .
- Если вы создаете новый проект Firebase, включите Google Analytics во время рабочего процесса создания проекта.
Обратите внимание, что навигационные журналы доступны для всех платформ Apple, поддерживаемых Crashlytics , кроме watchOS.

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

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

В Xcode, открыв проект приложения, выберите «Файл» > «Добавить пакеты» .
При появлении запроса добавьте репозиторий Firebase SDK для платформ Apple:

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

Выберите библиотеку Crashlytics .

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

Добавьте флаг -ObjC в раздел «Другие флаги компоновщика» настроек сборки вашей цели.

(только для macOS) В Info.plist добавьте ключ NSApplicationCrashOnExceptions и установите для него значение YES .

По завершении Xcode автоматически начнет разрешать и загружать ваши зависимости в фоновом режиме.

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

Импортируйте модуль Firebase в структуру вашего App или UIApplicationDelegate :
Быстрый
import Firebase
Цель-C
@import Firebase;
Настройте общий экземпляр FirebaseApp , обычно в методе application(_:didFinishLaunchingWithOptions:) делегата вашего приложения:
Быстрый
// Use the Firebase library to configure APIs. FirebaseApp.configure()
Цель-C
// Use the Firebase library to configure APIs. [FIRApp configure];

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

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

Откройте рабочую область Xcode вашего проекта, затем выберите файл проекта в левом навигаторе.
В списке ЦЕЛИ выберите основную цель сборки.
Перейдите на вкладку «Настройки сборки» , затем выполните следующие шаги, чтобы Xcode создавал dSYM для ваших сборок.
1. Нажмите «Все» , затем найдите debug information format .
2. Установите формат отладочной информации DWARF with dSYM File для всех типов сборок.
Перейдите на вкладку «Фазы сборки» , затем выполните следующие шаги, чтобы 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 , необходимо принудительно завершить тест.

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

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

SwiftUI

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

УИКит

Быстрый

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]
  }
}

Цель-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

Создайте и запустите свое приложение в Xcode с отключенным отладчиком Xcode.
Отладчик Xcode предотвращает отправку отчетов о сбоях в Crashlytics . Выполните следующие шаги, чтобы отключить тестовое устройство или симулятор от отладчика Xcode перед принудительным сбоем.
1. Нажмите Build, а затем запустите текущую схему , чтобы создать приложение на тестовом устройстве или симуляторе.
2. Подождите, пока ваше приложение запустится, затем нажмите « Остановить выполнение схемы или действия, чтобы закрыть первоначальный экземпляр вашего приложения. Этот первоначальный экземпляр включал отладчик, который мешает Crashlytics .
Принудительно завершить тест, чтобы отправить первый отчет о сбое вашего приложения:
1. Откройте приложение с главного экрана тестового устройства или симулятора.
2. В своем приложении нажмите кнопку «Тестировать сбой», которую вы добавили с помощью приведенного выше кода.
3. После сбоя вашего приложения запустите его еще раз из Xcode, чтобы ваше приложение могло отправить отчет о сбое в Firebase.
Перейдите на панель управления Crashlytics консоли Firebase , чтобы увидеть сбой вашего теста.
Если вы обновили консоль и по-прежнему не видите сбой теста через пять минут, включите ведение журнала отладки, чтобы узнать, отправляет ли ваше приложение отчеты о сбоях.

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

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

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