Obfuscation Mappings

FastStats resolves obfuscated Java stack traces using uploaded ProGuard/R8 mapping files. The recommended workflow is the dev.faststats.proguard-mappings-upload Gradle plugin.

InstallationCopy Anchor Link

Copy Text
plugins {
  id("dev.faststats.proguard-mappings-upload") version "0.1.4"
}

ConfigurationCopy Anchor Link

Android ProjectsCopy Anchor Link

The plugin automatically detects Android R8/ProGuard mapping file outputs when the Android Gradle Plugin is present. No additional configuration is needed beyond the auth token:

Copy Text
mappingsUpload {
  authToken.set("your-auth-token")
}

Custom ProGuard TaskCopy Anchor Link

If you’re using a standalone ProGuard task, point the plugin to your mapping file and task:

Copy Text
mappingsUpload {
  authToken.set("your-auth-token")
  proguardTask.set(tasks.getByName("proguard"))
  mappingFiles.from(layout.buildDirectory.file("proguard/mapping.txt"))
}

Setting proguardTask ensures the upload task runs after ProGuard finishes. mappingFiles must match the location configured in your printmapping setting.

Upload AuthenticationCopy Anchor Link

Generate an API key in your FastStats project settings. The plugin accepts it via the authToken option or the FASTSTATS_AUTH_TOKEN environment variable.

All OptionsCopy Anchor Link

UsageCopy Anchor Link

Run the upload task directly:

Copy Text
./gradlew uploadProguardMappings

Or chain it after your obfuscation task:

Copy Text
./gradlew proguard uploadProguardMappings

CI ConfigurationCopy Anchor Link

GitHub ActionsCopy Anchor Link

Copy Text
name: Build & Upload Mappings

on:
  push:
    branches: [main]

jobs:
  build:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4

      - uses: actions/setup-java@v4
        with:
          distribution: temurin
          java-version: 17

      - name: Build & Upload
        run: ./gradlew proguard uploadProguardMappings
        env:
          FASTSTATS_AUTH_TOKEN: ${{ secrets.FASTSTATS_AUTH_TOKEN }}

GitLab CICopy Anchor Link

Copy Text
build:
  stage: build
  script:
    - ./gradlew proguard uploadProguardMappings
  variables:
    FASTSTATS_AUTH_TOKEN: $FASTSTATS_AUTH_TOKEN

How It WorksCopy Anchor Link

1. The plugin collects mapping files added via mappingFiles.from(...), or auto-detected Android build outputs.
2. If proguardTask is set, the upload task automatically depends on it.
3. project.version is used as the buildId by default.
4. Each mapping file is split by class sections and uploaded in batches of up to 50 MB, ensuring no class mapping is split across batches.

RequirementsCopy Anchor Link