50 lines
1.3 KiB
Markdown
50 lines
1.3 KiB
Markdown
Logging Interceptor
|
|
===================
|
|
|
|
An [OkHttp interceptor][1] which logs HTTP request and response data.
|
|
|
|
```java
|
|
OkHttpClient client = new OkHttpClient();
|
|
HttpLoggingInterceptor logging = new HttpLoggingInterceptor();
|
|
logging.setLevel(Level.BASIC);
|
|
client.interceptors().add(logging);
|
|
```
|
|
|
|
You can change the log level at any time by calling `setLevel`.
|
|
|
|
To log to a custom location, pass a `Logger` instance to the constructor.
|
|
```java
|
|
HttpLoggingInterceptor logging = new HttpLoggingInterceptor(new Logger() {
|
|
@Override public void log(String message) {
|
|
Timber.tag("OkHttp").d(message);
|
|
}
|
|
});
|
|
```
|
|
|
|
**Warning**: The logs generated by this interceptor when using the `HEADERS` or `BODY` levels has
|
|
the potential to leak sensitive information such as "Authorization" or "Cookie" headers and the
|
|
contents of request and response bodies. This data should only be logged in a controlled way or in
|
|
a non-production environment.
|
|
|
|
|
|
Download
|
|
--------
|
|
|
|
Get via Maven:
|
|
```xml
|
|
<dependency>
|
|
<groupId>com.squareup.okhttp</groupId>
|
|
<artifactId>logging-interceptor</artifactId>
|
|
<version>(insert latest version)</version>
|
|
</dependency>
|
|
```
|
|
|
|
or via Gradle
|
|
```groovy
|
|
compile 'com.squareup.okhttp:logging-interceptor:(insert latest version)'
|
|
```
|
|
|
|
|
|
|
|
[1]: https://github.com/square/okhttp/wiki/Interceptors
|