Начните работу с Crashlytics для Android NDK

Выберите платформу: iOS+ Android Android NDK Flutter Unity


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

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

Если вы хотите узнать, как начать работу с Crashlytics в ваших проектах Unity, ознакомьтесь с руководством по началу работы с Unity .

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

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

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

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

    • При создании нового проекта Firebase включите Google Analytics в процессе создания проекта.

  3. Убедитесь, что ваше приложение соответствует следующим минимально необходимым требованиям:

    • Gradle 8.0
    • Плагин Android Gradle 8.1.0
    • Плагин Gradle для сервисов Google 4.4.1

Шаг 1 : Добавьте Crashlytics SDK для NDK в ваше приложение.

В файле Gradle вашего модуля (уровня приложения) (обычно <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:34.6.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:20.0.3")
    implementation("com.google.firebase:firebase-analytics:23.0.0")
}

Шаг 2 : Добавьте плагин Crashlytics Gradle в ваше приложение.

  1. В корневом (проектном) файле 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.4" apply false

    // Add the dependency for the Crashlytics Gradle plugin
    id("com.google.firebase.crashlytics") version "3.0.6" 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.4' apply false

    // Add the dependency for the Crashlytics Gradle plugin
    id 'com.google.firebase.crashlytics' version '3.0.6' apply false
}

  2. В файл 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 для автоматизации этого процесса.

  1. Чтобы получить доступ к задаче автоматической загрузки символов, убедитесь, что nativeSymbolUploadEnabled имеет значение true в вашем файле Gradle для модуля (на уровне приложения).

  2. Чтобы имена методов отображались в трассировках стека, необходимо явно вызывать задачу uploadCrashlyticsSymbolFile BUILD_VARIANT после каждой сборки вашей библиотеки NDK. Например:

    >./gradlew app:assembleBUILD_VARIANT\
           app:uploadCrashlyticsSymbolFileBUILD_VARIANT

  3. И SDK Crashlytics для NDK, и плагин Crashlytics для Gradle зависят от наличия идентификатора сборки GNU в собственных разделяемых объектах.

    Вы можете проверить наличие этого идентификатора, выполнив команду... readelf -n для каждого исполняемого файла. Если идентификатор сборки отсутствует, добавьте его. Добавьте флаги -Wl,--build-id в вашу систему сборки, чтобы исправить проблему.

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

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

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

    В главном окне приложения MainActivity вы можете использовать следующий код, чтобы добавить кнопку, при нажатии на которую произойдет сбой. Кнопка будет называться "Test Crash".

    Kotlin 

    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));

  2. Создайте и запустите своё приложение.

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

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

    2. В вашем приложении нажмите кнопку "Проверить на наличие ошибок", которую вы добавили, используя приведенный выше код.

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

  4. Чтобы увидеть сбой вашего теста, перейдите на панель 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 . Это позволит вам более точно сфокусировать панель мониторинга на конкретных сборках.

Поиск неисправностей

Если в консоли Firebase и в logcat отображаются разные трассировки стека, обратитесь к руководству по устранению неполадок .


Альтернативные варианты загрузки символов

Основной алгоритм работы, описанный на этой странице, применим к стандартным сборкам Gradle. Однако некоторые приложения используют другую конфигурацию или инструменты (например, процесс сборки, отличный от Gradle). В таких ситуациях для успешной загрузки символов могут быть полезны следующие параметры.

Опция : Загрузка символов для библиотечных модулей и внешних зависимостей.

Этот вариант может быть полезен в следующих ситуациях:

  • Если вы используете собственный процесс сборки NDK в Gradle.
  • Если ваши нативные библиотеки встроены в библиотечный/функциональный модуль или предоставлены сторонним разработчиком.
  • Если задача автоматической загрузки символов завершается с ошибкой или вы видите на панели управления сообщения о сбоях без символов,

Опция : Загрузка символов для сборок, не использующих Gradle, или для недоступных необработанных нативных библиотек.

Этот вариант может быть полезен в следующих ситуациях:

  • Если вы используете процесс сборки, отличный от Gradle.

  • Если ваши необработанные нативные библиотеки предоставляются вам таким образом, что они недоступны во время сборки Gradle.