Add missing Locale in String.format

opendistro-for-elasticsearch · Jan 27, 2021 · 5201c71 · 5201c71
1 parent 4ad4706
commit 5201c71
Show file tree

Hide file tree

Showing 14 changed files with 78 additions and 59 deletions.
diff --git a/src/main/java/com/amazon/opendistroforelasticsearch/ad/AnomalyDetectorRunner.java b/src/main/java/com/amazon/opendistroforelasticsearch/ad/AnomalyDetectorRunner.java
@@ -21,6 +21,7 @@
 import java.util.Arrays;
 import java.util.Collections;
 import java.util.List;
+import java.util.Locale;
 import java.util.Map;
 import java.util.stream.Collectors;
 
@@ -87,7 +88,7 @@ public void executeDetector(AnomalyDetector detector, Instant startTime, Instant
                     new MultiResponsesDelegateActionListener<EntityAnomalyResult>(
                         entityAnomalyResultListener,
                         entities.size(),
-                        String.format("Fail to get preview result for multi entity detector %s", detector.getDetectorId()),
+                        String.format(Locale.US, "Fail to get preview result for multi entity detector %s", detector.getDetectorId()),
                         true
                     );
                 for (Entity entity : entities) {

diff --git a/src/main/java/com/amazon/opendistroforelasticsearch/ad/feature/SearchFeatureDao.java b/src/main/java/com/amazon/opendistroforelasticsearch/ad/feature/SearchFeatureDao.java
@@ -31,6 +31,7 @@
 import java.util.HashMap;
 import java.util.Iterator;
 import java.util.List;
+import java.util.Locale;
 import java.util.Map;
 import java.util.Map.Entry;
 import java.util.Optional;
@@ -418,7 +419,7 @@ public Optional<Entry<double[][], Integer>> getFeaturesForSampledPeriods(
         Map<Long, double[]> cache = new HashMap<>();
         int currentStride = maxStride;
         Optional<double[][]> features = Optional.empty();
-        logger.info(String.format("Getting features for detector %s starting %d", detector.getDetectorId(), endTime));
+        logger.info(String.format(Locale.US, "Getting features for detector %s starting %d", detector.getDetectorId(), endTime));
         while (currentStride >= 1) {
             boolean isInterpolatable = currentStride < maxStride;
             features = getFeaturesForSampledPeriods(detector, maxSamples, currentStride, endTime, cache, isInterpolatable);
@@ -511,7 +512,7 @@ public void getFeaturesForSampledPeriods(
         ActionListener<Optional<Entry<double[][], Integer>>> listener
     ) {
         Map<Long, double[]> cache = new HashMap<>();
-        logger.info(String.format("Getting features for detector %s ending at %d", detector.getDetectorId(), endTime));
+        logger.info(String.format(Locale.US, "Getting features for detector %s ending at %d", detector.getDetectorId(), endTime));
         getFeatureSamplesWithCache(detector, maxSamples, maxStride, endTime, cache, maxStride, listener);
     }
 

diff --git a/src/main/java/com/amazon/opendistroforelasticsearch/ad/ml/CheckpointDao.java b/src/main/java/com/amazon/opendistroforelasticsearch/ad/ml/CheckpointDao.java
@@ -27,6 +27,7 @@
 import java.util.Arrays;
 import java.util.ConcurrentModificationException;
 import java.util.HashMap;
+import java.util.Locale;
 import java.util.Map;
 import java.util.Map.Entry;
 import java.util.Optional;
@@ -223,7 +224,7 @@ private void onCheckpointNotExist(Map<String, Object> source, String modelId, bo
                     saveModelCheckpointSync(source, modelId);
                 }
             } else {
-                logger.error(String.format("Unexpected error creating index %s", indexName), exception);
+                logger.error(String.format(Locale.US, "Unexpected error creating index %s", indexName), exception);
             }
         }));
     }
@@ -271,7 +272,7 @@ public void flush() {
                             // It is possible the index has been created while we sending the create request
                             flush(bulkRequest);
                         } else {
-                            logger.error(String.format("Unexpected error creating index %s", indexName), exception);
+                            logger.error(String.format(Locale.US, "Unexpected error creating index %s", indexName), exception);
                         }
                     }));
                 }

diff --git a/src/main/java/com/amazon/opendistroforelasticsearch/ad/ml/ModelManager.java b/src/main/java/com/amazon/opendistroforelasticsearch/ad/ml/ModelManager.java
@@ -437,7 +437,7 @@ public List<ModelState<?>> getAllModels() {
      */
     @Deprecated
     public void stopModel(String detectorId, String modelId) {
-        logger.info(String.format("Stopping detector %s model %s", detectorId, modelId));
+        logger.info(String.format(Locale.US, "Stopping detector %s model %s", detectorId, modelId));
         stopModel(forests, modelId, this::toCheckpoint);
         stopModel(thresholds, modelId, this::toCheckpoint);
     }
@@ -458,7 +458,7 @@ private <T> void stopModel(Map<String, ModelState<T>> models, String modelId, Fu
      * @param listener onResponse is called with null when the operation is completed
      */
     public void stopModel(String detectorId, String modelId, ActionListener<Void> listener) {
-        logger.info(String.format("Stopping detector %s model %s", detectorId, modelId));
+        logger.info(String.format(Locale.US, "Stopping detector %s model %s", detectorId, modelId));
         stopModel(
             forests,
             modelId,

diff --git a/src/main/java/com/amazon/opendistroforelasticsearch/ad/ml/ModelPartitioner.java b/src/main/java/com/amazon/opendistroforelasticsearch/ad/ml/ModelPartitioner.java
@@ -16,6 +16,7 @@
 package com.amazon.opendistroforelasticsearch.ad.ml;
 
 import java.util.AbstractMap.SimpleImmutableEntry;
+import java.util.Locale;
 import java.util.Map.Entry;
 
 import org.apache.logging.log4j.LogManager;
@@ -133,7 +134,7 @@ public Entry<Integer, Integer> getPartitionedForestSizes(RandomCutForest forest,
      * @return ID for the RCF model partition
      */
     public String getRcfModelId(String detectorId, int partitionNumber) {
-        return String.format(RCF_MODEL_ID_PATTERN, detectorId, partitionNumber);
+        return String.format(Locale.US, RCF_MODEL_ID_PATTERN, detectorId, partitionNumber);
     }
 
     /**
@@ -143,6 +144,6 @@ public String getRcfModelId(String detectorId, int partitionNumber) {
      * @return ID for the thresholding model
      */
     public String getThresholdModelId(String detectorId) {
-        return String.format(THRESHOLD_MODEL_ID_PATTERN, detectorId);
+        return String.format(Locale.US, THRESHOLD_MODEL_ID_PATTERN, detectorId);
     }
 }
diff --git a/...va/com/amazon/opendistroforelasticsearch/ad/rest/RestSearchAnomalyDetectorInfoAction.java b/...va/com/amazon/opendistroforelasticsearch/ad/rest/RestSearchAnomalyDetectorInfoAction.java
@@ -73,7 +73,10 @@ public List<RestHandler.Route> routes() {
                     String.format(Locale.ROOT, "%s/%s", AnomalyDetectorPlugin.AD_BASE_DETECTORS_URI, COUNT)
                 ),
                 // get if a detector name exists with name
-                new RestHandler.Route(RestRequest.Method.GET, String.format("%s/%s", AnomalyDetectorPlugin.AD_BASE_DETECTORS_URI, MATCH))
+                new RestHandler.Route(
+                    RestRequest.Method.GET,
+                    String.format(Locale.US, "%s/%s", AnomalyDetectorPlugin.AD_BASE_DETECTORS_URI, MATCH)
+                )
             );
     }
 }
diff --git a/.../amazon/opendistroforelasticsearch/ad/rest/handler/IndexAnomalyDetectorActionHandler.java b/.../amazon/opendistroforelasticsearch/ad/rest/handler/IndexAnomalyDetectorActionHandler.java
@@ -23,6 +23,7 @@
 import java.time.Instant;
 import java.util.Arrays;
 import java.util.List;
+import java.util.Locale;
 import java.util.Map;
 import java.util.stream.Collectors;
 
@@ -391,13 +392,13 @@ private void validateCategoricalField(String detectorId) {
             }
 
             if (foundField == false) {
-                listener.onFailure(new IllegalArgumentException(String.format(NOT_FOUND_ERR_MSG, categoryField0)));
+                listener.onFailure(new IllegalArgumentException(String.format(Locale.US, NOT_FOUND_ERR_MSG, categoryField0)));
                 return;
             }
 
             searchAdInputIndices(detectorId);
         }, error -> {
-            String message = String.format("Fail to get the index mapping of %s", anomalyDetector.getIndices());
+            String message = String.format(Locale.US, "Fail to get the index mapping of %s", anomalyDetector.getIndices());
             logger.error(message, error);
             listener.onFailure(new IllegalArgumentException(message));
         });

diff --git a/.../java/com/amazon/opendistroforelasticsearch/ad/transport/ADResultBulkTransportAction.java b/.../java/com/amazon/opendistroforelasticsearch/ad/transport/ADResultBulkTransportAction.java
@@ -20,6 +20,7 @@
 import static org.elasticsearch.index.IndexingPressure.MAX_INDEXING_BYTES;
 
 import java.io.IOException;
+import java.util.Locale;
 import java.util.Random;
 
 import org.apache.logging.log4j.LogManager;
@@ -121,7 +122,7 @@ private void addResult(BulkRequest bulkRequest, AnomalyResult result) {
             IndexRequest indexRequest = new IndexRequest(indexName).source(result.toXContent(builder, RestHandlerUtils.XCONTENT_WITH_TYPE));
             bulkRequest.add(indexRequest);
         } catch (IOException e) {
-            LOG.error(String.format("Failed to prepare bulk %s", indexName), e);
+            LOG.error(String.format(Locale.US, "Failed to prepare bulk %s", indexName), e);
         }
     }
 }
diff --git a/...java/com/amazon/opendistroforelasticsearch/ad/transport/AnomalyResultTransportAction.java b/...java/com/amazon/opendistroforelasticsearch/ad/transport/AnomalyResultTransportAction.java
@@ -932,7 +932,7 @@ private boolean shouldStart(
         }
 
         if (stateManager.isMuted(thresholdNodeId)) {
-            listener.onFailure(new InternalFailure(adID, String.format(NODE_UNRESPONSIVE_ERR_MSG + " %s", thresholdModelID)));
+            listener.onFailure(new InternalFailure(adID, String.format(Locale.US, NODE_UNRESPONSIVE_ERR_MSG + " %s", thresholdModelID)));
             return false;
         }
 
@@ -1060,7 +1060,7 @@ private Optional<AnomalyDetectionException> coldStartIfNoCheckPoint(AnomalyDetec
                 LOG.info("Trigger cold start for {}", detectorId);
                 coldStart(detector);
             } else {
-                String errorMsg = String.format("Fail to get checkpoint state for %s", detectorId);
+                String errorMsg = String.format(Locale.US, "Fail to get checkpoint state for %s", detectorId);
                 LOG.error(errorMsg, exception);
                 stateManager.setLastColdStartException(detectorId, new AnomalyDetectionException(errorMsg, exception));
             }

diff --git a/...java/com/amazon/opendistroforelasticsearch/ad/transport/EntityProfileTransportAction.java b/...java/com/amazon/opendistroforelasticsearch/ad/transport/EntityProfileTransportAction.java
@@ -16,6 +16,7 @@
 package com.amazon.opendistroforelasticsearch.ad.transport;
 
 import java.io.IOException;
+import java.util.Locale;
 import java.util.Optional;
 import java.util.Set;
 
@@ -152,7 +153,7 @@ public String executor() {
                         }
                     );
             } catch (Exception e) {
-                LOG.error(String.format("Fail to get entity profile for detector {}, entity {}", adID, entityValue), e);
+                LOG.error(String.format(Locale.US, "Fail to get entity profile for detector {}, entity {}", adID, entityValue), e);
                 listener.onFailure(new AnomalyDetectionException(adID, FAIL_TO_GET_ENTITY_PROFILE_MSG, e));
             }
 

diff --git a/...in/java/com/amazon/opendistroforelasticsearch/ad/transport/RCFPollingTransportAction.java b/...in/java/com/amazon/opendistroforelasticsearch/ad/transport/RCFPollingTransportAction.java
@@ -16,6 +16,7 @@
 package com.amazon.opendistroforelasticsearch.ad.transport;
 
 import java.io.IOException;
+import java.util.Locale;
 import java.util.Optional;
 
 import org.apache.logging.log4j.LogManager;
@@ -139,7 +140,7 @@ public String executor() {
 
                     });
             } catch (Exception e) {
-                LOG.error(String.format("Fail to poll RCF models for {}", adID), e);
+                LOG.error(String.format(Locale.US, "Fail to poll RCF models for {}", adID), e);
                 listener.onFailure(new AnomalyDetectionException(adID, FAIL_TO_GET_RCF_UPDATE_MSG, e));
             }
 

