В этом кратком руководстве описывается, как настроить 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 Apple Platforms SDK:
- Выберите библиотеку Crashlytics .
- Чтобы воспользоваться журналами навигации , добавьте в приложение Firebase SDK для Google Analytics . Убедитесь, что Google Analytics включен в вашем проекте Firebase.
- Добавьте флаг
-ObjC
в раздел «Другие флаги компоновщика» настроек сборки вашей целевой системы. - (только для macOS) В файле
Info.plist
добавьте ключNSApplicationCrashOnExceptions
и задайте для него значениеYES
. - После завершения Xcode автоматически начнет разрешать и загружать ваши зависимости в фоновом режиме.
https://github.com/firebase/firebase-ios-sdk.git
Далее настраиваем модуль Firebase:
Импортируйте модуль Firebase в структуру
App
илиUIApplicationDelegate
:Быстрый
import Firebase
Objective-C
@import Firebase;
Настройте общий экземпляр
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-файлов, их обработки и загрузки при каждой сборке приложения.
Откройте рабочее пространство Xcode вашего проекта, затем выберите файл проекта в левом навигаторе.
В списке ЦЕЛИ выберите основную цель сборки.
Откройте вкладку «Параметры сборки» , затем выполните следующие шаги, чтобы Xcode создавал файлы dSYM для ваших сборок.
Нажмите Все , затем выполните поиск по
debug information format
.Установите формат отладочной информации на
DWARF with dSYM File
для всех типов сборок.
Откройте вкладку «Фазы сборки» , затем выполните следующие шаги, чтобы Xcode мог обработать ваши dSYM-файлы и загрузить файлы.
Нажмите
> «Новая фаза сценария выполнения» .Убедитесь, что эта новая фаза запуска скрипта является последней фазой сборки вашего проекта; в противном случае Crashlytics не сможет правильно обрабатывать dSYM-файлы.
Разверните новый раздел «Выполнить сценарий» .
В поле скрипта (расположенном под меткой Shell ) добавьте следующий скрипт запуска.
Этот скрипт обрабатывает файлы dSYM вашего проекта и загружает их в Crashlytics .
"${BUILD_DIR%/Build/*}/SourcePackages/checkouts/firebase-ios-sdk/Crashlytics/run"
В разделе «Входные файлы» добавьте пути к расположению следующих файлов:
${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
Более подробную информацию о файлах 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] } }
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
Создайте и запустите свое приложение в Xcode с отключенным отладчиком Xcode.
Нажмите
Build, а затем запустите текущую схему , чтобы создать приложение на тестовом устройстве или симуляторе.Подождите, пока ваше приложение запустится, затем нажмите « Crashlytics .
Остановить выполнение схемы или действия , чтобы закрыть первоначальный экземпляр вашего приложения. Этот первоначальный экземпляр включал отладчик, мешающий работе
Принудительно завершить тест, чтобы отправить первый отчет о сбое вашего приложения:
Откройте приложение с главного экрана тестового устройства или симулятора.
В своем приложении нажмите кнопку «Тестировать сбой», которую вы добавили с помощью приведенного выше кода.
После сбоя вашего приложения запустите его еще раз из Xcode, чтобы ваше приложение могло отправить отчет о сбое в Firebase.
Перейдите на панель управления Crashlytics консоли Firebase , чтобы увидеть сбой вашего теста.
Если вы обновили консоль и по-прежнему не видите сбой теста через пять минут, включите ведение журнала отладки, чтобы узнать, отправляет ли ваше приложение отчеты о сбоях.
И все! Crashlytics теперь отслеживает ваше приложение на предмет сбоев. Посетите панель управления Crashlytics , чтобы просмотреть и изучить все ваши отчеты и статистику.
Следующие шаги
- Настройте настройку отчета о сбоях, добавив дополнительные отчеты, журналы, ключи и отслеживание нефатальных ошибок.