Stetho is a debug bridge for Android applications, enabling the powerful Chrome Developer Tools and much more.
Java JavaScript Other
Latest commit bd3c6d3 Dec 15, 2016 @longinoa longinoa committed on GitHub Update to 1.4.3-SNAPSHOT (#473)
Permalink
Failed to load latest commit information.
.idea Android Studio 2.2 preview 2 random scribbles Jun 1, 2016
build-tools Added a script for generating types and methods defined in protocol.j… Aug 7, 2015
docs/images Initial commit Jan 29, 2015
gradle/wrapper Update Gradle wrapper to 2.14.1 Jul 31, 2016
scripts stetho_open.py should respect ANDROID_ADB_SERVER_PORT (#456) Nov 18, 2016
stetho-js-rhino Bump to version 1.4.2 Dec 15, 2016
stetho-okhttp Update build tools to 24.0.2 Sep 3, 2016
stetho-okhttp3 Update Okhttp3 to 3.4.2 Nov 8, 2016
stetho-sample Update build tools to 24.0.2 Sep 3, 2016
stetho-timber Merge pull request #396 from mmirhoseini/master Sep 6, 2016
stetho-urlconnection Update build tools to 24.0.2 Sep 3, 2016
stetho Fix extranneous boxing and also correctly check return value of binar… Dec 13, 2016
.gitignore Initial commit Jan 29, 2015
.travis.yml Update build tools to 24.0.2 Sep 3, 2016
CHANGELOG.md Update CHANGELOG.md to 1.4.2 Dec 15, 2016
CONTRIBUTING.md Update CONTRIBUTING.md Apr 16, 2015
LICENSE Initial commit Jan 29, 2015
PATENTS Update patent grant Apr 14, 2015
README.md Bump to version 1.4.2 Dec 15, 2016
build.gradle Update to gradle 2.2.2 (#464) Dec 6, 2016
gradle.properties Update to 1.4.3-SNAPSHOT (#473) Dec 15, 2016
gradlew Update Gradle wrapper to 2.14.1 Jul 31, 2016
gradlew.bat Update Gradle wrapper to 2.14.1 Jul 31, 2016
release.gradle Remove creation of jars in output Sep 7, 2016
settings.gradle Add OkHttp 3 integration, Deprecate OkHttp 2 integration. Jan 18, 2016

README.md

Stetho Build Status

Stetho is a sophisticated debug bridge for Android applications. When enabled, developers have access to the Chrome Developer Tools feature natively part of the Chrome desktop browser. Developers can also choose to enable the optional dumpapp tool which offers a powerful command-line interface to application internals.

Once you complete the set-up instructions below, just start your app and point your laptop browser to chrome://inspect. Click the "Inspect" button to begin.

Set-up

Download

Download the latest JARs or grab via Gradle:

compile 'com.facebook.stetho:stetho:1.4.2'

or Maven:

<dependency>
  <groupId>com.facebook.stetho</groupId>
  <artifactId>stetho</artifactId>
  <version>1.4.2</version>
</dependency>

Only the main stetho dependency is strictly required; however, you may also wish to use one of the network helpers:

compile 'com.facebook.stetho:stetho-okhttp3:1.4.2'

or:

compile 'com.facebook.stetho:stetho-urlconnection:1.4.2'

You can also enable a JavaScript console with:

compile 'com.facebook.stetho:stetho-js-rhino:1.4.2'

For more details on how to customize the JavaScript runtime see stetho-js-rhino.

Putting it together

Integrating with Stetho is intended to be seamless and straightforward for most existing Android applications. There is a simple initialization step which occurs in your Application class:

public class MyApplication extends Application {
  public void onCreate() {
    super.onCreate();
    Stetho.initializeWithDefaults(this);
  }
}

This brings up most of the default configuration but does not enable some additional hooks (most notably, network inspection). See below for specific details on individual subsystems.

Enable network inspection

If you are using the popular OkHttp library at the 3.x release, you can use the Interceptors system to automatically hook into your existing stack. This is currently the simplest and most straightforward way to enable network inspection:

new OkHttpClient.Builder()
    .addNetworkInterceptor(new StethoInterceptor())
    .build()

Note that okhttp 2.x will work as well, but with slightly different syntax and you must use the stetho-okhttp artifact (not stetho-okhttp3).

As interceptors can modify the request and response, add the Stetho interceptor after all others to get an accurate view of the network traffic.

If you are using HttpURLConnection, you can use StethoURLConnectionManager to assist with integration though you should be aware that there are some caveats with this approach. In particular, you must explicitly add Accept-Encoding: gzip to the request headers and manually handle compressed responses in order for Stetho to report compressed payload sizes.

See the stetho-sample project for more details.

Going further

Custom dumpapp plugins

Custom plugins are the preferred means of extending the dumpapp system and can be added easily during configuration. Simply replace your configuration step as such:

Stetho.initialize(Stetho.newInitializerBuilder(context)
    .enableDumpapp(new DumperPluginsProvider() {
      @Override
      public Iterable<DumperPlugin> get() {
        return new Stetho.DefaultDumperPluginsBuilder(context)
            .provide(new MyDumperPlugin())
            .finish();
      }
    })
    .enableWebKitInspector(Stetho.defaultInspectorModulesProvider(context))
    .build())

See the stetho-sample project for more details.

Improve Stetho!

See the CONTRIBUTING.md file for how to help out.

License

Stetho is BSD-licensed. We also provide an additional patent grant.