Javadoc and packages update.

Signed-off-by: Filip Drobnjakovic <drobnjakovicfilip@gmail.com>
opensearch-project · May 15, 2023 · fa526e9 · fa526e9
1 parent 1bced67
commit fa526e9
Show file tree

Hide file tree

Showing 21 changed files with 35 additions and 32 deletions.
diff --git a/src/main/java/org/opensearch/performanceanalyzer/commons/collectors/StatsCollector.java b/src/main/java/org/opensearch/performanceanalyzer/commons/collectors/StatsCollector.java
@@ -21,7 +21,7 @@
 import org.apache.logging.log4j.LogManager;
 import org.apache.logging.log4j.Logger;
 import org.opensearch.performanceanalyzer.commons.config.PluginSettings;
-import org.opensearch.performanceanalyzer.commons.format.StatsCollectorFormatter;
+import org.opensearch.performanceanalyzer.commons.formatter.StatsCollectorFormatter;
 import org.opensearch.performanceanalyzer.commons.metrics.MetricsConfiguration;
 import org.opensearch.performanceanalyzer.commons.stats.CommonStats;
 

diff --git a/...yzer/commons/format/DefaultFormatter.java → ...r/commons/formatter/DefaultFormatter.java b/...yzer/commons/format/DefaultFormatter.java → ...r/commons/formatter/DefaultFormatter.java
@@ -3,7 +3,7 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
-package org.opensearch.performanceanalyzer.commons.format;
+package org.opensearch.performanceanalyzer.commons.formatter;
 
 
 import java.util.ArrayList;
@@ -13,9 +13,9 @@
 import java.util.Map;
 import org.opensearch.performanceanalyzer.commons.metrics.MeasurementSet;
 import org.opensearch.performanceanalyzer.commons.stats.Statistics;
-import org.opensearch.performanceanalyzer.commons.stats.impl.vals.AggregateValue;
-import org.opensearch.performanceanalyzer.commons.stats.impl.vals.NamedAggregateValue;
-import org.opensearch.performanceanalyzer.commons.stats.impl.vals.Value;
+import org.opensearch.performanceanalyzer.commons.stats.vals.AggregateValue;
+import org.opensearch.performanceanalyzer.commons.stats.vals.NamedAggregateValue;
+import org.opensearch.performanceanalyzer.commons.stats.vals.Value;
 
 public class DefaultFormatter implements Formatter {
     private Map<MeasurementSet, Map<Statistics, List<Value>>> map;

diff --git a/...nceanalyzer/commons/format/Formatter.java → ...analyzer/commons/formatter/Formatter.java b/...nceanalyzer/commons/format/Formatter.java → ...analyzer/commons/formatter/Formatter.java
@@ -3,7 +3,7 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
-package org.opensearch.performanceanalyzer.commons.format;
+package org.opensearch.performanceanalyzer.commons.formatter;
 
 
 import org.opensearch.performanceanalyzer.commons.metrics.MeasurementSet;

diff --git a/...mmons/format/StatsCollectorFormatter.java → ...ns/formatter/StatsCollectorFormatter.java b/...mmons/format/StatsCollectorFormatter.java → ...ns/formatter/StatsCollectorFormatter.java
@@ -3,7 +3,7 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
-package org.opensearch.performanceanalyzer.commons.format;
+package org.opensearch.performanceanalyzer.commons.formatter;
 
 
 import java.util.ArrayList;

diff --git a/src/main/java/org/opensearch/performanceanalyzer/commons/metrics/MetricsConfiguration.java b/src/main/java/org/opensearch/performanceanalyzer/commons/metrics/MetricsConfiguration.java
@@ -23,7 +23,10 @@ public MetricConfig(int samplingInterval, int rotationInterval) {
             this.rotationInterval = rotationInterval;
         }
     }
-
+    /*
+    With this refactoring, the CONFIG_MAP initialization has been moved out
+    and will be statically initialized within the PerformanceAnalyzerApp
+     */
     public static final Map<Class, MetricConfig> CONFIG_MAP = new HashMap<>();
     public static final MetricConfig cdefault;
 

