Crash plugin

To enable the plugin:

1. Add the following dependency to the build.gradle root file:

   buildscript {
       ...
       dependencies {
           ...
           classpath 'com.yandex.android:appmetrica-build-plugin:0.7.0'
       }
    }
   Copied to clipboard

2. Add to the app/build.gradle file:

   ...
   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.
       }
   }
   ...
   Copied to clipboard

   postApiKey *

   Post API key or lambda function that returns a Post API key for ApplicationVariant. Read more about ApplicationVariant in the Android and Javadoc documentation.

   You can get the Post API key in the AppMetrica Settings. It's used to identify your app.

   If offline = true, the parameter is optional.

   enable

   Lambda function that accepts ApplicationVariant and returns whether to use the plugin for this build option.

   If the plugin isn't used, the apk doesn't change and the mapping file doesn't load.

   By default, it returns true only for buildType = 'release'.

   Note. Use one of the parameters to specify assembly types: enable or mappingBuildTypes.

   mappingBuildTypes

   The list of build types, buildType, for which the mapping file will be sent.

   Default value: ['release'].

   To disable the uploading of mapping files for a specific type of build, delete that buildType from the list.

   Note. Use one of the parameters to specify assembly types: enable or mappingBuildTypes.

   offline

   Enables the offline mode. Boolean or a lambda function that accepts ApplicationVariant.

   Acceptable values:

   • true — Doesn't upload a file to AppMetrica. If enabled, it outputs the archive path to the log after the build is complete. You can upload it manually via the web interface.
   • false — Automatically uploads the mapping file.

   The default value is false.

   mappingFile

   A lambda function that accepts ApplicationVariant and returns the mapping file to upload. If it returns null, the default value is used.

   The default value is ApplicationVariant.mappingFileProvider.

   enableAnalytics

   Enables sending plugin usage statistics to AppMetrica. Boolean.

   Acceptable values:

   • true — Sending statistics is enabled.
   • false — Sending statistics is disabled.

   The default value is true.

   ndk

   This parameter is required for loading characters from the SO file to track native crashes.

   enable

   Lambda function that accepts ApplicationVariant and returns whether to load the characters from the SO files for this build option.

   The default value is false.

   soFiles

   Lambda function that accepts ApplicationVariant and returns a list of SO files.

   By default, the plugin searches for SO files in the Android Studio project folders.

   You need to redefine the path if your SO files are in an unusual location or the plugin can't find them.

   additionalSoFiles

   Lambda function that accepts ApplicationVariant and returns a list of additional SO files to load the characters from.

   addNdkCrashesDependency

   Lambda function that accepts ApplicationVariant and returns whether to add a dependency on mobmetricalib-ndk-crashes.

   The default value is true.

   ^* Required

3. If the ndk parameter is enabled, debug symbols are sent using the Gradle task upload${variant.name.capitalize()}Symbols. To call a task automatically, you can add it to a file app/build.gradle the following code:

   ...
   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
           }
       }
   }
   ...
   Copied to clipboard

To manually load, enable and use the plugin in offline mode. This is necessary to link the mapping file to the app build.

1. In the app/build.gradle file, enable offline mode and run the build.

   appmetrica {
       ...
       offline = true
   }
   Copied to clipboard

   offline

   Enables offline mode. Acceptable values:

   • true — Doesn't upload the mapping file to AppMetrica. If enabled, it outputs the archive path to the log after the build is complete.
   • false — Automatically uploads the mapping file.

   The default value is false.

2. In the AppMetrica interface, go to the app settings from the menu on the left.
3. Open Crashes → Android.
4. Click Choose file and upload the ZIP archive.

Possible errors during a build:

• IllegalStateException — Enable code obfuscation using ProGuard or R8 Compiler.
• HttpResponseException — Check your internet connection.

If you encounter further errors, please contact technical support.