diff --git a/.../java/com/amazon/opendistroforelasticsearch/ad/transport/handler/AnomalyIndexHandler.java b/.../java/com/amazon/opendistroforelasticsearch/ad/transport/handler/AnomalyIndexHandler.java
@@ -133,7 +133,7 @@ public void index(T toSave, String detectorId) {
                         } else {
                             throw new AnomalyDetectionException(
                                 detectorId,
-                                String.format("Unexpected error creating index %s", indexName),
+                                String.format(Locale.US, "Unexpected error creating index %s", indexName),
                                 exception
                             );
                         }
@@ -154,7 +154,10 @@ private void onCreateIndexResponse(CreateIndexResponse response, T toSave, Strin
         if (response.isAcknowledged()) {
             save(toSave, detectorId);
         } else {
-            throw new AnomalyDetectionException(detectorId, String.format("Creating %s with mappings call not acknowledged.", indexName));
+            throw new AnomalyDetectionException(
+                detectorId,
+                String.format(Locale.US, "Creating %s with mappings call not acknowledged.", indexName)
+            );
         }
     }
 
@@ -167,8 +170,8 @@ protected void save(T toSave, String detectorId) {
 
             saveIteration(indexRequest, detectorId, savingBackoffPolicy.iterator());
         } catch (Exception e) {
-            LOG.error(String.format("Failed to save %s", indexName), e);
-            throw new AnomalyDetectionException(detectorId, String.format("Cannot save %s", indexName));
+            LOG.error(String.format(Locale.US, "Failed to save %s", indexName), e);
+            throw new AnomalyDetectionException(detectorId, String.format(Locale.US, "Cannot save %s", indexName));
         }
     }
 
@@ -177,33 +180,37 @@ void saveIteration(IndexRequest indexRequest, String detectorId, Iterator<TimeVa
             .<IndexRequest, IndexResponse>asyncRequest(
                 indexRequest,
                 client::index,
-                ActionListener.<IndexResponse>wrap(response -> { LOG.debug(String.format(SUCCESS_SAVING_MSG, detectorId)); }, exception -> {
-                    // Elasticsearch has a thread pool and a queue for write per node. A thread
-                    // pool will have N number of workers ready to handle the requests. When a
-                    // request comes and if a worker is free , this is handled by the worker. Now by
-                    // default the number of workers is equal to the number of cores on that CPU.
-                    // When the workers are full and there are more write requests, the request
-                    // will go to queue. The size of queue is also limited. If by default size is,
-                    // say, 200 and if there happens more parallel requests than this, then those
-                    // requests would be rejected as you can see EsRejectedExecutionException.
-                    // So EsRejectedExecutionException is the way that Elasticsearch tells us that
-                    // it cannot keep up with the current indexing rate.
-                    // When it happens, we should pause indexing a bit before trying again, ideally
-                    // with randomized exponential backoff.
-                    Throwable cause = ExceptionsHelper.unwrapCause(exception);
-                    if (!(cause instanceof EsRejectedExecutionException) || !backoff.hasNext()) {
-                        LOG.error(String.format(FAIL_TO_SAVE_ERR_MSG, detectorId), cause);
-                    } else {
-                        TimeValue nextDelay = backoff.next();
-                        LOG.warn(String.format(RETRY_SAVING_ERR_MSG, detectorId), cause);
-                        // copy original request's source without other information like autoGeneratedTimestamp
-                        // otherwise, an exception will be thrown indicating autoGeneratedTimestamp should not be set
-                        // while request id is already set (id is set because we have already sent the request before).
-                        IndexRequest newReuqest = new IndexRequest(indexRequest.index());
-                        newReuqest.source(indexRequest.source(), indexRequest.getContentType());
-                        threadPool.schedule(() -> saveIteration(newReuqest, detectorId, backoff), nextDelay, ThreadPool.Names.SAME);
-                    }
-                })
+                ActionListener
+                    .<IndexResponse>wrap(
+                        response -> { LOG.debug(String.format(Locale.US, SUCCESS_SAVING_MSG, detectorId)); },
+                        exception -> {
+                            // Elasticsearch has a thread pool and a queue for write per node. A thread
+                            // pool will have N number of workers ready to handle the requests. When a
+                            // request comes and if a worker is free , this is handled by the worker. Now by
+                            // default the number of workers is equal to the number of cores on that CPU.
+                            // When the workers are full and there are more write requests, the request
+                            // will go to queue. The size of queue is also limited. If by default size is,
+                            // say, 200 and if there happens more parallel requests than this, then those
+                            // requests would be rejected as you can see EsRejectedExecutionException.
+                            // So EsRejectedExecutionException is the way that Elasticsearch tells us that
+                            // it cannot keep up with the current indexing rate.
+                            // When it happens, we should pause indexing a bit before trying again, ideally
+                            // with randomized exponential backoff.
+                            Throwable cause = ExceptionsHelper.unwrapCause(exception);
+                            if (!(cause instanceof EsRejectedExecutionException) || !backoff.hasNext()) {
+                                LOG.error(String.format(Locale.US, FAIL_TO_SAVE_ERR_MSG, detectorId), cause);
+                            } else {
+                                TimeValue nextDelay = backoff.next();
+                                LOG.warn(String.format(Locale.US, RETRY_SAVING_ERR_MSG, detectorId), cause);
+                                // copy original request's source without other information like autoGeneratedTimestamp
+                                // otherwise, an exception will be thrown indicating autoGeneratedTimestamp should not be set
+                                // while request id is already set (id is set because we have already sent the request before).
+                                IndexRequest newReuqest = new IndexRequest(indexRequest.index());
+                                newReuqest.source(indexRequest.source(), indexRequest.getContentType());
+                                threadPool.schedule(() -> saveIteration(newReuqest, detectorId, backoff), nextDelay, ThreadPool.Names.SAME);
+                            }
+                        }
+                    )
             );
     }
 }
