renaming stats class and injecting settings to trackers

Signed-off-by: Bharathwaj G <bharath78910@gmail.com>

server/src/main/java/org/opensearch/action/admin/cluster/node/stats/NodeStats.java

@@ -56,7 +56,7 @@
 import org.opensearch.monitor.os.OsStats;
 import org.opensearch.monitor.process.ProcessStats;
 import org.opensearch.node.AdaptiveSelectionStats;
-import org.opensearch.node.NodesPerformanceStats;
+import org.opensearch.node.GlobalPerformanceStats;
 import org.opensearch.script.ScriptCacheStats;
 import org.opensearch.script.ScriptStats;
 import org.opensearch.search.backpressure.stats.SearchBackpressureStats;
@@ -144,7 +144,7 @@ public class NodeStats extends BaseNodeResponse implements ToXContentFragment {
     private SearchPipelineStats searchPipelineStats;
 
     @Nullable
-    private NodesPerformanceStats nodesPerformanceStats;
+    private GlobalPerformanceStats globalPerformanceStats;
 
     public NodeStats(StreamInput in) throws IOException {
         super(in);
@@ -203,9 +203,9 @@ public NodeStats(StreamInput in) throws IOException {
             searchPipelineStats = null;
         }
         if (in.getVersion().onOrAfter(Version.V_3_0_0)) { // make it 2.11 when we backport
-            nodesPerformanceStats = in.readOptionalWriteable(NodesPerformanceStats::new);
+            globalPerformanceStats = in.readOptionalWriteable(GlobalPerformanceStats::new);
         } else {
-            nodesPerformanceStats = null;
+            globalPerformanceStats = null;
         }
     }
 
@@ -225,7 +225,7 @@ public NodeStats(
         @Nullable DiscoveryStats discoveryStats,
         @Nullable IngestStats ingestStats,
         @Nullable AdaptiveSelectionStats adaptiveSelectionStats,
-        @Nullable NodesPerformanceStats nodesPerformanceStats,
+        @Nullable GlobalPerformanceStats globalPerformanceStats,
         @Nullable ScriptCacheStats scriptCacheStats,
         @Nullable IndexingPressureStats indexingPressureStats,
         @Nullable ShardIndexingPressureStats shardIndexingPressureStats,
@@ -250,7 +250,7 @@ public NodeStats(
         this.scriptStats = scriptStats;
         this.discoveryStats = discoveryStats;
         this.ingestStats = ingestStats;
-        this.nodesPerformanceStats = nodesPerformanceStats;
+        this.globalPerformanceStats = globalPerformanceStats;
         this.scriptCacheStats = scriptCacheStats;
         this.indexingPressureStats = indexingPressureStats;
         this.shardIndexingPressureStats = shardIndexingPressureStats;
@@ -356,8 +356,8 @@ public AdaptiveSelectionStats getAdaptiveSelectionStats() {
     }
 
     @Nullable
-    public NodesPerformanceStats getNodesPerformanceStats() {
-        return nodesPerformanceStats;
+    public GlobalPerformanceStats getNodesPerformanceStats() {
+        return globalPerformanceStats;
     }
 
     @Nullable
@@ -447,7 +447,7 @@ public void writeTo(StreamOutput out) throws IOException {
             out.writeOptionalWriteable(searchPipelineStats);
         }
         if (out.getVersion().onOrAfter(Version.V_3_0_0)) { // TODO : make it 2.11 when we backport
-            out.writeOptionalWriteable(nodesPerformanceStats);
+            out.writeOptionalWriteable(globalPerformanceStats);
         }
     }
 

server/src/main/java/org/opensearch/action/admin/cluster/node/stats/NodesStatsRequest.java

@@ -214,7 +214,7 @@ public enum Metric {
         FILE_CACHE_STATS("file_cache"),
         TASK_CANCELLATION("task_cancellation"),
         SEARCH_PIPELINE("search_pipeline"),
-        NODES_PERFORMANCE_STATS("nodes_performance_stats");
+        GLOBAL_PERFORMANCE_STATS("performance_stats");
 
         private String metricName;
 

server/src/main/java/org/opensearch/action/admin/cluster/node/stats/TransportNodesStatsAction.java

@@ -125,7 +125,7 @@ protected NodeStats nodeOperation(NodeStatsRequest nodeStatsRequest) {
             NodesStatsRequest.Metric.FILE_CACHE_STATS.containedIn(metrics),
             NodesStatsRequest.Metric.TASK_CANCELLATION.containedIn(metrics),
             NodesStatsRequest.Metric.SEARCH_PIPELINE.containedIn(metrics),
-            NodesStatsRequest.Metric.NODES_PERFORMANCE_STATS.containedIn(metrics)
+            NodesStatsRequest.Metric.GLOBAL_PERFORMANCE_STATS.containedIn(metrics)
         );
     }
 

server/src/main/java/org/opensearch/node/NodesPerformanceStats.java → server/src/main/java/org/opensearch/node/GlobalPerformanceStats.java

@@ -21,37 +21,40 @@
 import java.util.concurrent.TimeUnit;
 
 /**
- * This class represents collected performance stats of all downstream nodes and the local node
+ * This class represents performance stats such as CPU, Memory and IO resource usage of each node along with the time
+ * elapsed from when the stats were recorded.
  */
-public class NodesPerformanceStats implements Writeable, ToXContentFragment {
-    private final Map<String, NodePerformanceStatistics> nodePerfStats;
+public class GlobalPerformanceStats implements Writeable, ToXContentFragment {
 
-    public NodesPerformanceStats(Map<String, NodePerformanceStatistics> nodePerfStats) {
-        this.nodePerfStats = nodePerfStats;
+    // Map of node id to perf stats of the corresponding node.
+    private final Map<String, NodePerformanceStatistics> nodeIdToPerfStatsMap;
+
+    public GlobalPerformanceStats(Map<String, NodePerformanceStatistics> nodeIdToPerfStatsMap) {
+        this.nodeIdToPerfStatsMap = nodeIdToPerfStatsMap;
     }
 
-    public NodesPerformanceStats(StreamInput in) throws IOException {
-        this.nodePerfStats = in.readMap(StreamInput::readString, NodePerformanceStatistics::new);
+    public GlobalPerformanceStats(StreamInput in) throws IOException {
+        this.nodeIdToPerfStatsMap = in.readMap(StreamInput::readString, NodePerformanceStatistics::new);
     }
 
     @Override
     public void writeTo(StreamOutput out) throws IOException {
-        out.writeMap(this.nodePerfStats, StreamOutput::writeString, (stream, stats) -> stats.writeTo(stream));
+        out.writeMap(this.nodeIdToPerfStatsMap, StreamOutput::writeString, (stream, stats) -> stats.writeTo(stream));
     }
 
     /**
-     * Returns map of node id to perf stats
+     * Returns map of node id to perf stats of the corresponding node.
      */
     public Map<String, NodePerformanceStatistics> getNodeIdToNodePerfStatsMap() {
-        return nodePerfStats;
+        return nodeIdToPerfStatsMap;
     }
 
     @Override
     public XContentBuilder toXContent(XContentBuilder builder, Params params) throws IOException {
-        builder.startObject("nodes_performance_stats");
-        for (String nodeId : nodePerfStats.keySet()) {
+        builder.startObject("performance_stats");
+        for (String nodeId : nodeIdToPerfStatsMap.keySet()) {
             builder.startObject(nodeId);
-            NodePerformanceStatistics perfStats = nodePerfStats.get(nodeId);
+            NodePerformanceStatistics perfStats = nodeIdToPerfStatsMap.get(nodeId);
             if (perfStats != null) {
 
                 builder.field("cpu_utilization_percent", String.format(Locale.ROOT, "%.1f", perfStats.cpuUtilizationPercent));

server/src/main/java/org/opensearch/node/PerformanceCollectorService.java

@@ -74,8 +74,8 @@ public Optional<NodePerformanceStatistics> getNodeStatistics(final String nodeId
         return Optional.ofNullable(nodeIdToPerfStats.get(nodeId)).map(perfStats -> new NodePerformanceStatistics(perfStats));
     }
 
-    public NodesPerformanceStats stats() {
-        return new NodesPerformanceStats(getAllNodeStatistics());
+    public GlobalPerformanceStats stats() {
+        return new GlobalPerformanceStats(getAllNodeStatistics());
     }
 
 }

server/src/main/java/org/opensearch/throttling/tracker/AverageCpuUsageTracker.java

@@ -10,7 +10,6 @@
 
 import org.apache.logging.log4j.LogManager;
 import org.apache.logging.log4j.Logger;
-import org.opensearch.common.settings.ClusterSettings;
 import org.opensearch.common.unit.TimeValue;
 import org.opensearch.monitor.process.ProcessProbe;
 import org.opensearch.threadpool.ThreadPool;
@@ -22,17 +21,8 @@
 public class AverageCpuUsageTracker extends AbstractAverageUsageTracker {
     private static final Logger LOGGER = LogManager.getLogger(AverageCpuUsageTracker.class);
 
-    public AverageCpuUsageTracker(
-        ThreadPool threadPool,
-        TimeValue pollingInterval,
-        TimeValue windowDuration,
-        ClusterSettings clusterSettings
-    ) {
+    public AverageCpuUsageTracker(ThreadPool threadPool, TimeValue pollingInterval, TimeValue windowDuration) {
         super(threadPool, pollingInterval, windowDuration);
-        clusterSettings.addSettingsUpdateConsumer(
-            PerformanceTrackerSettings.GLOBAL_CPU_USAGE_AC_WINDOW_DURATION_SETTING,
-            this::setWindowDuration
-        );
     }
 
     @Override

server/src/main/java/org/opensearch/throttling/tracker/AverageMemoryUsageTracker.java

@@ -10,7 +10,6 @@
 
 import org.apache.logging.log4j.LogManager;
 import org.apache.logging.log4j.Logger;
-import org.opensearch.common.settings.ClusterSettings;
 import org.opensearch.common.unit.TimeValue;
 import org.opensearch.threadpool.ThreadPool;
 
@@ -27,17 +26,8 @@ public class AverageMemoryUsageTracker extends AbstractAverageUsageTracker {
 
     private static final MemoryMXBean MEMORY_MX_BEAN = ManagementFactory.getMemoryMXBean();
 
-    public AverageMemoryUsageTracker(
-        ThreadPool threadPool,
-        TimeValue pollingInterval,
-        TimeValue windowDuration,
-        ClusterSettings clusterSettings
-    ) {
+    public AverageMemoryUsageTracker(ThreadPool threadPool, TimeValue pollingInterval, TimeValue windowDuration) {
         super(threadPool, pollingInterval, windowDuration);
-        clusterSettings.addSettingsUpdateConsumer(
-            PerformanceTrackerSettings.GLOBAL_JVM_USAGE_AC_WINDOW_DURATION_SETTING,
-            this::setWindowDuration
-        );
     }
 
     @Override

server/src/main/java/org/opensearch/throttling/tracker/NodePerformanceTracker.java

@@ -92,15 +92,22 @@ void initialize() {
         cpuUsageTracker = new AverageCpuUsageTracker(
             threadPool,
             performanceTrackerSettings.getCpuPollingInterval(),
-            performanceTrackerSettings.getCpuWindowDuration(),
-            clusterSettings
+            performanceTrackerSettings.getCpuWindowDuration()
+        );
+
+        clusterSettings.addSettingsUpdateConsumer(
+            PerformanceTrackerSettings.GLOBAL_CPU_USAGE_AC_WINDOW_DURATION_SETTING,
+            cpuUsageTracker::setWindowDuration
         );
 
         memoryUsageTracker = new AverageMemoryUsageTracker(
             threadPool,
             performanceTrackerSettings.getMemoryPollingInterval(),
-            performanceTrackerSettings.getMemoryWindowDuration(),
-            clusterSettings
+            performanceTrackerSettings.getMemoryWindowDuration()
+        );
+        clusterSettings.addSettingsUpdateConsumer(
+            PerformanceTrackerSettings.GLOBAL_JVM_USAGE_AC_WINDOW_DURATION_SETTING,
+            memoryUsageTracker::setWindowDuration
         );
     }
 

server/src/test/java/org/opensearch/action/admin/cluster/node/stats/NodeStatsTests.java

@@ -58,8 +58,8 @@
 import org.opensearch.monitor.os.OsStats;
 import org.opensearch.monitor.process.ProcessStats;
 import org.opensearch.node.AdaptiveSelectionStats;
+import org.opensearch.node.GlobalPerformanceStats;
 import org.opensearch.node.NodePerformanceStatistics;
-import org.opensearch.node.NodesPerformanceStats;
 import org.opensearch.node.ResponseCollectorService;
 import org.opensearch.script.ScriptCacheStats;
 import org.opensearch.script.ScriptStats;
@@ -394,14 +394,14 @@ public void testSerialization() throws IOException {
                         assertEquals(aStats.responseTime, bStats.responseTime, 0.01);
                     });
                 }
-                NodesPerformanceStats nodesPerformanceStats = nodeStats.getNodesPerformanceStats();
-                NodesPerformanceStats deserializedNodePerfStats = deserializedNodeStats.getNodesPerformanceStats();
-                if (nodesPerformanceStats == null) {
+                GlobalPerformanceStats globalPerformanceStats = nodeStats.getNodesPerformanceStats();
+                GlobalPerformanceStats deserializedNodePerfStats = deserializedNodeStats.getNodesPerformanceStats();
+                if (globalPerformanceStats == null) {
                     assertNull(deserializedNodePerfStats);
                 } else {
-                    nodesPerformanceStats.getNodeIdToNodePerfStatsMap().forEach((k, v) -> {
-                        NodePerformanceStatistics aPerfStats = nodesPerformanceStats.getNodeIdToNodePerfStatsMap().get(k);
-                        NodePerformanceStatistics bPerfStats = nodesPerformanceStats.getNodeIdToNodePerfStatsMap().get(k);
+                    globalPerformanceStats.getNodeIdToNodePerfStatsMap().forEach((k, v) -> {
+                        NodePerformanceStatistics aPerfStats = globalPerformanceStats.getNodeIdToNodePerfStatsMap().get(k);
+                        NodePerformanceStatistics bPerfStats = globalPerformanceStats.getNodeIdToNodePerfStatsMap().get(k);
                         assertEquals(aPerfStats.getMemoryUtilizationPercent(), bPerfStats.getMemoryUtilizationPercent(), 0.0);
                         assertEquals(aPerfStats.getCpuUtilizationPercent(), bPerfStats.getCpuUtilizationPercent(), 0.0);
                         assertEquals(aPerfStats.getTimestamp(), bPerfStats.getTimestamp());
@@ -770,7 +770,7 @@ public static NodeStats createNodeStats(boolean remoteStoreStats) {
             }
             adaptiveSelectionStats = new AdaptiveSelectionStats(nodeConnections, nodeStats);
         }
-        NodesPerformanceStats nodesPerformanceStats = null;
+        GlobalPerformanceStats globalPerformanceStats = null;
         if (frequently()) {
             int numNodes = randomIntBetween(0, 10);
             Map<String, Long> nodeConnections = new HashMap<>();
@@ -792,7 +792,7 @@ public static NodeStats createNodeStats(boolean remoteStoreStats) {
                     nodePerfStats.put(nodeId, stats);
                 }
             }
-            nodesPerformanceStats = new NodesPerformanceStats(nodePerfStats);
+            globalPerformanceStats = new GlobalPerformanceStats(nodePerfStats);
         }
         ClusterManagerThrottlingStats clusterManagerThrottlingStats = null;
         if (frequently()) {
@@ -825,7 +825,7 @@ public static NodeStats createNodeStats(boolean remoteStoreStats) {
             discoveryStats,
             ingestStats,
             adaptiveSelectionStats,
-            nodesPerformanceStats,
+            globalPerformanceStats,
             scriptCacheStats,
             null,
             null,