Skip to content

bartek-wesolowski/customizable-okhttp-logging-interceptor

main
Switch branches/tags

Name already in use

A tag already exists with the provided branch name. Many Git commands accept both tag and branch names, so creating this branch may cause unexpected behavior. Are you sure you want to create this branch?
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Customizable OkHttp Logging Interceptor

example workflow

An OkHttp interceptor which logs HTTP request and response data and allows output customization. The implementation is based on the Logging Interceptor from OkHttp.

val loggingInterceptor = CustomizableHttpLoggingInterceptor(
    logHeaders = true,
    logBody = true,
    maxBodyLength = 1000L
)
val client = OkHttpClient.Builder()
    .addInterceptor(loggingInterceptor)
    .build()

To log to a custom location, pass a Logger instance to the constructor.

val loggingInterceptor = CustomizableHttpLoggingInterceptor(
    logger = { message -> Timber.tag("OkHttp").d(message) }
)

Warning: The logs generated by this interceptor when using the HEADERS or BODY levels have 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.

You can redact headers that may contain sensitive information by calling redactHeader().

loggingInterceptor.redactHeader("Authorization")
loggingInterceptor.redactHeader("Cookie")

Installation

Add JitPack to the repository list:

allprojects {
  repositories {
    ...

    maven { url 'https://jitpack.io' }
}
implementation("com.github.bartek-wesolowski:customizable-okhttp-logging-interceptor:1.0.2")

About

An OkHttp interceptor which logs HTTP request and response data and allows output customization.

Topics

Resources

License

Stars

Watchers

Forks

Languages