diff --git a/src/main/java/org/opensearch/performanceanalyzer/commons/stats/CommonStats.java b/src/main/java/org/opensearch/performanceanalyzer/commons/stats/CommonStats.java
@@ -5,8 +5,8 @@
 
 package org.opensearch.performanceanalyzer.commons.stats;
 
-/* Catalogue class that is to be populated upon PerformanceAnalyzerApp class load
-and to be used by both PA and PA-RCA as well as commons repo.
+/* Catalog Operational Metrics class that is to be populated upon PerformanceAnalyzerApp
+class load and to be used by both PA and PA-RCA.
  */
 public class CommonStats {
     public static SampleAggregator RCA_GRAPH_METRICS_AGGREGATOR,

diff --git a/src/main/java/org/opensearch/performanceanalyzer/commons/stats/SampleAggregator.java b/src/main/java/org/opensearch/performanceanalyzer/commons/stats/SampleAggregator.java
@@ -18,7 +18,7 @@
 import java.util.concurrent.atomic.AtomicLong;
 import org.apache.logging.log4j.LogManager;
 import org.apache.logging.log4j.Logger;
-import org.opensearch.performanceanalyzer.commons.format.Formatter;
+import org.opensearch.performanceanalyzer.commons.formatter.Formatter;
 import org.opensearch.performanceanalyzer.commons.metrics.MeasurementSet;
 import org.opensearch.performanceanalyzer.commons.stats.impl.Count;
 import org.opensearch.performanceanalyzer.commons.stats.impl.IStatistic;
@@ -28,7 +28,7 @@
 import org.opensearch.performanceanalyzer.commons.stats.impl.NamedCounter;
 import org.opensearch.performanceanalyzer.commons.stats.impl.Sample;
 import org.opensearch.performanceanalyzer.commons.stats.impl.Sum;
-import org.opensearch.performanceanalyzer.commons.stats.impl.vals.Value;
+import org.opensearch.performanceanalyzer.commons.stats.vals.Value;
 
 /**
  * This class is mainly to collect stats between runs of the RCA framework before we can write them

diff --git a/src/main/java/org/opensearch/performanceanalyzer/commons/stats/StatsReporter.java b/src/main/java/org/opensearch/performanceanalyzer/commons/stats/StatsReporter.java
@@ -8,7 +8,7 @@
 
 import com.google.common.annotations.VisibleForTesting;
 import java.util.List;
-import org.opensearch.performanceanalyzer.commons.format.Formatter;
+import org.opensearch.performanceanalyzer.commons.formatter.Formatter;
 import org.opensearch.performanceanalyzer.commons.metrics.MeasurementSet;
 
 /**

diff --git a/src/main/java/org/opensearch/performanceanalyzer/commons/stats/impl/Count.java b/src/main/java/org/opensearch/performanceanalyzer/commons/stats/impl/Count.java
@@ -10,7 +10,7 @@
 import java.util.List;
 import java.util.concurrent.atomic.AtomicLong;
 import org.opensearch.performanceanalyzer.commons.stats.Statistics;
-import org.opensearch.performanceanalyzer.commons.stats.impl.vals.AggregateValue;
+import org.opensearch.performanceanalyzer.commons.stats.vals.AggregateValue;
 
 public class Count implements IStatistic<AggregateValue> {
     private AtomicLong counter;

diff --git a/src/main/java/org/opensearch/performanceanalyzer/commons/stats/impl/IStatistic.java b/src/main/java/org/opensearch/performanceanalyzer/commons/stats/impl/IStatistic.java
@@ -8,7 +8,7 @@
 
 import java.util.Collection;
 import org.opensearch.performanceanalyzer.commons.stats.Statistics;
-import org.opensearch.performanceanalyzer.commons.stats.impl.vals.Value;
+import org.opensearch.performanceanalyzer.commons.stats.vals.Value;
 
 /** This is the template of the statistic classes. Max, min etc. all follow this template. */
 public interface IStatistic<V extends Value> {

diff --git a/src/main/java/org/opensearch/performanceanalyzer/commons/stats/impl/Mean.java b/src/main/java/org/opensearch/performanceanalyzer/commons/stats/impl/Mean.java
@@ -10,7 +10,7 @@
 import java.util.Collections;
 import java.util.List;
 import org.opensearch.performanceanalyzer.commons.stats.Statistics;
-import org.opensearch.performanceanalyzer.commons.stats.impl.vals.AggregateValue;
+import org.opensearch.performanceanalyzer.commons.stats.vals.AggregateValue;
 
 public class Mean implements IStatistic<AggregateValue> {
     private BigInteger sum;

diff --git a/src/main/java/org/opensearch/performanceanalyzer/commons/stats/impl/MinMaxCommon.java b/src/main/java/org/opensearch/performanceanalyzer/commons/stats/impl/MinMaxCommon.java
@@ -8,7 +8,7 @@
 
 import java.util.Collections;
 import java.util.List;
-import org.opensearch.performanceanalyzer.commons.stats.impl.vals.NamedAggregateValue;
+import org.opensearch.performanceanalyzer.commons.stats.vals.NamedAggregateValue;
 
 /**
  * This is a utility class that is shares methods that are used for statistics where values are

diff --git a/src/main/java/org/opensearch/performanceanalyzer/commons/stats/impl/NamedCounter.java b/src/main/java/org/opensearch/performanceanalyzer/commons/stats/impl/NamedCounter.java
@@ -12,7 +12,7 @@
 import org.apache.logging.log4j.LogManager;
 import org.apache.logging.log4j.Logger;
 import org.opensearch.performanceanalyzer.commons.stats.Statistics;
-import org.opensearch.performanceanalyzer.commons.stats.impl.vals.NamedAggregateValue;
+import org.opensearch.performanceanalyzer.commons.stats.vals.NamedAggregateValue;
 
 public class NamedCounter implements IStatistic<NamedAggregateValue> {
 

diff --git a/src/main/java/org/opensearch/performanceanalyzer/commons/stats/impl/Sample.java b/src/main/java/org/opensearch/performanceanalyzer/commons/stats/impl/Sample.java
@@ -9,7 +9,7 @@
 import java.util.Collections;
 import java.util.List;
 import org.opensearch.performanceanalyzer.commons.stats.Statistics;
-import org.opensearch.performanceanalyzer.commons.stats.impl.vals.Value;
+import org.opensearch.performanceanalyzer.commons.stats.vals.Value;
 
 public class Sample implements IStatistic<Value> {
     private Number value;

diff --git a/src/main/java/org/opensearch/performanceanalyzer/commons/stats/impl/Sum.java b/src/main/java/org/opensearch/performanceanalyzer/commons/stats/impl/Sum.java
@@ -10,7 +10,7 @@
 import java.util.List;
 import java.util.concurrent.atomic.AtomicLong;
 import org.opensearch.performanceanalyzer.commons.stats.Statistics;
-import org.opensearch.performanceanalyzer.commons.stats.impl.vals.AggregateValue;
+import org.opensearch.performanceanalyzer.commons.stats.vals.AggregateValue;
 
 public class Sum implements IStatistic<AggregateValue> {
     private AtomicLong sum;

diff --git a/...mmons/stats/impl/vals/AggregateValue.java → ...er/commons/stats/vals/AggregateValue.java b/...mmons/stats/impl/vals/AggregateValue.java → ...er/commons/stats/vals/AggregateValue.java
@@ -3,11 +3,11 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
-package org.opensearch.performanceanalyzer.commons.stats.impl.vals;
+package org.opensearch.performanceanalyzer.commons.stats.vals;
 
 
 import java.util.Objects;
-import org.opensearch.performanceanalyzer.commons.format.Formatter;
+import org.opensearch.performanceanalyzer.commons.formatter.Formatter;
 import org.opensearch.performanceanalyzer.commons.metrics.MeasurementSet;
 import org.opensearch.performanceanalyzer.commons.stats.Statistics;
 

diff --git a/.../stats/impl/vals/NamedAggregateValue.java → ...mmons/stats/vals/NamedAggregateValue.java b/.../stats/impl/vals/NamedAggregateValue.java → ...mmons/stats/vals/NamedAggregateValue.java
@@ -3,11 +3,11 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
-package org.opensearch.performanceanalyzer.commons.stats.impl.vals;
+package org.opensearch.performanceanalyzer.commons.stats.vals;
 
 
 import java.util.Objects;
-import org.opensearch.performanceanalyzer.commons.format.Formatter;
+import org.opensearch.performanceanalyzer.commons.formatter.Formatter;
 import org.opensearch.performanceanalyzer.commons.metrics.MeasurementSet;
 import org.opensearch.performanceanalyzer.commons.stats.Statistics;
 

diff --git a/...r/commons/stats/impl/vals/NamedValue.java → ...alyzer/commons/stats/vals/NamedValue.java b/...r/commons/stats/impl/vals/NamedValue.java → ...alyzer/commons/stats/vals/NamedValue.java
@@ -3,7 +3,7 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
-package org.opensearch.performanceanalyzer.commons.stats.impl.vals;
+package org.opensearch.performanceanalyzer.commons.stats.vals;
 
 
 import java.util.Objects;

diff --git a/...alyzer/commons/stats/impl/vals/Value.java → ...nceanalyzer/commons/stats/vals/Value.java b/...alyzer/commons/stats/impl/vals/Value.java → ...nceanalyzer/commons/stats/vals/Value.java
@@ -3,11 +3,11 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
-package org.opensearch.performanceanalyzer.commons.stats.impl.vals;
+package org.opensearch.performanceanalyzer.commons.stats.vals;
 
 
 import java.util.Objects;
-import org.opensearch.performanceanalyzer.commons.format.Formatter;
+import org.opensearch.performanceanalyzer.commons.formatter.Formatter;
 import org.opensearch.performanceanalyzer.commons.metrics.MeasurementSet;
 import org.opensearch.performanceanalyzer.commons.stats.Statistics;
 

diff --git a/src/test/java/org/opensearch/performanceanalyzer/commons/stats/SampleAggregatorTest.java b/src/test/java/org/opensearch/performanceanalyzer/commons/stats/SampleAggregatorTest.java
@@ -16,13 +16,13 @@
 import java.util.Set;
 import org.junit.Assert;
 import org.junit.Test;
-import org.opensearch.performanceanalyzer.commons.format.DefaultFormatter;
+import org.opensearch.performanceanalyzer.commons.formatter.DefaultFormatter;
 import org.opensearch.performanceanalyzer.commons.metrics.MeasurementSet;
 import org.opensearch.performanceanalyzer.commons.metrics.MeasurementSetTestHelper;
 import org.opensearch.performanceanalyzer.commons.stats.impl.IStatistic;
-import org.opensearch.performanceanalyzer.commons.stats.impl.vals.AggregateValue;
-import org.opensearch.performanceanalyzer.commons.stats.impl.vals.NamedAggregateValue;
-import org.opensearch.performanceanalyzer.commons.stats.impl.vals.Value;
+import org.opensearch.performanceanalyzer.commons.stats.vals.AggregateValue;
+import org.opensearch.performanceanalyzer.commons.stats.vals.NamedAggregateValue;
+import org.opensearch.performanceanalyzer.commons.stats.vals.Value;
 
 public class SampleAggregatorTest {
 

diff --git a/src/test/java/org/opensearch/performanceanalyzer/commons/stats/impl/NamedCounterTest.java b/src/test/java/org/opensearch/performanceanalyzer/commons/stats/impl/NamedCounterTest.java
@@ -8,7 +8,7 @@
 
 import org.junit.Assert;
 import org.junit.Test;
-import org.opensearch.performanceanalyzer.commons.stats.impl.vals.NamedAggregateValue;
+import org.opensearch.performanceanalyzer.commons.stats.vals.NamedAggregateValue;
 
 public class NamedCounterTest {