Skip to main content

Bugsee Gradle Plugin

Previous version

This page documents Bugsee Android SDK 6.x, the previous major version. The current line is 7.x — see Migrating from 6.x to 7.x to upgrade, or Installation to start a new integration.

This page documents the 3.x Gradle plugin, the line that matches SDK 6.x. If you are on SDK 7.x, see the current Gradle plugin reference instead.

The 3.x Bugsee Gradle Plugin integrates into your Android build to provide:

  • Mapping file upload — uploads ProGuard/R8 mapping files to Bugsee for crash symbolication.
  • NDK symbol upload — uploads native debug symbols for native crash symbolication.
  • Manifest injection — injects a per-build BUILD_UUID meta-data entry into the merged manifest for build correlation.

You can find the plugin in the Maven repository.

Installation

Add the plugin to your app module:

app/build.gradle.kts
plugins {
id("com.android.application")
id("com.bugsee.android.gradle") version "<version>"
}

Or using the legacy buildscript classpath:

build.gradle.kts (root)
buildscript {
dependencies {
classpath("com.bugsee:bugsee-android-gradle-plugin:<version>")
}
}
app/build.gradle.kts
plugins {
id("com.android.application")
id("com.bugsee.android.gradle")
}

Configuration

app/build.gradle.kts
bugsee {
appToken("<your-app-token>")
endpoint = "https://api.bugsee.com" // custom endpoint (optional)
debug = false // enable plugin debug logging
ndk(true) // upload NDK debug symbols
}
note

No bytecode instrumentation in 3.x. Build-time bytecode instrumentation (Logcat, OkHttp, HttpEngine, thread registration, operation dispatch, main-thread misuse, Compose touch input), the Bugsee Kotlin compiler plugin (Compose tag injection and Modifier.bugseeSecure() auto-insertion), and auto-install of the bugsee-android-* extension modules were all introduced in the 4.x plugin, which requires SDK 7.x. The 3.x plugin does not transform your classes at all. See Gradle plugin — Instrumentation and Gradle plugin — Auto-load & extensions for those features.

On SDK 6.x, HTTP clients other than HttpURLConnection/HttpsURLConnection are wired up manually in your own code — see network events.

Build tasks

The plugin registers per-variant tasks on application variants. The manifest and mapping tasks are only created for variants that produce a mapping file; the native task is only created when ndk(true) is set:

TaskDescription
createBugseeAppVar<Variant>ProguardConfigInjects the BUILD_UUID meta-data entry into the merged manifest.
uploadBugseeAppVar<Variant>MappingUploads the ProGuard/R8 mapping file.
uploadBugseeAppVar<Variant>NativeUploads NDK debug symbols (when ndk(true) is set).

For Android feature variants the same tasks are registered with a FeatVar infix instead of AppVar (for example uploadBugseeFeatVar<Variant>Mapping).

Compatibility

Plugin versionSDK versionMin AGPMin Gradle
4.x7.x8.6.08.7+
3.x6.x4.2.27.0+

The Min AGP column is the plugin's own requirement. The 3.x plugin is built against the Android Gradle Plugin 4.2.2 API and uses only the older applicationVariants / processManifestProvider / mappingFileProvider APIs, so 4.2.2 is its floor — it also runs fine on AGP 8.x (SDK 6.0.0 is itself built with plugin 3.6 on AGP 8.6.0).

The SDK has a separate, higher requirement: SDK 6.0.0 is built with compileSdk 35 and needs AGP 8.6.0 or newer. Your project's effective minimum is therefore AGP 8.6.0 — see the SDK 6.x release notes.

caution

Plugin 4.x is not backward-compatible with SDK 6.x. The auto-install and instrumentation gating use the new bugsee-android-* artifact names introduced in SDK 7.x.

Release history

See Gradle plugin releases for the full changelog.

Found an issue, typo, or wrong statement on this page? Report it now →