To integrate Android Error-Reporter just follow four simple steps:

1. Download android-error-reporter.jar and add it to your build path

2. Inherit from one of the base classes Reporting* (e.g. ReportingActivity, ReportingService or ReportingIntentService) or register your context in every onCreate() of your activity or context, e.g.:

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        ExceptionReporter reporter = ExceptionReporter.register(this);
        super.onCreate(savedInstanceState);
    }
   

3. Add the ExceptionReportService to your AndroidManifest.xml (within the <application/> node):

    <service
    	android:name="de.quist.app.errorreporter.ExceptionReportService"
    	android:process=":exceptionReporter"/>
   

4. Configure the target URL where to send the errors by adding the following line to your AndroidManifest.xml (within the <application/> node):

    <meta-data
    	android:name="de.quist.app.errorreporter.targetUrl"
    	android:value="http://foo.bar/error.php" />
   

Unhandled exceptions are automatically handled by the ExceptionReportService. You can also report catched exceptions by calling exceptionHandler.reportException(thread, e) or exceptionHandler.reportException(thread, e, extraMessage) on the ExceptionReporter object returned by ExceptionReporter.register(context). If your activity/service inherits from one of the supplied base classes (de.quist.app.errorreporter.Reporting*), you can access the ExceptionReporter via getExceptionReporter().

By default errors are sent to the server automatically without asking the user for permission. This can be changed by adding the ExceptionReportActivity to your AndroidManifest.xml. To do so, add the following line:

<activity
	android:name="de.quist.app.errorreporter.ExceptionReportActivity"
	android:process=":exceptionReporter"
	android:theme="@android:style/Theme.NoDisplay"/>		

The exception reporter will automatically detect the defined activity and instead of automatically sending the report a notification is created which will ask the user for permission to send the notification when clicked. You have full control over the texts and icons of both, the notification and the report-dialog. All resources can be specified by adding meta-data tags to your AndroidManifest.xml (within the <application/> node) which reference to a string/drawable in their android:resource-attribute, e.g.:

<meta-data
	android:name="de.quist.app.errorreporter.dialogMessageHint"
	android:resource="@string/error_reporting_message_hint"/>

See attributes de.quist.app.errorreporter.dialog* and de.quist.app.errorreporter.notification* in the section Configuration for more information abouth how to control the notification and dialog.

The ExceptionReportService tries to send the error to the URL specified in your AndroidManifest.xml. If it fails it retries with an exponential back-off. The default configuration will increase the back-off up to 2^12 sec (about 1h8m) and will retry it 17 times until it gives up (this will result in a total time span of 1s+2s+4s+8s+...2^12 s*5=8h). You can change these values by adding specific meta-data nodes to your AndroidManifest.xml (see Configuration)

You can add the following name/value pairs as a meta-data node to your AndroidManifest.xml (within the <application/> node).

All names need to have de.quist.app.errorreporter. as a prefix!!!:

The server will receive error reports via HTTP-post requests. They will contain the following fields: