nshmura / strictmode-notifier

Improving StrictMode's report on Android.

strictmode-notifier

An Android library that improves the StrictMode reporting.

• Head-up Notification of StrictMode violations.
• Ignoring Specific Violations
• Custom Actions that called when StrictMode violations is happened.
• Violation History Viewer that automatically installed.
  

Screenshots

Sample App

strictmode-notifier/testapp

About StrictMode

• StrictMode for Runtime Analysis on Android
• StrictMode for enforcing best practices at runtime

Getting started

In your build.gradle:

 repositories {
    jcenter()
 }

 dependencies {
    debugCompile 'com.nshmura:strictmode-notifier:0.9.3'
    releaseCompile 'com.nshmura:strictmode-notifier-no-op:0.9.3'
 }

In your Application class:

public class ExampleApplication extends Application {

  @Override public void onCreate() {
    super.onCreate();
    
    if (BuildConfig.DEBUG) {
      //setup this library
      StrictModeNotifier.install(this);

      //setup StrictMode.
      // 
      // penaltyLog() should be called for strictmode-notifier
      //
      new Handler().post(new Runnable() {
        @Override public void run() {
          StrictMode.ThreadPolicy threadPolicy = new StrictMode.ThreadPolicy.Builder()
              .detectAll()
              .permitDiskReads()
              .permitDiskWrites()
              .penaltyLog() // Must!
              .build();
          StrictMode.setThreadPolicy(threadPolicy);

          StrictMode.VmPolicy vmPolicy = new StrictMode.VmPolicy.Builder()
              .detectAll()
              .penaltyLog() // Must!
              .build();
          StrictMode.setVmPolicy(vmPolicy);
        }
      });
    }
  }
}

How does it work?

1. strictmode-notifier starts logcat command in backgound thread, and infinitely reads the log from logcat.
2. If StrictMode violation is happened, error logs is outputed.
3. strictmode-notifier reads that log via logcat, and shows a notification of the violation.

Customizing

How to ignore specific violations

StrictModeNotifier
    .install(context)
    .setIgnoreAction(new IgnoreAction() {
      @Override public boolean ignore(StrictModeViolation violation) {
        // ex) ignore LEAKED_CLOSABLE_OBJECTS that contains android.foo.bar in stacktrace.
        return violation.violationType == ViolationType.LEAKED_CLOSABLE_OBJECTS
            && violation.getStacktraceText().contains("android.foo.bar");
      }
    });

How to add custom actions

StrictModeNotifier
    .install(context)
    .addCustomAction(new CustomAction() {
      @Override public void onViolation(StrictModeViolation violation) {
        //ex) Send messages into Slack
      }
    });

How to disable Headup Notification

StrictModeNotifier
    .install(context)
    .setHeadupEnabled(false);

How to enable debug mode of strictmode-notifier

StrictModeNotifier
    .install(context)
    .setDebugMode(true);

Todo

Parsing following violations

• ActivityLeaks
• LeakedRegistrationObjects
• LeakedSqlLiteObjects

Thanks

Inspired by square/leakcanary

License

Copyright (C) 2016 nshmura

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

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

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.