Size Analysis

Size Analysis helps monitor your mobile app's size in pre-production to prevent unexpected size increases (regressions) from reaching users. Aside from being courteous to your users, a smaller app size helps boost installation and retention rates, especially for customers with limited storage or slower connections.

Getting Started

Accepted Formats: AAB (preferred) | APK

Upload Mechanisms: Gradle | Sentry CLI

Uploading With Gradle

The Gradle plugin automatically detects build metadata from your git repository. On GitHub Actions, all metadata is automatically detected. On other CI systems, you may need to manually set some values using the vcsInfo extension.

1. Configure the Sentry Android Gradle plugin with at least version 6.0.0-beta1

2. Set the auth token as an environment variable to be used when running your release build.

   Copied

   export SENTRY_AUTH_TOKEN=___ORG_AUTH_TOKEN___

3. Enable uploading for size analysis for CI builds.

   KotlinGroovy

   build.gradle.kts

   Copied

   sentry {
     sizeAnalysis {
       enabled = providers.environmentVariable("GITHUB_ACTIONS").isPresent
     }
   }

4. Invoke the following Gradle tasks to build your app and trigger the upload.

   AabApk

   aab

   Copied

   ./gradlew bundleRelease

5. After an upload has successfully processed, confirm the metadata is correct in the Sentry UI

   

Overriding Metadata

The Gradle plugin automatically detects build metadata from your git repository. On GitHub Actions, all metadata is automatically detected. On other CI systems, you may need to manually set some values using the vcsInfo extension.

Configure overrides in your Gradle build configuration:

sentry {
  sizeAnalysis {
    enabled = providers.environmentVariable("GITHUB_ACTIONS").isPresent
  }

  vcsInfo {
    headSha.set("abc123")
    baseSha.set("def456")
    vcsProvider.set("github")
    headRepoName.set("organization/repository")
    baseRepoName.set("organization/repository")
    headRef.set("feature-branch")
    baseRef.set("main")
    prNumber.set(42)
  }
}

Available vcsInfo properties:

Uploading With the Sentry CLI

1. Install the sentry-cli (version 2.58.3)

   We recommend using the latest version for the best possible experience, but at a minimum version 2.58.2 is required.

2. Authenticate the Sentry CLI by following these steps

3. Build your app to create an AAB (preferred) or APK

4. Invoke the following CLI command to trigger the upload:

   Bash

   Copied

   sentry-cli build upload app.aab \
     --org your-org \
     --project your-project \
     --build-configuration Release
   

5. After an upload has successfully processed, confirm the metadata is correct in the Sentry UI

   

Upload Metadata

We use build metadata to organize builds in the UI and ensure correct comparisons.

* required field

Build Configuration

Build configuration metadata keeps comparisons scoped to like-for-like builds. For example, on a PR status check, the comparison will only be made for builds with the same build configuration.

The Android Gradle plugin sends the build variant (for example, freeDebug or paidRelease).

What's Next?

We strongly recommend integrating Size Analysis into your CI pipeline. Follow our guide on getting set up in CI.