dad05de943
Summary: This PR includes documentation for using the `SonarOkhttpInterceptor` for applications using the `OkHttp` network stack. The docs were modelled on the [Stetho docs](http://facebook.github.io/stetho/#enable-network-inspection) Fixes #22. Pull Request resolved: https://github.com/facebook/Sonar/pull/144 Differential Revision: D8780506 Pulled By: danielbuechele fbshipit-source-id: fb2ddd4356b421c3baf0a80a410dd579ebc1bd8d
48 lines
1.4 KiB
Markdown
48 lines
1.4 KiB
Markdown
---
|
|
id: network-plugin
|
|
title: Network
|
|
---
|
|
|
|
Use the Network inspector to inspect outgoing network traffic our apps. You can easily browse all requests being made and their responses. The plugin also supports gzipped responses.
|
|
|
|
|
|
|
|
## Setup
|
|
|
|
To use the network plugin, you need to add the plugin to your Sonar client instance.
|
|
|
|
### Android
|
|
|
|
```java
|
|
import com.facebook.sonar.plugins.network.NetworkSonarPlugin;
|
|
|
|
NetworkSonarPlugin networkSonarPlugin = new NetworkSonarPlugin();
|
|
client.addPlugin(networkSonarPlugin);
|
|
```
|
|
|
|
#### OkHttp Integration
|
|
|
|
If you are using the popular OkHttp library, you can use the Interceptors system to automatically hook into your existing stack.
|
|
|
|
```java
|
|
import com.facebook.sonar.plugins.network.SonarOkhttpInterceptor;
|
|
|
|
new OkHttpClient.Builder()
|
|
.addNetworkInterceptor(new SonarOkhttpInterceptor(networkSonarPlugin))
|
|
.build();
|
|
```
|
|
|
|
As interceptors can modify the request and response, add the Sonar interceptor after all others to get an accurate view of the network traffic.
|
|
|
|
### iOS
|
|
|
|
```objective-c
|
|
#import <SonarKitNetworkPlugin/SonarKitNetworkPlugin.h>
|
|
|
|
[client addPlugin: [SonarKitNetworkPlugin new]]
|
|
```
|
|
|
|
## Usage
|
|
|
|
All request sent from the device will be listed in the plugin. Click on a request to see details like headers and body. You can filter the table for domain, method or status by clicking on the corresponding value in the table.
|