Setup

This Tutorial will show you how to set up ACRA and guide you through your initial configuration choices.

Prerequisites

This guide assumes you are using com.android.tools.build:gradle:4.0.0 or later.

Acra requires java 8 (native, not RetroLambda or similar):

Kotlin

build.gradle.kts

android {
    compileOptions {
        sourceCompatibility = JavaVersion.VERSION_1_8
        targetCompatibility = JavaVersion.VERSION_1_8
    }
}

Groovy

build.gradle

android {
    compileOptions {
        sourceCompatibility JavaVersion.VERSION_1_8
        targetCompatibility JavaVersion.VERSION_1_8
    }
}

Dependencies

Everything you find in this section belongs into the dependencies block:

Kotlin

build.gradle.kts

dependencies {
    //here
}

Groovy

build.gradle

dependencies {
    //here
}

Define ACRA Version

Add the following snippet (with the latest version)

Kotlin

val acraVersion = "<latest version>"

Groovy

def acraVersion = '<latest version>'

Choose sender

• Http:

Kotlin

implementation("ch.acra:acra-http:$acraVersion")

Groovy

implementation "ch.acra:acra-http:$acraVersion"

• Email:

Kotlin

implementation("ch.acra:acra-mail:$acraVersion")

Groovy

implementation "ch.acra:acra-mail:$acraVersion"

• Custom:

Kotlin

implementation("ch.acra:acra-core:$acraVersion")

Groovy

implementation "ch.acra:acra-core:$acraVersion"

More info: Senders

Choose interaction

• Dialog:

Kotlin

implementation("ch.acra:acra-dialog:$acraVersion")

Groovy

implementation "ch.acra:acra-dialog:$acraVersion"

• Notification:

Kotlin

implementation("ch.acra:acra-notification:$acraVersion")

Groovy

implementation "ch.acra:acra-notification:$acraVersion"

• Toast:

Kotlin

implementation("ch.acra:acra-toast:$acraVersion")

Groovy

implementation "ch.acra:acra-toast:$acraVersion"

• Silent:

Add nothing.

More info: Interactions

Optional Plugins

• Limiter:

Limits how many reports acra sends from one device

Kotlin

implementation("ch.acra:acra-limiter:$acraVersion")

Groovy

implementation "ch.acra:acra-limiter:$acraVersion"

• Advanced Scheduler: [since 5.2.0-rc1]

Controls when reports are sent (e.g. only on wifi) and can restart an application after a crash

Kotlin

implementation("ch.acra:acra-advanced-scheduler:$acraVersion")

Groovy

implementation "ch.acra:acra-advanced-scheduler:$acraVersion"

Configuration

If you don't already have an Application class, create one.

Creating an Application class

• Create a new class in your package root.
• Give it a name like: MyApplication extending from android.app.Application (or another subclass of that)
• Update the application element in your AndroidManifest.xml to reference the new class.

ACRA is configured inside your Application class:

Kotlin

class MyApplication : Application() {
  override fun attachBaseContext(base:Context) {
    super.attachBaseContext(base)

    initAcra {
        //core configuration:
        buildConfigClass = BuildConfig::class.java
        reportFormat = StringFormat.JSON
        //each plugin you chose above can be configured in a block like this:
        toast {
            text = getString(R.string.acra_toast_text)
            //opening this block automatically enables the plugin.
        }
    }
  }
}

Java

public class MyApplication extends Application {
    @Override
    protected void attachBaseContext(Context base) {
        super.attachBaseContext(base);

        ACRA.init(this, new CoreConfigurationBuilder()
                //core configuration:
                .withBuildConfigClass(BuildConfig.class)
                .withReportFormat(StringFormat.JSON)
                .withPluginConfigurations(
                    //each plugin you chose above can be configured with its builder like this:
                    new ToastConfigurationBuilder()
                        .withText(getString(R.string.acra_toast_text))
                        .build()
                )
            );
    }
}

Full configuration options documentation:

• Core
• HttpSender
• MailSender
• Dialog
• Notification
• Toast
• Limiter
• Scheduler

See also: Interactions, Senders