Крэш-плагин

Чтобы подключить плагин:

1. Добавьте в корневой файл build.gradle зависимость:

   buildscript {
       ...
       dependencies {
           ...
           classpath 'com.yandex.android:appmetrica-build-plugin:0.7.0'
       }
    }
   Скопировано

2. Добавьте в файл app/build.gradle:

   ...
   apply plugin: 'appmetrica-plugin'
   
   appmetrica {
       postApiKey = { applicationVariant -> "Post Api key for variant" }
       // or postApiKey = "Post Api key"
       enable = { applicationVariant -> true }    // Optional.
       mappingBuildTypes = ['release']            // Optional.
       offline = false                            // Optional.
       mappingFile = { applicationVariant -> null }   // Optional.
       enableAnalytics = true                     // Optional.
       ndk {    // Optional.
           enable = { applicationVariant -> false }
           soFiles = { applicationVariant -> listOfSoFiles }             // Optional.
           additionalSoFiles = { applicationVariant -> listOfSoFiles }   // Optional.
           addNdkCrashesDependency = { applicationVariant -> true }      // Optional.
       }
   }
   ...
   Скопировано

   postApiKey *

   Post API key или лямбда-функция, которая возвращает Post API key для ApplicationVariant. Подробнее про ApplicationVariant в документации Android и Javadoc.

   Post API key можно получить в разделе Настройки в AppMetrica. Он используется для идентификации вашего приложения.

   Если offline = true , то параметр не является обязательным.

   enable

   Лямбда-функция, которая принимает ApplicationVariant и возвращает, надо ли использовать плагин для этого варианта сборки.

   Если плагин не используется, apk не меняется и mapping-файл не загружается.

   По умолчанию возвращает true только для buildType = 'release'.

   Примечание. Для указания типов сборок используйте один из параметров: enable или mappingBuildTypes.

   mappingBuildTypes

   Список типов сборок buildType, для которых будет отправляться mapping-файл.

   Значение по умолчанию: ['release'].

   Чтобы отключить загрузку mapping-файлов для определенного типа сборки, удалите из списка нужный buildType.

   Примечание. Для указания типов сборок используйте один из параметров: enable или mappingBuildTypes.

   offline

   Включает режим offline . Boolean или лямбда-функция, которая принимает ApplicationVariant.

   Допустимые значения:

   • true — не загружает файл в AppMetrica. Если включен, после сборки выводит путь до архива в лог. Его можно загрузить вручную через веб-интерфейс.
   • false — автоматически загружает mapping-файл.

   Значение по умолчанию: false.

   mappingFile

   Лямбда-функция, которая принимает ApplicationVariant и возвращает mapping, который надо загрузить. Если лямбда возвращает null, используется значение по умолчанию.

   Значение по умолчанию: ApplicationVariant.mappingFileProvider.

   enableAnalytics

   Включает отправку статистики об использовании плагина в AppMetrica. Boolean.

   Допустимые значения:

   • true — отправка статистики включена.
   • false — отправка статистики выключена.

   Значение по умолчанию: true.

   ndk

   Параметр необходим для загрузки символов из SO-файла, чтобы отслеживать нативные крэши.

   enable

   Лямбда-функция, которая принимает ApplicationVariant и возвращает, надо ли загружать символы из SO-файлов для этого варианта сборки.

   Значение по умолчанию: false.

   soFiles

   Лямбда-функция, которая принимает ApplicationVariant и возвращает список SO-файлов.

   По умолчанию плагин ищет SO-файлы в папках проекта Android Studio.

   Необходимо переопределить, если ваши SO-файлы лежат в необычном месте или если плагин не может их найти.

   additionalSoFiles

   Лямбда-функция, которая принимает ApplicationVariant и возвращает список дополнительных SO-файлов, символы которых необходимо загрузить.

   addNdkCrashesDependency

   Лямбда-функция, которая принимает ApplicationVariant и возвращает, надо ли добавлять зависимость от mobmetricalib-ndk-crashes.

   Значение по умолчанию: true.

   ^* Обязательный параметр

3. Если параметр ndk включен, то для отправки отладочных символов используется задача Gradle upload${variant.name.capitalize()}Symbols. Чтобы вызывать задачу автоматически, можно добавить в файл app/build.gradle следующий код:

   ...
   afterEvaluate {
       android.applicationVariants.forEach { variant ->
           def uploadSymbolsTask = project.tasks.named("upload${variant.name.capitalize()}Symbols")
           if (uploadSymbolsTask != null) {
               variant.assembleProvider.get()?.finalizedBy(uploadSymbolsTask) // Если используете apk
               project.tasks.named("bundle${variant.name.capitalize()}").get()?.finalizedBy(uploadSymbolsTask) // Если используете aab
           }
       }
   }
   ...
   Скопировано

Для ручной загрузки нужно подключить и использовать плагин с режимом offline. Это необходимо для связывания mapping-файла со сборкой приложения.

1. В файле app/build.gradle включите режим offline и запустите сборку.

   appmetrica {
       ...
       offline = true
   }
   Скопировано

   offline

   Включает режим offline. Допустимые значения:

   • true — не загружает mapping-файл в AppMetrica. Если включен, после сборки выводит путь до архива в лог.
   • false — автоматически загружает mapping-файл.

   Значение по умолчанию: false.

2. В интерфейсе AppMetrica перейдите в настройки приложения из меню слева.
3. Откройте вкладку Крэши → Android.
4. Нажмите кнопку Выберите файл и загрузите Zip-архив.

Возможные ошибки при сборке:

• IllegalStateException — включите обфускацию кода с помощью ProGuard или R8 Compiler;
• HttpResponseException — проверьте подключение к интернету.

При возникновении других ошибок обращайтесь в техническую поддержку.