Merge pull request #306 from DenverM80/log_performance

shabtaisharon · web-flow · commit 3cd4d27fd720 · 2016-07-27T11:44:15.000-06:00
Change format of LOG messages to be evaluated only if the LOG level i…
diff --git a/ds3-sdk/src/main/java/com/spectralogic/ds3client/ConnectionDetailsImpl.java b/ds3-sdk/src/main/java/com/spectralogic/ds3client/ConnectionDetailsImpl.java
@@ -91,7 +91,7 @@ public static ConnectionDetails newForNode(final JobNode node, final ConnectionD
             connectionBuilder = builder(connectionDetails.getEndpoint(), connectionDetails.getCredentials());
         }
         else {
-            LOG.trace("Creating new Connection Details for endpoint: " + node.getEndPoint());
+            LOG.trace("Creating new Connection Details for endpoint: {}", node.getEndPoint());
             connectionBuilder = builder(buildAuthority(node, connectionDetails), connectionDetails.getCredentials());
         }
         connectionBuilder.withRedirectRetries(connectionDetails.getRetries())
diff --git a/ds3-sdk/src/main/java/com/spectralogic/ds3client/Ds3ClientBuilder.java b/ds3-sdk/src/main/java/com/spectralogic/ds3client/Ds3ClientBuilder.java
@@ -193,8 +193,8 @@ public Ds3ClientBuilder withSocketTimeout(final int timeout) {
      */
     @Override
     public Ds3Client build() {
-        LOG.info("Making connection details for endpoint: " + this.endpoint
-                + " using authorization id: " + this.credentials.getClientId());
+        LOG.info("Making connection details for endpoint [{}] using this authorization id [{}]",
+                this.endpoint, this.credentials.getClientId());
         final ConnectionDetailsImpl.Builder connBuilder = ConnectionDetailsImpl
                 .builder(this.endpoint, this.credentials)
                 .withProxy(this.proxy)
diff --git a/ds3-sdk/src/main/java/com/spectralogic/ds3client/commands/interfaces/AbstractResponse.java b/ds3-sdk/src/main/java/com/spectralogic/ds3client/commands/interfaces/AbstractResponse.java
@@ -133,7 +133,7 @@ private static Error parseErrorResponse(final String responseString) {
             return XmlOutput.fromXml(responseString, Error.class);
         } catch (final IOException e) {
             // It's likely the response string is not in a valid error format.
-            LOG.error("Failed to parse error response", e);
+            LOG.error("Failed to parse error response: {}", e);
             return null;
         }
     }
diff --git a/ds3-sdk/src/main/java/com/spectralogic/ds3client/helpers/ChunkTransferrer.java b/ds3-sdk/src/main/java/com/spectralogic/ds3client/helpers/ChunkTransferrer.java
@@ -69,17 +69,17 @@ public void transferChunks(
         try {
             final List<ListenableFuture<?>> tasks = new ArrayList<>();
             for (final Objects chunk : chunks) {
-                LOG.debug("Processing parts for chunk: " + chunk.getChunkId().toString());
+                LOG.debug("Processing parts for chunk: {}", chunk.getChunkId().toString());
 
                 final Ds3Client client = getClient(nodeMap, chunk.getNodeId(), mainClient);
                 for (final BulkObject ds3Object : chunk.getObjects()) {
                     final ObjectPart part = new ObjectPart(ds3Object.getOffset(), ds3Object.getLength());
                     if (this.partTracker.containsPart(ds3Object.getName(), part)) {
-                        LOG.debug("Adding " + ds3Object.getName() + " to executor for processing");
+                        LOG.debug("Adding {} to executor for processing", ds3Object.getName());
                         tasks.add(executor.submit(new Callable<Object>() {
                             @Override
                             public Object call() throws Exception {
-                                LOG.debug("Processing " + ds3Object.getName());
+                                LOG.debug("Processing {}", ds3Object.getName());
                                 ChunkTransferrer.this.itemTransferrer.transferItem(client, ds3Object);
                                 ChunkTransferrer.this.partTracker.completePart(ds3Object.getName(), part);
                                 return null;
diff --git a/ds3-sdk/src/main/java/com/spectralogic/ds3client/helpers/Ds3ClientHelpersImpl.java b/ds3-sdk/src/main/java/com/spectralogic/ds3client/helpers/Ds3ClientHelpersImpl.java
@@ -186,7 +186,7 @@ public void ensureBucketExists(final String bucket) throws IOException, Signatur
                 if (e.getStatusCode() != 409) {
                     throw e;
                 }
-                LOG.warn("Creating " + bucket + " failed because it was created by another thread or process");
+                LOG.warn("Creating {} failed because it was created by another thread or process", bucket);
             }
         }
     }
@@ -201,7 +201,7 @@ public void ensureBucketExists(final String bucket, final UUID dataPolicy) throw
                 if (e.getStatusCode() != 409) {
                     throw e;
                 }
-                LOG.warn("Creating " + bucket + " failed because it was created by another thread or process");
+                LOG.warn("Creating {} failed because it was created by another thread or process", bucket);
             }
         }
     }
diff --git a/ds3-sdk/src/main/java/com/spectralogic/ds3client/helpers/JobState.java b/ds3-sdk/src/main/java/com/spectralogic/ds3client/helpers/JobState.java
@@ -73,7 +73,7 @@ private static AutoCloseableCache<String, WindowedChannelFactory> buildCache(
                 @Override
                 public WindowedChannelFactory get(final String key) {
                     try {
-                        LOG.debug("Opening channel for : " + key);
+                        LOG.debug("Opening channel for: {}", key);
                         return new WindowedChannelFactory(RangedSeekableByteChannel.wrap(channelBuilder.buildChannel(key), objectRanges.get(key), key));
                     } catch (final IOException e) {
                         throw new RuntimeException(e);
@@ -97,7 +97,7 @@ private final class ObjectCompletedListenerImpl implements ObjectCompletedListen
         public void objectCompleted(final String name) {
             JobState.this.objectsRemaining.decrementAndGet();
             try {
-                LOG.debug("Closing file: "  + name);
+                LOG.debug("Closing file: {}", name);
                 JobState.this.channelCache.close(name);
             } catch (final Exception e) {
                 throw new RuntimeException(e);
diff --git a/ds3-sdk/src/main/java/com/spectralogic/ds3client/helpers/ObjectChannelBuilderLogger.java b/ds3-sdk/src/main/java/com/spectralogic/ds3client/helpers/ObjectChannelBuilderLogger.java
@@ -17,7 +17,7 @@ public ObjectChannelBuilderLogger(final Ds3ClientHelpers.ObjectChannelBuilder ch
 
     @Override
     public SeekableByteChannel buildChannel(final String s) throws IOException {
-        LOG.info("Opening channel for" + s);
+        LOG.info("Opening channel for: {}", s);
         return this.channelBuilder.buildChannel(s);
     }
 }
diff --git a/ds3-sdk/src/main/java/com/spectralogic/ds3client/helpers/WriteJobImpl.java b/ds3-sdk/src/main/java/com/spectralogic/ds3client/helpers/WriteJobImpl.java
@@ -64,8 +64,8 @@ public WriteJobImpl(
             this.filteredChunks = null;
             this.partTracker = null;
         } else {
-            LOG.info("Ready to start transfer for job " + this.masterObjectList.getJobId().toString() + " with "
-                    + this.masterObjectList.getObjects().size() + " chunks");
+            LOG.info("Ready to start transfer for job {} with {} chunks",
+                    this.masterObjectList.getJobId().toString(), this.masterObjectList.getObjects().size());
             this.filteredChunks = filterChunks(this.masterObjectList.getObjects());
             this.partTracker = JobPartTrackerFactory
                     .buildPartTracker(Iterables.concat(ReadJobImpl.getAllBlobApiBeans(filteredChunks)));
@@ -156,7 +156,7 @@ public void transfer(final ObjectChannelBuilder channelBuilder)
                 this.maxParallelRequests
             );
             for (final Objects chunk : filteredChunks) {
-                LOG.debug("Allocating chunk: " + chunk.getChunkId().toString());
+                LOG.debug("Allocating chunk: {}", chunk.getChunkId().toString());
                 chunkTransferrer.transferChunks(
                         this.masterObjectList.getNodes(),
                         Collections.singletonList(filterChunk(allocateChunk(chunk))));
@@ -180,7 +180,7 @@ private Objects tryAllocateChunk(final Objects filtered) throws IOException, Sig
         final AllocateJobChunkSpectraS3Response response =
                 this.client.allocateJobChunkSpectraS3(new AllocateJobChunkSpectraS3Request(filtered.getChunkId()));
 
-        LOG.info("AllocatedJobChunkResponse status: " + response.getStatus().toString());
+        LOG.info("AllocatedJobChunkResponse status: {}", response.getStatus().toString());
         switch (response.getStatus()) {
         case ALLOCATED:
             retryAfterLeft = retryAfter; // Reset the number of retries to the initial value
@@ -193,7 +193,7 @@ private Objects tryAllocateChunk(final Objects filtered) throws IOException, Sig
                 retryAfterLeft--;
 
                 final int retryAfter = response.getRetryAfterSeconds() * 1000;
-                LOG.debug("Will retry allocate chunk call after " + retryAfter + " seconds");
+                LOG.debug("Will retry allocate chunk call after {} seconds", retryAfter);
                 Thread.sleep(retryAfter);
                 return null;
             } catch (final InterruptedException e) {
@@ -286,16 +286,16 @@ private PutObjectRequest createRequest(final BulkObject ds3Object) throws IOExce
         private String calculateChecksum(final BulkObject ds3Object, final SeekableByteChannel channel) throws IOException {
             if (WriteJobImpl.this.checksumType != ChecksumType.Type.NONE) {
                 if (WriteJobImpl.this.checksumFunction == null) {
-                    LOG.info("Calculating " + WriteJobImpl.this.checksumType.toString() + " checksum for blob: " + ds3Object.toString());
+                    LOG.info("Calculating {} checksum for blob: {}", WriteJobImpl.this.checksumType.toString(), ds3Object.toString());
                     final SeekableByteChannelInputStream dataStream = new SeekableByteChannelInputStream(channel);
                     final Hasher hasher = getHasher(WriteJobImpl.this.checksumType);
                     final String checksum = hashInputStream(hasher, dataStream);
-                    LOG.info("Computed checksum for blob: " + checksum);
+                    LOG.info("Computed checksum for blob: {}", checksum);
                     return checksum;
                 } else {
-                    LOG.info("Getting checksum from user supplied callback for blob: " + ds3Object.toString());
+                    LOG.info("Getting checksum from user supplied callback for blob: {}", ds3Object.toString());
                     final String checksum = WriteJobImpl.this.checksumFunction.compute(ds3Object, channel);
-                    LOG.info("User supplied checksum is: " + checksum);
+                    LOG.info("User supplied checksum is: {}", checksum);
                     return checksum;
                 }
             }
diff --git a/ds3-sdk/src/main/java/com/spectralogic/ds3client/networking/NetworkClientImpl.java b/ds3-sdk/src/main/java/com/spectralogic/ds3client/networking/NetworkClientImpl.java
@@ -190,7 +190,7 @@ public WebResponse getResponse(final Ds3Request request) throws IOException {
                 if (response.getStatusLine().getStatusCode() == HttpStatus.SC_TEMPORARY_REDIRECT) {
                     redirectCount++;
                     response.close();
-                    LOG.info("Performing retry - attempt: " + redirectCount);
+                    LOG.info("Performing retry - attempt: {}", redirectCount);
                 }
                 else {
                     LOG.info("Got response from server");
@@ -224,7 +224,8 @@ public RequestExecutor(final CloseableHttpClient client, final HttpHost host, fi
                 throw new RequiresMarkSupportedException();
             }
 
-            LOG.info("Sending request: " + this.ds3Request.getVerb() + " " + this.host.toString() + "" + this.ds3Request.getPath());
+            Object[] paramArray = {this.ds3Request.getVerb(), this.host.toString(), this.ds3Request.getPath()};
+            LOG.info("Sending request: {} {} {}", paramArray );
             this.checksumType = ds3Request.getChecksumType();
             this.hash = this.buildHash();
         }
diff --git a/ds3-sdk/src/main/java/com/spectralogic/ds3client/serializer/XmlOutput.java b/ds3-sdk/src/main/java/com/spectralogic/ds3client/serializer/XmlOutput.java
@@ -70,10 +70,10 @@ protected static boolean isProductionBuild() {
                     return true;
                 }
                 else {
-                    LOG.error("Unknown productionBuild value[" + productionBuild + "].  Defaulting to false for unknown XML elements.");
+                    LOG.error("Unknown productionBuild value[{}].  Defaulting to false for unknown XML elements.", productionBuild);
                 }
             } catch (final IOException e) {
-                LOG.error("Failed to load property file: ", e);
+                LOG.error("Failed to load property file: {}", e);
             }
         }
 
diff --git a/ds3-sdk/src/main/java/com/spectralogic/ds3client/utils/PerformanceUtils.java b/ds3-sdk/src/main/java/com/spectralogic/ds3client/utils/PerformanceUtils.java
@@ -33,7 +33,7 @@ public static void logMbps(final long startTime, final long endTime, final long
 
         final String messagePrefix = getMessagePrefix(isPutCommand);
         
-        LOG.info(String.format("%s %s statistics: Length (%.03f MB), Time (%.03f sec), MBps (%.03f)", messagePrefix, objName, content, time, mbps));
+        LOG.info("{}", String.format("%s %s statistics: Length (%.03f MB), Time (%.03f sec), MBps (%.03f)", messagePrefix, objName, content, time, mbps));
     }
 
     /**
@@ -49,7 +49,7 @@ public static void logMbpsStatus(
         final double curMegaBytes = convertBytesToMegaBytes(curBytes);
         final String messagePrefix = getMessagePrefix(isPutCommand);
 
-        LOG.info(String.format("%s %s status: Transferred (%.03f MB), Time (%.03f sec)", messagePrefix, objName, curMegaBytes, time));
+        LOG.info("{}", String.format("%s %s status: Transferred (%.03f MB), Time (%.03f sec)", messagePrefix, objName, curMegaBytes, time));
     }
 
     /**
diff --git a/ds3-sdk/src/main/java/com/spectralogic/ds3client/utils/Signature.java b/ds3-sdk/src/main/java/com/spectralogic/ds3client/utils/Signature.java
@@ -45,7 +45,7 @@ public class Signature {
     public static String calculateRFC2104HMAC(final String data, final String key)
             throws java.security.SignatureException
     {
-        LOG.debug("String to sign: " + data.replace("\n", "\\n"));
+        LOG.debug("String to sign: {}", data.replace("\n", "\\n"));
         final String result;
         try {
             // get an hmac_sha1 key from the raw key bytes

Original file line number	Diff line number	Diff line change
`@@ -91,7 +91,7 @@ public static ConnectionDetails newForNode(final JobNode node, final ConnectionD`
`91`	`91`	`connectionBuilder = builder(connectionDetails.getEndpoint(), connectionDetails.getCredentials());`
`92`	`92`	`}`
`93`	`93`	`else {`
`94`		`- LOG.trace("Creating new Connection Details for endpoint: " + node.getEndPoint());`
	`94`	`+ LOG.trace("Creating new Connection Details for endpoint: {}", node.getEndPoint());`
`95`	`95`	`connectionBuilder = builder(buildAuthority(node, connectionDetails), connectionDetails.getCredentials());`
`96`	`96`	`}`
`97`	`97`	`connectionBuilder.withRedirectRetries(connectionDetails.getRetries())`
Original file line number	Diff line number	Diff line change
`@@ -133,7 +133,7 @@ private static Error parseErrorResponse(final String responseString) {`
`133`	`133`	`return XmlOutput.fromXml(responseString, Error.class);`
`134`	`134`	`} catch (final IOException e) {`
`135`	`135`	`// It's likely the response string is not in a valid error format.`
`136`		`- LOG.error("Failed to parse error response", e);`
	`136`	`+ LOG.error("Failed to parse error response: {}", e);`
`137`	`137`	`return null;`
`138`	`138`	`}`
`139`	`139`	`}`
Original file line number	Diff line number	Diff line change
`@@ -186,7 +186,7 @@ public void ensureBucketExists(final String bucket) throws IOException, Signatur`
`186`	`186`	`if (e.getStatusCode() != 409) {`
`187`	`187`	`throw e;`
`188`	`188`	`}`
`189`		`- LOG.warn("Creating " + bucket + " failed because it was created by another thread or process");`
	`189`	`+ LOG.warn("Creating {} failed because it was created by another thread or process", bucket);`
`190`	`190`	`}`
`191`	`191`	`}`
`192`	`192`	`}`
`@@ -201,7 +201,7 @@ public void ensureBucketExists(final String bucket, final UUID dataPolicy) throw`
`201`	`201`	`if (e.getStatusCode() != 409) {`
`202`	`202`	`throw e;`
`203`	`203`	`}`
`204`		`- LOG.warn("Creating " + bucket + " failed because it was created by another thread or process");`
	`204`	`+ LOG.warn("Creating {} failed because it was created by another thread or process", bucket);`
`205`	`205`	`}`
`206`	`206`	`}`
`207`	`207`	`}`
Original file line number	Diff line number	Diff line change
`@@ -17,7 +17,7 @@ public ObjectChannelBuilderLogger(final Ds3ClientHelpers.ObjectChannelBuilder ch`
`17`	`17`
`18`	`18`	`@Override`
`19`	`19`	`public SeekableByteChannel buildChannel(final String s) throws IOException {`
`20`		`- LOG.info("Opening channel for" + s);`
	`20`	`+ LOG.info("Opening channel for: {}", s);`
`21`	`21`	`return this.channelBuilder.buildChannel(s);`
`22`	`22`	`}`
`23`	`23`	`}`
Original file line number	Diff line number	Diff line change
`@@ -190,7 +190,7 @@ public WebResponse getResponse(final Ds3Request request) throws IOException {`
`190`	`190`	`if (response.getStatusLine().getStatusCode() == HttpStatus.SC_TEMPORARY_REDIRECT) {`
`191`	`191`	`redirectCount++;`
`192`	`192`	`response.close();`
`193`		`- LOG.info("Performing retry - attempt: " + redirectCount);`
	`193`	`+ LOG.info("Performing retry - attempt: {}", redirectCount);`
`194`	`194`	`}`
`195`	`195`	`else {`
`196`	`196`	`LOG.info("Got response from server");`
`@@ -224,7 +224,8 @@ public RequestExecutor(final CloseableHttpClient client, final HttpHost host, fi`
`224`	`224`	`throw new RequiresMarkSupportedException();`
`225`	`225`	`}`
`226`	`226`
`227`		`- LOG.info("Sending request: " + this.ds3Request.getVerb() + " " + this.host.toString() + "" + this.ds3Request.getPath());`
	`227`	`+ Object[] paramArray = {this.ds3Request.getVerb(), this.host.toString(), this.ds3Request.getPath()};`
	`228`	`+ LOG.info("Sending request: {} {} {}", paramArray );`
`228`	`229`	`this.checksumType = ds3Request.getChecksumType();`
`229`	`230`	`this.hash = this.buildHash();`
`230`	`231`	`}`
Original file line number	Diff line number	Diff line change
`@@ -70,10 +70,10 @@ protected static boolean isProductionBuild() {`
`70`	`70`	`return true;`
`71`	`71`	`}`
`72`	`72`	`else {`
`73`		`- LOG.error("Unknown productionBuild value[" + productionBuild + "]. Defaulting to false for unknown XML elements.");`
	`73`	`+ LOG.error("Unknown productionBuild value[{}]. Defaulting to false for unknown XML elements.", productionBuild);`
`74`	`74`	`}`
`75`	`75`	`} catch (final IOException e) {`
`76`		`- LOG.error("Failed to load property file: ", e);`
	`76`	`+ LOG.error("Failed to load property file: {}", e);`
`77`	`77`	`}`
`78`	`78`	`}`
`79`	`79`