diff --git a/.../com/amazon/opendistroforelasticsearch/ad/transport/handler/MultiEntityResultHandler.java b/.../com/amazon/opendistroforelasticsearch/ad/transport/handler/MultiEntityResultHandler.java
@@ -132,7 +132,7 @@ public void flush(ADResultBulkRequest currentBulkRequest, String detectorId) {
                                 } else {
                                     throw new AnomalyDetectionException(
                                         detectorId,
-                                        String.format("Unexpected error creating index %s", indexName),
+                                        String.format(Locale.US, "Unexpected error creating index %s", indexName),
                                         exception
                                     );
                                 }
@@ -166,15 +166,16 @@ private void bulk(ADResultBulkRequest currentBulkRequest, String detectorId) {
             .execute(
                 ADResultBulkAction.INSTANCE,
                 currentBulkRequest,
-                ActionListener.<BulkResponse>wrap(response -> LOG.debug(String.format(SUCCESS_SAVING_MSG, detectorId)), exception -> {
-                    LOG.error(String.format(FAIL_TO_SAVE_ERR_MSG, detectorId), exception);
-                    Throwable cause = Throwables.getRootCause(exception);
-                    // too much indexing pressure
-                    // TODO: pause indexing a bit before trying again, ideally with randomized exponential backoff.
-                    if (cause instanceof RejectedExecutionException) {
-                        nodeStateManager.setLastIndexThrottledTime(clock.instant());
-                    }
-                })
+                ActionListener
+                    .<BulkResponse>wrap(response -> LOG.debug(String.format(Locale.US, SUCCESS_SAVING_MSG, detectorId)), exception -> {
+                        LOG.error(String.format(Locale.US, FAIL_TO_SAVE_ERR_MSG, detectorId), exception);
+                        Throwable cause = Throwables.getRootCause(exception);
+                        // too much indexing pressure
+                        // TODO: pause indexing a bit before trying again, ideally with randomized exponential backoff.
+                        if (cause instanceof RejectedExecutionException) {
+                            nodeStateManager.setLastIndexThrottledTime(clock.instant());
+                        }
+                    })
             );
     }
 }
diff --git a/...a/com/amazon/opendistroforelasticsearch/ad/util/MultiResponsesDelegateActionListener.java b/...a/com/amazon/opendistroforelasticsearch/ad/util/MultiResponsesDelegateActionListener.java
@@ -90,7 +90,7 @@ public void onFailure(Exception e) {
     private void finish() {
         if (this.returnOnPartialResults || this.exceptions.size() == 0) {
             if (this.exceptions.size() > 0) {
-                LOG.error(String.format("Although returning result, there exists exceptions: %s", this.exceptions));
+                LOG.error(String.format(Locale.US, "Although returning result, there exists exceptions: %s", this.exceptions));
             }
             handleSavedResponses();
         } else {