Files
flipper/docs/network-plugin.md
Pascal Hartig c7f6893cb4 Rename network plugin
Summary: Sonar -> Flipper. Class names only for now.

Reviewed By: priteshrnandgaonkar

Differential Revision: D9991029

fbshipit-source-id: b96dbab7acc89586c1ee67b64bef1c9490b560b5
2018-09-22 16:43:26 -07:00

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.
![Network plugin](/docs/assets/network.png)
## Setup
To use the network plugin, you need to add the plugin to your Flipper client instance.
### Android
```java
import com.facebook.sonar.plugins.network.NetworkFlipperPlugin;
NetworkFlipperPlugin networkSonarPlugin = new NetworkFlipperPlugin();
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.FlipperOkhttpInterceptor;
new OkHttpClient.Builder()
.addNetworkInterceptor(new FlipperOkhttpInterceptor(networkSonarPlugin))
.build();
```
As interceptors can modify the request and response, add the Flipper 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.