Skip to content

Latest commit

 

History

History
executable file
·
74 lines (52 loc) · 1.9 KB

README.md

File metadata and controls

executable file
·
74 lines (52 loc) · 1.9 KB
Raw

Airbrake Notifer for Android

Overview

The Airbrake notifier for Android is designed to give you instant notification of any uncaught exceptions thrown from your Android applications.

Building from Source

To build a .jar file from source, make a clone of the airbrake-android github repository and run:

ant package

This will generate a file named build/airbrake-android-<version>.jar.

Installation & Setup

Copy the .jar file to your Android app's libs/ folder.

Import the AirbrakeNotifier class in your app's main Activity.

import com.loopj.android.airbrake.AirbrakeNotifier;

In your activity's onCreate function, register to begin capturing exceptions:

AirbrakeNotifier.register(this, "your-api-key-goes-here");

Configuration

The AirbrakeNotifier.register call requires a context and Airbrake API key to be passed in, and optionally a third argument specifying the environment. The environment defaults to production if not set.

To notify Airbrake of non-fatal exceptions, or exceptions you have explicitly caught in your app, you can call AirbrakeNotifier.notify. This call takes exactly one argument, a Throwable, and can be called from anywhere in your code. For example:

try {
    // Something dangerous
} catch(Exception e) {
    // We don't want this to crash our app, but we would like to be notified
    AirbrakeNotifier.notify(e);
}

License

The Airbrake notifier for Android is released under the Android-friendly Apache License, Version 2.0. Read the full license here:

http://www.apache.org/licenses/LICENSE-2.0

Contributions

This libary was built by James Smith http://loopj.com/. Since it's no longer being maintianed this is the offical Airbrake fork.

Thanks to James for his contributions.

http://www.apache.org/licenses/LICENSE-2.0