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.
Download the latest JARs or grab via Gradle:
compile 'com.facebook.stetho:stetho:1.2.0'or Maven:
<dependency>
<groupId>com.facebook.stetho</groupId>
<artifactId>stetho</artifactId>
<version>1.2.0</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-okhttp:1.2.0'or:
compile 'com.facebook.stetho:stetho-urlconnection:1.2.0'You can also enable a JavaScript console with:
compile 'com.facebook.stetho:stetho-js-rhino:1.2.0'For more details on how to customize the JavaScript runtime see stetho-js-rhino.
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.
If you are using the popular OkHttp library at the 2.2.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:
OkHttpClient client = new OkHttpClient();
client.networkInterceptors().add(new StethoInterceptor());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.
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.
See the CONTRIBUTING.md file for how to help out.
Stetho is BSD-licensed. We also provide an additional patent grant.