Add debug logging to help with troubleshooting (#5)

Adds additional logging to help troubleshoot the vault client.

Author: sdford

gradle.properties

@@ -14,6 +14,6 @@
 # limitations under the License.
 #
 
-version=1.1.1
+version=1.2.0
 groupId=com.nike
 artifactId=vault-client

src/main/java/com/nike/vault/client/VaultClient.java

@@ -35,6 +35,8 @@
 import okhttp3.RequestBody;
 import okhttp3.Response;
 import org.apache.commons.lang3.StringUtils;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
 
 import javax.net.ssl.SSLException;
 import java.io.IOException;
@@ -65,6 +67,8 @@ public class VaultClient {
             .disableHtmlEscaping()
             .create();
 
+    private final Logger logger = LoggerFactory.getLogger(getClass());
+
     /**
      * Explicit constructor that allows for full control over construction of the Vault client.
      *
@@ -107,6 +111,8 @@ public VaultClient(final UrlResolver vaultUrlResolver,
      */
     public VaultListResponse list(final String path) {
         final HttpUrl url = buildUrl(SECRET_PATH_PREFIX, path + "?list=true");
+        logger.debug("list: requestUrl={}", url);
+
         final Response response = execute(url, HttpMethod.GET, null);
 
         if (response.code() == HttpStatus.NOT_FOUND) {
@@ -132,6 +138,8 @@ public VaultListResponse list(final String path) {
      */
     public VaultResponse read(final String path) {
         final HttpUrl url = buildUrl(SECRET_PATH_PREFIX, path);
+        logger.debug("read: requestUrl={}", url);
+
         final Response response = execute(url, HttpMethod.GET, null);
 
         if (response.code() != HttpStatus.OK) {
@@ -151,6 +159,8 @@ public VaultResponse read(final String path) {
      */
     public void write(final String path, final Map<String, String> data) {
         final HttpUrl url = buildUrl(SECRET_PATH_PREFIX, path);
+        logger.debug("write: requestUrl={}", url);
+
         final Response response = execute(url, HttpMethod.POST, data);
 
         if (response.code() != HttpStatus.NO_CONTENT) {
@@ -167,6 +177,8 @@ public void write(final String path, final Map<String, String> data) {
      */
     public void delete(final String path) {
         final HttpUrl url = buildUrl(SECRET_PATH_PREFIX, path);
+        logger.debug("delete: requestUrl={}", url);
+
         final Response response = execute(url, HttpMethod.DELETE, null);
 
         if (response.code() != HttpStatus.NO_CONTENT) {
@@ -183,6 +195,8 @@ public void delete(final String path) {
      */
     public VaultClientTokenResponse lookupSelf() {
         final HttpUrl url = buildUrl(AUTH_PATH_PREFIX, "token/lookup-self");
+        logger.debug("lookupSelf: requestUrl={}", url);
+
         final Response response = execute(url, HttpMethod.GET, null);
 
         if (response.code() != HttpStatus.OK) {
@@ -287,6 +301,8 @@ protected <M> M parseResponseBody(final Response response, final Class<M> respon
         try {
             return gson.fromJson(response.body().string(), responseClass);
         } catch (IOException|JsonSyntaxException e) {
+            logger.error("parseResponseBody: responseCode={}, requestUrl={}, response={}",
+                    response.code(), response.request().url(), responseBodyAsString(response));
             throw new VaultClientException("Error parsing the response body from vault, response code: " + response.code(), e);
         }
     }
@@ -303,6 +319,8 @@ protected <M> M parseResponseBody(final Response response, final Type typeOf) {
         try {
             return gson.fromJson(response.body().string(), typeOf);
         } catch (IOException|JsonSyntaxException e) {
+            logger.error("parseResponseBody: responseCode={}, requestUrl={}, response={}",
+                    response.code(), response.request().url(), responseBodyAsString(response));
             throw new VaultClientException("Error parsing the response body from vault, response code: " + response.code(), e);
         }
     }
@@ -313,6 +331,9 @@ protected <M> M parseResponseBody(final Response response, final Type typeOf) {
      * @param response Response to parses the error details from
      */
     protected void parseAndThrowErrorResponse(final Response response) {
+        logger.debug("parseAndThrowErrorResponse: responseCode={}, requestUrl={}, response={}",
+                response.code(), response.request().url(), responseBodyAsString(response));
+
         try {
             ErrorResponse errorResponse = gson.fromJson(response.body().string(), ErrorResponse.class);
 
@@ -322,6 +343,7 @@ protected void parseAndThrowErrorResponse(final Response response) {
                 throw new VaultServerException(response.code(), new LinkedList<String>());
             }
         } catch (IOException|JsonSyntaxException e) {
+            logger.error("ERROR Failed to parse error message, response body received: {}", responseBodyAsString(response));
             throw new VaultClientException("Error parsing the error response body from vault, response code: " + response.code(), e);
         }
     }
@@ -336,4 +358,13 @@ public List<String> getErrors() {
             return errors;
         }
     }
+
+    protected String responseBodyAsString(Response response) {
+        try {
+            return response.body().string();
+        } catch (IOException ioe) {
+            logger.debug("responseBodyAsString: response={}", gson.toJson(response));
+            return "ERROR failed to print response body as str: " + ioe.getMessage();
+        }
+    }
 }