android-debug

Crash reporting, logging and analytics utilities for android

This package makes it (hopefully) a little easier to try out the various crash report services available out there.

Step-by-step guide

• Import the code into your project

• Add lockback-android to your project: http://tony19.github.com/logback-android/

• Have your Application follow this model (where SomeReporter and SomeOtherReporter are two of the available reporters in the package):

    @ReportsCrashes( 
       formKey = "",
       resToastText = R.string.crash_toast_text,
       mode = ReportingInteractionMode.TOAST,
    )
    public class MyApp extends Application {
        static public Debug debug = new Debug( 
            new SomeReporter( "specialKey" ),
            new SomeOtherReporter( "https://my.server/", "user", "password" )
        );
        @Override
        public void onCreate() {
            super.onCreate();
            debug.onCreateApp(this);
        }
    }
  

• Each reporter requires you to create an account to the corresponding service (or host it) and may require your to download the vendor's SDK as well. See "Reporters requirements" below.

• Test the reporting by throwing an exception from somewhere in your code:

    throw new RuntimeException( "Hey, is this working?" );
  

  or try sending a handled exception to the reporter:

    // ...
    catch( Exception e )
    {
        MyApp.debug.handleException( e );
    }
  

• If all goes according to plan, the service associated with each registered reporter should have received the crash report.

• If something doesn't seem to work, check logcat.

• Don't forget to read the comments and the vendor's docs.

• You can add as many reporters as you like, except for the ACRA-based reporters (you can only have one of those). They should all work in parallel (and their exception handler should chain). If you use more than one ACRA-based reporter, they'll override each other's config and the last one will win.

• To get the most of the log reporting, use Logback's logger via Logging.getLogger instead of Android's (see the reporters' code for examples). This allows you to send your logs in the crash reports (for those that support it) by loggin into a file without having to deal with the broken logcat permission. All log calls still go into logcat as well. It's a good idea to clean up the log file every once in a while (e.g., call Logging.deleteLog when your main activity is destroyed or stopped).

Reporters requirements

• AcralyzerReporter
  • Requires hosting (e.g., IrishCouch or Cloudant)
  • Requires ACRA-4.5: https://oss.sonatype.org/content/repositories/snapshots/ch/acra/acra/4.5.0-SNAPSHOT/
  • See http://github.com/ACRA/acralyzer
• ACRAReporterReporter
  • Requires hosting on Google App Engine
  • Requires ACRA: http://acra.ch/
  • See http://code.google.com/p/acra-reporter/
• BugsenseReporter
  • Requires an account on Bugsense
  • Requires ACRA: http://acra.ch/
  • See https://www.bugsense.com/
• BugsnagReporter
  • Requires an account on Bugsnag
  • Requires the Bugsnag SDK
  • See https://bugsnag.com/
• CrittercismReporter:
  • Requires an account on Crittercism
  • Requires the Crittercism SDK
  • See https://www.crittercism.com/
• FlurryReporter:
  • Requires an account on Flurry Analytics
  • Requires the FlurryAgent SDK
  • See http://www.flurry.com/
• GoogleAnalyticsReporter:
  • Requires an account on Google Analytics
  • Requires the Google Analytics SDK v2
  • See https://developers.google.com/analytics/devguides/collection/android/v2/
• HockeyappReporter:
  • Requires an account on HockeyApp
  • Requires ACRA: http://acra.ch/
  • See http://hockeyapp.net/
• LogentriesReporter:
  • Requires an account on Logentries
  • Requires ACRA: http://acra.ch/
  • See https://logentries.com/ and http://www.vaudaux-ruth.com/android-log-collecting-with-acra-and-logentries
• SentryReporter:
  • Requires an account on Sentry
  • Requires ACRA: http://acra.ch/
  • See https://www.getsentry.com/