Если ваше приложение Android содержит собственные библиотеки , вы можете включить полную трассировку стека и подробные отчеты о сбоях для вашего собственного кода из Firebase Crashlytics внеся несколько небольших обновлений в конфигурацию сборки вашего приложения.
В этом руководстве описывается, как настроить отчеты о сбоях с помощью Firebase Crashlytics SDK для NDK.
Если вы ищете, как начать использовать Crashlytics в своих проектах Unity, ознакомьтесь с руководством по началу работы с Unity .
Прежде чем начать
Если вы еще этого не сделали, добавьте Firebase в свой проект Android. Если у вас нет приложения для Android, вы можете загрузить его образец .
Рекомендуется : чтобы автоматически получать навигационные журналы и понимать действия пользователей, приведшие к сбою, нефатальному событию или событию ANR, вам необходимо включить Google Analytics в своем проекте Firebase.
Если в вашем существующем проекте Firebase не включен Google Analytics , вы можете включить Google Analytics на вкладке «Интеграции» вашего аккаунта.
Firebase . > Настройки проекта в консолиЕсли вы создаете новый пр��ект Firebase, включите Google Analytics во время рабочего процесса создания проекта.
Убедитесь, что ваше приложение имеет следующие минимальные необходимые версии: Градл 8.0 Плагин Android Gradle 8.1.0 Плагин Gradle сервисов Google 4.4.1
Шаг 1. Добавьте Crashlytics SDK для NDK в свое приложение.
<project>/<app-module>/build.gradle.kts
или <project>/<app-module>/build.gradle
) добавьте зависимость для Crashlytics NDK. библиотека для Android. Мы рекомендуем использовать Firebase Android BoM для управления версиями библиотеки.Для оптимальной работы с Crashlytics мы рекомендуем включить Google Analytics в вашем проекте Firebase и добавить Firebase SDK для Google Analytics в ваше приложение.
dependencies { // Import the BoM for the Firebase platform implementation(platform("com.google.firebase:firebase-bom:33.3.0")) // Add the dependencies for the Crashlytics NDK and Analytics libraries // When using the BoM, you don't specify versions in Firebase library dependencies implementation("com.google.firebase:firebase-crashlytics-ndk") implementation("com.google.firebase:firebase-analytics") }
Используя Firebase Android BoM , ваше приложение всегда будет использовать совместимые версии библиотек Firebase Android.
(Альтернатива) Добавить зависимости библиотеки Firebase без использования BoM
Если вы решите не использовать Firebase BoM , вы должны указать каждую версию библиотеки Firebase в ее строке зависимости.
Обратите внимание: если вы используете в своем приложении несколько библиотек Firebase, мы настоятельно рекомендуем использовать BoM для управления версиями библиотек, что гарантирует совместимость всех версий.
dependencies { // Add the dependencies for the Crashlytics NDK and Analytics libraries // When NOT using the BoM, you must specify versions in Firebase library dependencies implementation("com.google.firebase:firebase-crashlytics-ndk:19.1.0") implementation("com.google.firebase:firebase-analytics:22.1.0") }
Шаг 2. Добавьте плагин Crashlytics Gradle в свое приложение.
В файле Gradle корневого уровня (уровня проекта) (
<project>/build.gradle.kts
или<project>/build.gradle
) добавьте плагин Crashlytics Gradle в блокplugins
:Kotlin
plugins { // Make sure that you have the AGP plugin 8.1+ dependency id("com.android.application") version "8.1.4" apply false // ... // Make sure that you have the Google services Gradle plugin 4.4.1+ dependency id("com.google.gms.google-services") version "4.4.2" apply false // Add the dependency for the Crashlytics Gradle plugin id("com.google.firebase.crashlytics") version "3.0.2" apply false }
Groovy
plugins { // Make sure that you have the AGP plugin 8.1+ dependency id 'com.android.application' version '8.1.4' apply false // ... // Make sure that you have the Google services Gradle plugin 4.4.1+ dependency id 'com.google.gms.google-services' version '4.4.2' apply false // Add the dependency for the Crashlytics Gradle plugin id 'com.google.firebase.crashlytics' version '3.0.2' apply false }
В файле Gradle вашего модуля (на уровне приложения) (обычно
<project>/<app-module>/build.gradle.kts
или<project>/<app-module>/build.gradle
) добавьте плагин Crashlytics Gradle:Kotlin
plugins { id("com.android.application") // ... // Make sure that you have the Google services Gradle plugin id("com.google.gms.google-services") // Add the Crashlytics Gradle plugin id("com.google.firebase.crashlytics") }
Groovy
plugins { id 'com.android.application' // ... // Make sure that you have the Google services Gradle plugin id 'com.google.gms.google-services' // Add the Crashlytics Gradle plugin id 'com.google.firebase.crashlytics' }
Шаг 3. Добавьте расширение Crashlytics в свою сборку.
В файле Gradle вашего модуля (на уровне приложения) (обычно <project>/<app-module>/build.gradle.kts
или <project>/<app-module>/build.gradle
) настройте расширение Crashlytics.
Kotlin
import com.google.firebase.crashlytics.buildtools.gradle.CrashlyticsExtension // ... android { // ... buildTypes { getByName("release") { // Add this extension configure<CrashlyticsExtension> { // Enable processing and uploading of native symbols to Firebase servers. // By default, this is disabled to improve build speeds. // This flag must be enabled to see properly-symbolicated native // stack traces in the Crashlytics dashboard. nativeSymbolUploadEnabled = true } } } }
Groovy
// ... android { // ... buildTypes { release { // Add this extension firebaseCrashlytics { // Enable processing and uploading of native symbols to Firebase servers. // By default, this is disabled to improve build speeds. // This flag must be enabled to see properly-symbolicated native // stack traces in the Crashlytics dashboard. nativeSymbolUploadEnabled true } } } }
Шаг 4. Настройте автоматическую загрузку собственных символов.
Чтобы создавать читаемые трассировки стека при сбоях NDK, Crashlytics необходимо знать о символах в ваших собственных двоичных файлах. Плагин Crashlytics Gradle включает задачу uploadCrashlyticsSymbolFile BUILD_VARIANT
для автоматизации этого процесса.
Чтобы вы могли получить доступ к задаче автоматической загрузки символов, убедитесь, что для
nativeSymbolUploadEnabled
установлено значениеtrue
в файле Gradle вашего модуля (на уровне приложения).Чтобы имена методов отображались в трассировках стека, вы должны явно вызывать задачу
uploadCrashlyticsSymbolFile BUILD_VARIANT
после каждой сборки вашей библиотеки NDK. Например:>./gradlew app:assembleBUILD_VARIANT\ app:uploadCrashlyticsSymbolFileBUILD_VARIANT
И Crashlytics SDK для NDK, и плагин Crashlytics Gradle зависят от наличия идентификатора сборки GNU в собственных общих объектах.
Вы можете проверить наличие этого идентификатора, запустив readelf -n
для каждого двоичного файла. Если идентификатор сборки отсутствует, добавьте-Wl,--build-id
к флагам вашей системы сборки, чтобы устранить проблему.
Шаг 5. Принудительно завершите тест для завершения настройки.
Добавьте в с��ое приложение код, который можно использовать для принудительного завершения теста. Вы можете использовать следующий код в MainActivity
вашего приложения, чтобы добавить в приложение кнопку, нажатие которой вызывает сбой. Кнопка называется «Тестовый сбой».Kotlin+KTX val crashButton = Button(this) crashButton.text = "Test Crash" crashButton.setOnClickListener { throw RuntimeException("Test Crash") // Force a crash } addContentView(crashButton, ViewGroup.LayoutParams( ViewGroup.LayoutParams.MATCH_PARENT, ViewGroup.LayoutParams.WRAP_CONTENT))
Java Button crashButton = new Button(this); crashButton.setText("Test Crash"); crashButton.setOnClickListener(new View.OnClickListener() { public void onClick(View view) { throw new RuntimeException("Test Crash"); // Force a crash } }); addContentView(crashButton, new ViewGroup.LayoutParams( ViewGroup.LayoutParams.MATCH_PARENT, ViewGroup.LayoutParams.WRAP_CONTENT));
Создайте и запустите свое приложение. Принудительно завершить тест, чтобы отправить первый отчет о сбое вашего приложения: Откройте приложение на тестовом устройстве или в эмуляторе. В своем приложении нажмите кнопку «Тестировать сбой», которую вы добавили с помощью приведенного выше кода. После сбоя вашего приложения перезапустите его, чтобы ваше приложение могло отправить отчет о сбое в Firebase.
Перейдите на панель управления Crashlytics консоли Firebase , чтобы увидеть сбой вашего теста. Если вы обновили консоль и по-прежнему не видите сбой теста через пять минут, включите ведение журнала отладки , чтобы узнать, отправляет ли ваше приложение отчеты о сбоях.
И все! Crashlytics теперь отслеживает ваше приложение на предмет сбоев, и вы можете просматривать и исследовать отчеты о сбоях и статистику на панели управления Crashlytics .
Следующие шаги
(Рекомендуется) Получите помощь в устранении сбоев, вызванных ошибками собственной памяти, собрав отчеты GWP-ASan . Эти ошибки, связанные с памятью, могут быть связаны с повреждением памяти в вашем приложении, что является основной причиной уязвимостей безопасности приложений. Чтобы воспользоваться этой функцией отладки, убедитесь, что в вашем приложении явно включен GWP-ASan и используется последняя версия Crashlytics SDK для NDK (v18.3.6+ или Firebase BoM v31.3.0+). Настройте настройку отчета о сбоях , добавив дополнительные отчеты, журналы, ключи и отслеживание нефатальных ошибок. Интегрируйтесь с Google Play , чтобы вы могли фильтровать отчеты о сбоях вашего приложения Android по трекам Google Play прямо на панели управления Crashlytics . Это позволяет вам лучше сосредоточить панель управления на конкретных сборках.
Поиск неисправностей
Альтернативные варианты загрузки символов
Опция : загрузить символы для библиотечных модулей и внешних зависимостей.
Если вы используете настраиваемый процесс сборки NDK в Gradle Если ваши собственные библиотеки встроены в библиотечный/функциональный модуль или предоставлены сторонними Если задача автоматической загрузки символов не удалась или вы видите бессимволические сбои на панели управления.
Вариант : загрузить символы для сборок, отличных от Gradle, или недоступных нераспакованных собственных библиотек.
Если вы используете процесс сборки, отличный от Gradle Если ваши не��аспакованные собственные библиотеки предоставляются вам таким образом, что они недоступны во время сборок Gradle