├── .github ├── dependabot.yml └── workflows │ └── build.yml ├── .gitignore ├── CHANGELOG.md ├── LICENSE ├── README.md ├── build.gradle.kts ├── gradle.properties ├── gradle ├── libs.versions.toml └── wrapper │ ├── gradle-wrapper.jar │ └── gradle-wrapper.properties ├── gradlew ├── gradlew.bat ├── settings.gradle └── src └── main └── kotlin └── io └── github └── customizablehttplogginginterceptor ├── CustomizableHttpLoggingInterceptor.kt └── internal └── utf8.kt /.github/dependabot.yml: -------------------------------------------------------------------------------- 1 | version: 2 2 | updates: 3 | - package-ecosystem: "gradle" 4 | directory: "/" 5 | schedule: 6 | interval: "daily" 7 | -------------------------------------------------------------------------------- /.github/workflows/build.yml: -------------------------------------------------------------------------------- 1 | name: build 2 | 3 | on: 4 | push: 5 | branches: 6 | - main 7 | pull_request: 8 | types: [opened, labeled, unlabeled, synchronize] 9 | 10 | env: 11 | GRADLE_OPTS: "-Dorg.gradle.daemon=false -Dkotlin.incremental=false" 12 | 13 | jobs: 14 | build: 15 | runs-on: ubuntu-latest 16 | 17 | steps: 18 | - name: Checkout 19 | uses: actions/checkout@v2 20 | 21 | - name: Validate Gradle Wrapper 22 | uses: gradle/wrapper-validation-action@v1 23 | 24 | - name: Configure JDK 25 | uses: actions/setup-java@v2 26 | with: 27 | distribution: 'temurin' 28 | java-version: 17 29 | 30 | - name: Build 31 | run: ./gradlew build 32 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | .classpath 2 | .project 3 | .settings 4 | .gradle 5 | eclipsebin 6 | 7 | bin 8 | gen 9 | build 10 | out 11 | lib 12 | generated 13 | 14 | target 15 | pom.xml.* 16 | release.properties 17 | local.properties 18 | 19 | .idea 20 | *.iml 21 | *.ipr 22 | *.iws 23 | *.log 24 | classes 25 | 26 | obj 27 | 28 | .DS_Store -------------------------------------------------------------------------------- /CHANGELOG.md: -------------------------------------------------------------------------------- 1 | Change Log 2 | ========== 3 | 4 | ## Version 2.0.0 5 | 6 | _2023-06-15_ 7 | 8 | - Published to Maven Central instead of Jitpack 9 | - The package name changed to io.github.customizableokhttplogginginterceptor 10 | - Bumped okhttp to version 4.11.0 11 | - The project is now built with JDK 17 12 | 13 | ## Version 1.0.2 14 | 15 | _2021-12-14_ 16 | 17 | - Bumped okhttp to version 4.9.3 18 | - Bumped Kotlin to version 1.6.10 19 | 20 | ## Version 1.0.1 21 | 22 | _2021-10-31_ 23 | 24 | Fixed printing request and response bodies when logHeaders is false. 25 | 26 | ## Version 1.0.0 27 | 28 | _2021-10-15_ 29 | 30 | First version of the library. 31 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | MIT License 2 | 3 | Copyright (c) 2021 Bartosz Wesołowski 4 | 5 | Permission is hereby granted, free of charge, to any person obtaining a copy 6 | of this software and associated documentation files (the "Software"), to deal 7 | in the Software without restriction, including without limitation the rights 8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 9 | copies of the Software, and to permit persons to whom the Software is 10 | furnished to do so, subject to the following conditions: 11 | 12 | The above copyright notice and this permission notice shall be included in all 13 | copies or substantial portions of the Software. 14 | 15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, 20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE 21 | SOFTWARE. 22 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | Customizable OkHttp Logging Interceptor 2 | =================== 3 | 4 | [![Maven Central](https://maven-badges.herokuapp.com/maven-central/io.github.bartek-wesolowski/customizable-okhttp-logging-interceptor/badge.svg)](https://maven-badges.herokuapp.com/maven-central/io.github.bartek-wesolowski/customizable-okhttp-logging-interceptor) 5 | ![example workflow](https://github.com/bartek-wesolowski/customizable-okhttp-logging-interceptor/actions/workflows/build.yml/badge.svg) 6 | 7 | An [OkHttp interceptor][interceptors] which logs HTTP request and response data and allows output customization. 8 | The implementation is based on the [Logging Interceptor from OkHttp][okhttp-logging-interceptor]. 9 | 10 | ```kotlin 11 | val loggingInterceptor = CustomizableHttpLoggingInterceptor( 12 | logHeaders = true, 13 | logBody = true, 14 | maxBodyLength = 1000L 15 | ) 16 | val client = OkHttpClient.Builder() 17 | .addInterceptor(loggingInterceptor) 18 | .build() 19 | ``` 20 | 21 | To log to a custom location, pass a `Logger` instance to the constructor. 22 | ```kotlin 23 | val loggingInterceptor = CustomizableHttpLoggingInterceptor( 24 | logger = { message -> Timber.tag("OkHttp").d(message) } 25 | ) 26 | ``` 27 | 28 | **Warning**: The logs generated by this interceptor when using the `HEADERS` or `BODY` levels have 29 | the potential to leak sensitive information such as "Authorization" or "Cookie" headers and the 30 | contents of request and response bodies. This data should only be logged in a controlled way or in 31 | a non-production environment. 32 | 33 | You can redact headers that may contain sensitive information by calling `redactHeader()`. 34 | ```kotlin 35 | loggingInterceptor.redactHeader("Authorization") 36 | loggingInterceptor.redactHeader("Cookie") 37 | ``` 38 | 39 | Installation 40 | -------- 41 | Customizable OkHttp Logging Interceptor is available on Maven Central. Add the following to your `build.gradle`/`build.gradle.kts` file: 42 | #### Groovy DSL 43 | ```groovy 44 | testImplementation "io.github.bartek-wesolowski:customizable-okhttp-logging-interceptor:2.0.0" 45 | ``` 46 | 47 | #### Kotlin DSL 48 | ```kotlin 49 | testImplementation("io.github.bartek-wesolowski:customizable-okhttp-logging-interceptor:2.0.0") 50 | ``` 51 | 52 | 53 | [interceptors]: https://square.github.io/okhttp/interceptors/ 54 | [okhttp-logging-interceptor]: https://github.com/square/okhttp/tree/master/okhttp-logging-interceptor 55 | -------------------------------------------------------------------------------- /build.gradle.kts: -------------------------------------------------------------------------------- 1 | import com.vanniktech.maven.publish.SonatypeHost 2 | 3 | plugins { 4 | alias(libs.plugins.kotlin) 5 | alias(libs.plugins.maven.publish) 6 | } 7 | 8 | repositories { 9 | mavenCentral() 10 | } 11 | 12 | kotlin { 13 | jvmToolchain(11) 14 | } 15 | 16 | dependencies { 17 | api(libs.okhttp) 18 | } 19 | 20 | // https://vanniktech.github.io/gradle-maven-publish-plugin/central/ 21 | mavenPublishing { 22 | publishToMavenCentral(SonatypeHost.S01, true) 23 | signAllPublications() 24 | 25 | coordinates("io.github.bartek-wesolowski", "customizable-okhttp-logging-interceptor", "2.0.0") 26 | 27 | pom { 28 | name.set("Customizable OkHttp Logging Interceptor") 29 | description.set("An OkHttp interceptor which logs HTTP request and response data and allows output customization.") 30 | inceptionYear.set("2021") 31 | url.set("https://github.com/bartek-wesolowski/customizable-okhttp-logging-interceptor") 32 | licenses { 33 | license { 34 | name.set("The Apache License, Version 2.0") 35 | url.set("http://www.apache.org/licenses/LICENSE-2.0.txt") 36 | distribution.set("http://www.apache.org/licenses/LICENSE-2.0.txt") 37 | } 38 | } 39 | developers { 40 | developer { 41 | id.set("bartek-wesolowski") 42 | name.set("Bartosz Wesołowski") 43 | url.set("https://github.com/bartek-wesolowski/") 44 | } 45 | } 46 | scm { 47 | url.set("https://github.com/bartek-wesolowski/customizable-okhttp-logging-interceptor") 48 | connection.set("scm:git:git://github.com/bartek-wesolowski/customizable-okhttp-logging-interceptor.git") 49 | developerConnection.set("scm:git:ssh://git@github.com:bartek-wesolowski/customizable-okhttp-logging-interceptor.git") 50 | } 51 | } 52 | } -------------------------------------------------------------------------------- /gradle.properties: -------------------------------------------------------------------------------- 1 | kotlin.code.style=official -------------------------------------------------------------------------------- /gradle/libs.versions.toml: -------------------------------------------------------------------------------- 1 | [versions] 2 | kotlinVersion = "2.1.10" 3 | mavenPublishVersion = "0.30.0" 4 | okhttpVersion = "4.12.0" 5 | 6 | [libraries] 7 | okhttp = { group = "com.squareup.okhttp3", name = "okhttp", version.ref = "okhttpVersion" } 8 | 9 | [plugins] 10 | kotlin = { id = "org.jetbrains.kotlin.jvm", version.ref = "kotlinVersion" } 11 | maven-publish = { id = "com.vanniktech.maven.publish", version.ref = "mavenPublishVersion" } 12 | -------------------------------------------------------------------------------- /gradle/wrapper/gradle-wrapper.jar: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/bartek-wesolowski/customizable-okhttp-logging-interceptor/72c46e8c1bbc0794d5595ec9808447897550f2c2/gradle/wrapper/gradle-wrapper.jar -------------------------------------------------------------------------------- /gradle/wrapper/gradle-wrapper.properties: -------------------------------------------------------------------------------- 1 | distributionBase=GRADLE_USER_HOME 2 | distributionPath=wrapper/dists 3 | distributionUrl=https\://services.gradle.org/distributions/gradle-8.10.2-all.zip 4 | networkTimeout=10000 5 | zipStoreBase=GRADLE_USER_HOME 6 | zipStorePath=wrapper/dists 7 | -------------------------------------------------------------------------------- /gradlew: -------------------------------------------------------------------------------- 1 | #!/bin/sh 2 | 3 | # 4 | # Copyright © 2015-2021 the original authors. 5 | # 6 | # Licensed under the Apache License, Version 2.0 (the "License"); 7 | # you may not use this file except in compliance with the License. 8 | # You may obtain a copy of the License at 9 | # 10 | # https://www.apache.org/licenses/LICENSE-2.0 11 | # 12 | # Unless required by applicable law or agreed to in writing, software 13 | # distributed under the License is distributed on an "AS IS" BASIS, 14 | # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 15 | # See the License for the specific language governing permissions and 16 | # limitations under the License. 17 | # 18 | 19 | ############################################################################## 20 | # 21 | # Gradle start up script for POSIX generated by Gradle. 22 | # 23 | # Important for running: 24 | # 25 | # (1) You need a POSIX-compliant shell to run this script. If your /bin/sh is 26 | # noncompliant, but you have some other compliant shell such as ksh or 27 | # bash, then to run this script, type that shell name before the whole 28 | # command line, like: 29 | # 30 | # ksh Gradle 31 | # 32 | # Busybox and similar reduced shells will NOT work, because this script 33 | # requires all of these POSIX shell features: 34 | # * functions; 35 | # * expansions «$var», «${var}», «${var:-default}», «${var+SET}», 36 | # «${var#prefix}», «${var%suffix}», and «$( cmd )»; 37 | # * compound commands having a testable exit status, especially «case»; 38 | # * various built-in commands including «command», «set», and «ulimit». 39 | # 40 | # Important for patching: 41 | # 42 | # (2) This script targets any POSIX shell, so it avoids extensions provided 43 | # by Bash, Ksh, etc; in particular arrays are avoided. 44 | # 45 | # The "traditional" practice of packing multiple parameters into a 46 | # space-separated string is a well documented source of bugs and security 47 | # problems, so this is (mostly) avoided, by progressively accumulating 48 | # options in "$@", and eventually passing that to Java. 49 | # 50 | # Where the inherited environment variables (DEFAULT_JVM_OPTS, JAVA_OPTS, 51 | # and GRADLE_OPTS) rely on word-splitting, this is performed explicitly; 52 | # see the in-line comments for details. 53 | # 54 | # There are tweaks for specific operating systems such as AIX, CygWin, 55 | # Darwin, MinGW, and NonStop. 56 | # 57 | # (3) This script is generated from the Groovy template 58 | # https://github.com/gradle/gradle/blob/HEAD/subprojects/plugins/src/main/resources/org/gradle/api/internal/plugins/unixStartScript.txt 59 | # within the Gradle project. 60 | # 61 | # You can find Gradle at https://github.com/gradle/gradle/. 62 | # 63 | ############################################################################## 64 | 65 | # Attempt to set APP_HOME 66 | 67 | # Resolve links: $0 may be a link 68 | app_path=$0 69 | 70 | # Need this for daisy-chained symlinks. 71 | while 72 | APP_HOME=${app_path%"${app_path##*/}"} # leaves a trailing /; empty if no leading path 73 | [ -h "$app_path" ] 74 | do 75 | ls=$( ls -ld "$app_path" ) 76 | link=${ls#*' -> '} 77 | case $link in #( 78 | /*) app_path=$link ;; #( 79 | *) app_path=$APP_HOME$link ;; 80 | esac 81 | done 82 | 83 | # This is normally unused 84 | # shellcheck disable=SC2034 85 | APP_BASE_NAME=${0##*/} 86 | APP_HOME=$( cd "${APP_HOME:-./}" && pwd -P ) || exit 87 | 88 | # Use the maximum available, or set MAX_FD != -1 to use that value. 89 | MAX_FD=maximum 90 | 91 | warn () { 92 | echo "$*" 93 | } >&2 94 | 95 | die () { 96 | echo 97 | echo "$*" 98 | echo 99 | exit 1 100 | } >&2 101 | 102 | # OS specific support (must be 'true' or 'false'). 103 | cygwin=false 104 | msys=false 105 | darwin=false 106 | nonstop=false 107 | case "$( uname )" in #( 108 | CYGWIN* ) cygwin=true ;; #( 109 | Darwin* ) darwin=true ;; #( 110 | MSYS* | MINGW* ) msys=true ;; #( 111 | NONSTOP* ) nonstop=true ;; 112 | esac 113 | 114 | CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar 115 | 116 | 117 | # Determine the Java command to use to start the JVM. 118 | if [ -n "$JAVA_HOME" ] ; then 119 | if [ -x "$JAVA_HOME/jre/sh/java" ] ; then 120 | # IBM's JDK on AIX uses strange locations for the executables 121 | JAVACMD=$JAVA_HOME/jre/sh/java 122 | else 123 | JAVACMD=$JAVA_HOME/bin/java 124 | fi 125 | if [ ! -x "$JAVACMD" ] ; then 126 | die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME 127 | 128 | Please set the JAVA_HOME variable in your environment to match the 129 | location of your Java installation." 130 | fi 131 | else 132 | JAVACMD=java 133 | which java >/dev/null 2>&1 || die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. 134 | 135 | Please set the JAVA_HOME variable in your environment to match the 136 | location of your Java installation." 137 | fi 138 | 139 | # Increase the maximum file descriptors if we can. 140 | if ! "$cygwin" && ! "$darwin" && ! "$nonstop" ; then 141 | case $MAX_FD in #( 142 | max*) 143 | # In POSIX sh, ulimit -H is undefined. That's why the result is checked to see if it worked. 144 | # shellcheck disable=SC3045 145 | MAX_FD=$( ulimit -H -n ) || 146 | warn "Could not query maximum file descriptor limit" 147 | esac 148 | case $MAX_FD in #( 149 | '' | soft) :;; #( 150 | *) 151 | # In POSIX sh, ulimit -n is undefined. That's why the result is checked to see if it worked. 152 | # shellcheck disable=SC3045 153 | ulimit -n "$MAX_FD" || 154 | warn "Could not set maximum file descriptor limit to $MAX_FD" 155 | esac 156 | fi 157 | 158 | # Collect all arguments for the java command, stacking in reverse order: 159 | # * args from the command line 160 | # * the main class name 161 | # * -classpath 162 | # * -D...appname settings 163 | # * --module-path (only if needed) 164 | # * DEFAULT_JVM_OPTS, JAVA_OPTS, and GRADLE_OPTS environment variables. 165 | 166 | # For Cygwin or MSYS, switch paths to Windows format before running java 167 | if "$cygwin" || "$msys" ; then 168 | APP_HOME=$( cygpath --path --mixed "$APP_HOME" ) 169 | CLASSPATH=$( cygpath --path --mixed "$CLASSPATH" ) 170 | 171 | JAVACMD=$( cygpath --unix "$JAVACMD" ) 172 | 173 | # Now convert the arguments - kludge to limit ourselves to /bin/sh 174 | for arg do 175 | if 176 | case $arg in #( 177 | -*) false ;; # don't mess with options #( 178 | /?*) t=${arg#/} t=/${t%%/*} # looks like a POSIX filepath 179 | [ -e "$t" ] ;; #( 180 | *) false ;; 181 | esac 182 | then 183 | arg=$( cygpath --path --ignore --mixed "$arg" ) 184 | fi 185 | # Roll the args list around exactly as many times as the number of 186 | # args, so each arg winds up back in the position where it started, but 187 | # possibly modified. 188 | # 189 | # NB: a `for` loop captures its iteration list before it begins, so 190 | # changing the positional parameters here affects neither the number of 191 | # iterations, nor the values presented in `arg`. 192 | shift # remove old arg 193 | set -- "$@" "$arg" # push replacement arg 194 | done 195 | fi 196 | 197 | 198 | # Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. 199 | DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"' 200 | 201 | # Collect all arguments for the java command; 202 | # * $DEFAULT_JVM_OPTS, $JAVA_OPTS, and $GRADLE_OPTS can contain fragments of 203 | # shell script including quotes and variable substitutions, so put them in 204 | # double quotes to make sure that they get re-expanded; and 205 | # * put everything else in single quotes, so that it's not re-expanded. 206 | 207 | set -- \ 208 | "-Dorg.gradle.appname=$APP_BASE_NAME" \ 209 | -classpath "$CLASSPATH" \ 210 | org.gradle.wrapper.GradleWrapperMain \ 211 | "$@" 212 | 213 | # Stop when "xargs" is not available. 214 | if ! command -v xargs >/dev/null 2>&1 215 | then 216 | die "xargs is not available" 217 | fi 218 | 219 | # Use "xargs" to parse quoted args. 220 | # 221 | # With -n1 it outputs one arg per line, with the quotes and backslashes removed. 222 | # 223 | # In Bash we could simply go: 224 | # 225 | # readarray ARGS < <( xargs -n1 <<<"$var" ) && 226 | # set -- "${ARGS[@]}" "$@" 227 | # 228 | # but POSIX shell has neither arrays nor command substitution, so instead we 229 | # post-process each arg (as a line of input to sed) to backslash-escape any 230 | # character that might be a shell metacharacter, then use eval to reverse 231 | # that process (while maintaining the separation between arguments), and wrap 232 | # the whole thing up as a single "set" statement. 233 | # 234 | # This will of course break if any of these variables contains a newline or 235 | # an unmatched quote. 236 | # 237 | 238 | eval "set -- $( 239 | printf '%s\n' "$DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS" | 240 | xargs -n1 | 241 | sed ' s~[^-[:alnum:]+,./:=@_]~\\&~g; ' | 242 | tr '\n' ' ' 243 | )" '"$@"' 244 | 245 | exec "$JAVACMD" "$@" 246 | -------------------------------------------------------------------------------- /gradlew.bat: -------------------------------------------------------------------------------- 1 | @rem 2 | @rem Copyright 2015 the original author or authors. 3 | @rem 4 | @rem Licensed under the Apache License, Version 2.0 (the "License"); 5 | @rem you may not use this file except in compliance with the License. 6 | @rem You may obtain a copy of the License at 7 | @rem 8 | @rem https://www.apache.org/licenses/LICENSE-2.0 9 | @rem 10 | @rem Unless required by applicable law or agreed to in writing, software 11 | @rem distributed under the License is distributed on an "AS IS" BASIS, 12 | @rem WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 | @rem See the License for the specific language governing permissions and 14 | @rem limitations under the License. 15 | @rem 16 | 17 | @if "%DEBUG%"=="" @echo off 18 | @rem ########################################################################## 19 | @rem 20 | @rem Gradle startup script for Windows 21 | @rem 22 | @rem ########################################################################## 23 | 24 | @rem Set local scope for the variables with windows NT shell 25 | if "%OS%"=="Windows_NT" setlocal 26 | 27 | set DIRNAME=%~dp0 28 | if "%DIRNAME%"=="" set DIRNAME=. 29 | @rem This is normally unused 30 | set APP_BASE_NAME=%~n0 31 | set APP_HOME=%DIRNAME% 32 | 33 | @rem Resolve any "." and ".." in APP_HOME to make it shorter. 34 | for %%i in ("%APP_HOME%") do set APP_HOME=%%~fi 35 | 36 | @rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. 37 | set DEFAULT_JVM_OPTS="-Xmx64m" "-Xms64m" 38 | 39 | @rem Find java.exe 40 | if defined JAVA_HOME goto findJavaFromJavaHome 41 | 42 | set JAVA_EXE=java.exe 43 | %JAVA_EXE% -version >NUL 2>&1 44 | if %ERRORLEVEL% equ 0 goto execute 45 | 46 | echo. 47 | echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. 48 | echo. 49 | echo Please set the JAVA_HOME variable in your environment to match the 50 | echo location of your Java installation. 51 | 52 | goto fail 53 | 54 | :findJavaFromJavaHome 55 | set JAVA_HOME=%JAVA_HOME:"=% 56 | set JAVA_EXE=%JAVA_HOME%/bin/java.exe 57 | 58 | if exist "%JAVA_EXE%" goto execute 59 | 60 | echo. 61 | echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME% 62 | echo. 63 | echo Please set the JAVA_HOME variable in your environment to match the 64 | echo location of your Java installation. 65 | 66 | goto fail 67 | 68 | :execute 69 | @rem Setup the command line 70 | 71 | set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar 72 | 73 | 74 | @rem Execute Gradle 75 | "%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %* 76 | 77 | :end 78 | @rem End local scope for the variables with windows NT shell 79 | if %ERRORLEVEL% equ 0 goto mainEnd 80 | 81 | :fail 82 | rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of 83 | rem the _cmd.exe /c_ return code! 84 | set EXIT_CODE=%ERRORLEVEL% 85 | if %EXIT_CODE% equ 0 set EXIT_CODE=1 86 | if not ""=="%GRADLE_EXIT_CONSOLE%" exit %EXIT_CODE% 87 | exit /b %EXIT_CODE% 88 | 89 | :mainEnd 90 | if "%OS%"=="Windows_NT" endlocal 91 | 92 | :omega 93 | -------------------------------------------------------------------------------- /settings.gradle: -------------------------------------------------------------------------------- 1 | rootProject.name = 'customizable-okhttp-logging-interceptor' 2 | 3 | -------------------------------------------------------------------------------- /src/main/kotlin/io/github/customizablehttplogginginterceptor/CustomizableHttpLoggingInterceptor.kt: -------------------------------------------------------------------------------- 1 | package io.github.customizablehttplogginginterceptor 2 | 3 | import io.github.customizablehttplogginginterceptor.internal.isProbablyUtf8 4 | import java.io.IOException 5 | import java.nio.charset.Charset 6 | import java.nio.charset.StandardCharsets.UTF_8 7 | import java.util.TreeSet 8 | import java.util.concurrent.TimeUnit 9 | import okhttp3.Headers 10 | import okhttp3.Interceptor 11 | import okhttp3.OkHttpClient 12 | import okhttp3.Response 13 | import okhttp3.internal.http.promisesBody 14 | import okhttp3.internal.platform.Platform 15 | import okio.Buffer 16 | import okio.GzipSource 17 | import kotlin.math.min 18 | 19 | /** 20 | * An OkHttp interceptor which logs request and response information. Can be applied as an 21 | * [application interceptor][OkHttpClient.interceptors] or as a [OkHttpClient.networkInterceptors]. 22 | * 23 | * The format of the logs created by this class should not be considered stable and may 24 | * change slightly between releases. If you need a stable logging format, use your own interceptor. 25 | * 26 | * @param logger the logger to use. Each platform has a default one. 27 | * @param logHeaders true to show headers 28 | * @param logBody true to show body 29 | * @param maxBodyLength the maximum body length to show. If body is longer than this value then it will be truncated to this 30 | * length. This parameter is only used if `logBody` is true. 31 | */ 32 | class CustomizableHttpLoggingInterceptor @JvmOverloads constructor( 33 | private val logger: Logger = Logger.DEFAULT, 34 | private val logHeaders: Boolean = false, 35 | private val logBody: Boolean = false, 36 | private val maxBodyLength: Long = Long.MAX_VALUE 37 | ) : Interceptor { 38 | 39 | @Volatile private var headersToRedact = emptySet() 40 | 41 | fun interface Logger { 42 | fun log(message: String) 43 | 44 | companion object { 45 | /** A [Logger] defaults output appropriate for the current platform. */ 46 | @JvmField 47 | val DEFAULT: Logger = DefaultLogger() 48 | private class DefaultLogger : Logger { 49 | override fun log(message: String) { 50 | Platform.get().log(message) 51 | } 52 | } 53 | } 54 | } 55 | 56 | fun redactHeader(name: String) { 57 | val newHeadersToRedact = TreeSet(String.CASE_INSENSITIVE_ORDER) 58 | newHeadersToRedact += headersToRedact 59 | newHeadersToRedact += name 60 | headersToRedact = newHeadersToRedact 61 | } 62 | 63 | @Throws(IOException::class) 64 | override fun intercept(chain: Interceptor.Chain): Response { 65 | val request = chain.request() 66 | 67 | val requestBody = request.body 68 | 69 | val connection = chain.connection() 70 | var requestStartMessage = 71 | ("--> ${request.method} ${request.url}${if (connection != null) " " + connection.protocol() else ""}") 72 | if (!logHeaders && requestBody != null) { 73 | requestStartMessage += " (${requestBody.contentLength()}-byte body)" 74 | } 75 | logger.log(requestStartMessage) 76 | 77 | if (logHeaders) { 78 | val headers = request.headers 79 | 80 | if (requestBody != null) { 81 | // Request body headers are only present when installed as a network interceptor. When not 82 | // already present, force them to be included (if available) so their values are known. 83 | requestBody.contentType()?.let { 84 | if (headers["Content-Type"] == null) { 85 | logger.log("Content-Type: $it") 86 | } 87 | } 88 | if (requestBody.contentLength() != -1L) { 89 | if (headers["Content-Length"] == null) { 90 | logger.log("Content-Length: ${requestBody.contentLength()}") 91 | } 92 | } 93 | } 94 | 95 | for (i in 0 until headers.size) { 96 | logHeader(headers, i) 97 | } 98 | } 99 | 100 | if (!logBody || requestBody == null) { 101 | logger.log("--> END ${request.method}") 102 | } else if (bodyHasUnknownEncoding(request.headers)) { 103 | logger.log("--> END ${request.method} (encoded body omitted)") 104 | } else if (requestBody.isDuplex()) { 105 | logger.log("--> END ${request.method} (duplex request body omitted)") 106 | } else if (requestBody.isOneShot()) { 107 | logger.log("--> END ${request.method} (one-shot body omitted)") 108 | } else { 109 | val buffer = Buffer() 110 | requestBody.writeTo(buffer) 111 | 112 | val contentType = requestBody.contentType() 113 | val charset: Charset = contentType?.charset(UTF_8) ?: UTF_8 114 | 115 | logger.log("") 116 | if (buffer.isProbablyUtf8()) { 117 | logger.log(buffer.readString(min(buffer.size, maxBodyLength), charset)) 118 | logger.log("--> END ${request.method} (${requestBody.contentLength()}-byte body)") 119 | } else { 120 | logger.log( 121 | "--> END ${request.method} (binary ${requestBody.contentLength()}-byte body omitted)" 122 | ) 123 | } 124 | } 125 | 126 | val startNs = System.nanoTime() 127 | val response: Response 128 | try { 129 | response = chain.proceed(request) 130 | } catch (e: Exception) { 131 | logger.log("<-- HTTP FAILED: $e") 132 | throw e 133 | } 134 | 135 | val tookMs = TimeUnit.NANOSECONDS.toMillis(System.nanoTime() - startNs) 136 | 137 | val responseBody = response.body!! 138 | val contentLength = responseBody.contentLength() 139 | val bodySize = if (contentLength != -1L) "$contentLength-byte" else "unknown-length" 140 | logger.log( 141 | "<-- ${response.code}${if (response.message.isEmpty()) "" else ' ' + response.message} ${response.request.url} (${tookMs}ms${if (!logHeaders) ", $bodySize body" else ""})") 142 | 143 | val headers = response.headers 144 | if (logHeaders) { 145 | for (i in 0 until headers.size) { 146 | logHeader(headers, i) 147 | } 148 | } 149 | 150 | if (!logBody || !response.promisesBody()) { 151 | logger.log("<-- END HTTP") 152 | } else if (bodyHasUnknownEncoding(response.headers)) { 153 | logger.log("<-- END HTTP (encoded body omitted)") 154 | } else { 155 | val source = responseBody.source() 156 | source.request(Long.MAX_VALUE) // Buffer the entire body. 157 | var buffer = source.buffer 158 | 159 | var gzippedLength: Long? = null 160 | if ("gzip".equals(headers["Content-Encoding"], ignoreCase = true)) { 161 | gzippedLength = buffer.size 162 | GzipSource(buffer.clone()).use { gzippedResponseBody -> 163 | buffer = Buffer() 164 | buffer.writeAll(gzippedResponseBody) 165 | } 166 | } 167 | 168 | val contentType = responseBody.contentType() 169 | val charset: Charset = contentType?.charset(UTF_8) ?: UTF_8 170 | 171 | if (!buffer.isProbablyUtf8()) { 172 | logger.log("") 173 | logger.log("<-- END HTTP (binary ${buffer.size}-byte body omitted)") 174 | return response 175 | } 176 | 177 | if (contentLength != 0L) { 178 | logger.log("") 179 | logger.log(buffer.clone().readString(min(buffer.size, maxBodyLength), charset)) 180 | } 181 | 182 | if (gzippedLength != null) { 183 | logger.log("<-- END HTTP (${buffer.size}-byte, $gzippedLength-gzipped-byte body)") 184 | } else { 185 | logger.log("<-- END HTTP (${buffer.size}-byte body)") 186 | } 187 | } 188 | 189 | return response 190 | } 191 | 192 | private fun logHeader(headers: Headers, i: Int) { 193 | val value = if (headers.name(i) in headersToRedact) "██" else headers.value(i) 194 | logger.log(headers.name(i) + ": " + value) 195 | } 196 | 197 | private fun bodyHasUnknownEncoding(headers: Headers): Boolean { 198 | val contentEncoding = headers["Content-Encoding"] ?: return false 199 | return !contentEncoding.equals("identity", ignoreCase = true) && 200 | !contentEncoding.equals("gzip", ignoreCase = true) 201 | } 202 | } 203 | -------------------------------------------------------------------------------- /src/main/kotlin/io/github/customizablehttplogginginterceptor/internal/utf8.kt: -------------------------------------------------------------------------------- 1 | package io.github.customizablehttplogginginterceptor.internal 2 | 3 | import java.io.EOFException 4 | import okio.Buffer 5 | 6 | /** 7 | * Returns true if the body in question probably contains human readable text. Uses a small 8 | * sample of code points to detect unicode control characters commonly used in binary file 9 | * signatures. 10 | */ 11 | fun Buffer.isProbablyUtf8(): Boolean { 12 | try { 13 | val prefix = Buffer() 14 | val byteCount = size.coerceAtMost(64) 15 | copyTo(prefix, 0, byteCount) 16 | for (i in 0 until 16) { 17 | if (prefix.exhausted()) { 18 | break 19 | } 20 | val codePoint = prefix.readUtf8CodePoint() 21 | if (Character.isISOControl(codePoint) && !Character.isWhitespace(codePoint)) { 22 | return false 23 | } 24 | } 25 | return true 26 | } catch (_: EOFException) { 27 | return false // Truncated UTF-8 sequence. 28 | } 29 | } 30 | --------------------------------------------------------------------------------