Port pr 688 (#693)

* [Feature] adds index_uuid as a tag in node stats all shard metrics (#680) (#689) * Adds index_uuid as a dimension for node stats col Signed-off-by: Atharva Sharma <[email protected]> * updates gauge usage and added index_uuid as tag Signed-off-by: Atharva Sharma <[email protected]> * removed incomplete collector Signed-off-by: Atharva Sharma <[email protected]> * fixed UTs after gauge changes Signed-off-by: Atharva Sharma <[email protected]> * addressed comments Signed-off-by: Atharva Sharma <[email protected]> * reverted gauge related changes Signed-off-by: Atharva Sharma <[email protected]> --------- Signed-off-by: Atharva Sharma <[email protected]> (cherry picked from commit 948b54a) Co-authored-by: Atharva Sharma <[email protected]> * Adds the listener for resource utilization metrics (#687) (#688) * Adds the listener for resource utilization metrics Signed-off-by: Gagan Juneja <[email protected]> Co-authored-by: Gagan Juneja <[email protected]> (cherry picked from commit c95feb6) Co-authored-by: Gagan Juneja <[email protected]> --------- Co-authored-by: opensearch-trigger-bot[bot] <98922864+opensearch-trigger-bot[bot]@users.noreply.github.com> Co-authored-by: Atharva Sharma <[email protected]>
opensearch-project · Jul 26, 2024 · 4f64957 · 4f64957
1 parent 937bd0b
commit 4f64957
Show file tree

Hide file tree

Showing 18 changed files with 1,139 additions and 28 deletions.
diff --git a/src/main/java/org/opensearch/performanceanalyzer/PerformanceAnalyzerPlugin.java b/src/main/java/org/opensearch/performanceanalyzer/PerformanceAnalyzerPlugin.java
@@ -85,7 +85,9 @@
 import org.opensearch.performanceanalyzer.http_action.whoami.TransportWhoAmIAction;
 import org.opensearch.performanceanalyzer.http_action.whoami.WhoAmIAction;
 import org.opensearch.performanceanalyzer.listener.PerformanceAnalyzerSearchListener;
+import org.opensearch.performanceanalyzer.listener.RTFPerformanceAnalyzerSearchListener;
 import org.opensearch.performanceanalyzer.transport.PerformanceAnalyzerTransportInterceptor;
+import org.opensearch.performanceanalyzer.transport.RTFPerformanceAnalyzerTransportInterceptor;
 import org.opensearch.performanceanalyzer.util.Utils;
 import org.opensearch.performanceanalyzer.writer.EventLogQueueProcessor;
 import org.opensearch.plugins.ActionPlugin;
@@ -298,7 +300,10 @@ public List<ActionFilter> getActionFilters() {
     public void onIndexModule(IndexModule indexModule) {
         PerformanceAnalyzerSearchListener performanceanalyzerSearchListener =
                 new PerformanceAnalyzerSearchListener(performanceAnalyzerController);
+        RTFPerformanceAnalyzerSearchListener rtfPerformanceAnalyzerSearchListener =
+                new RTFPerformanceAnalyzerSearchListener(performanceAnalyzerController);
         indexModule.addSearchOperationListener(performanceanalyzerSearchListener);
+        indexModule.addSearchOperationListener(rtfPerformanceAnalyzerSearchListener);
     }
 
     // follower check, leader check
@@ -326,8 +331,9 @@ public void onDiscovery(Discovery discovery) {
     @Override
     public List<TransportInterceptor> getTransportInterceptors(
             NamedWriteableRegistry namedWriteableRegistry, ThreadContext threadContext) {
-        return singletonList(
-                new PerformanceAnalyzerTransportInterceptor(performanceAnalyzerController));
+        return Arrays.asList(
+                new PerformanceAnalyzerTransportInterceptor(performanceAnalyzerController),
+                new RTFPerformanceAnalyzerTransportInterceptor(performanceAnalyzerController));
     }
 
     @Override

diff --git a/...earch/performanceanalyzer/collectors/telemetry/RTFNodeStatsAllShardsMetricsCollector.java b/...earch/performanceanalyzer/collectors/telemetry/RTFNodeStatsAllShardsMetricsCollector.java
@@ -143,8 +143,7 @@ configOverridesWrapper, getCollectorName())) {
                 // Populating value for the first run.
                 recordMetrics(
                         new NodeStatsMetricsAllShardsPerCollectionStatus(currentShardStats),
-                        shardId.getIndexName(),
-                        String.valueOf(shardId.id()));
+                        shardId);
                 continue;
             }
             ShardStats prevShardStats = prevPerShardStats.get(shardId);
@@ -153,15 +152,14 @@ configOverridesWrapper, getCollectorName())) {
                 // run.
                 recordMetrics(
                         new NodeStatsMetricsAllShardsPerCollectionStatus(currentShardStats),
-                        shardId.getIndexName(),
-                        String.valueOf(shardId.id()));
+                        shardId);
                 continue;
             }
             NodeStatsMetricsAllShardsPerCollectionStatus prevValue =
                     new NodeStatsMetricsAllShardsPerCollectionStatus(prevShardStats);
             NodeStatsMetricsAllShardsPerCollectionStatus currValue =
                     new NodeStatsMetricsAllShardsPerCollectionStatus(currentShardStats);
-            populateDiffMetricValue(prevValue, currValue, shardId.getIndexName(), shardId.id());
+            populateDiffMetricValue(prevValue, currValue, shardId);
         }
     }
 
@@ -243,13 +241,20 @@ public void populatePerShardStats(IndicesService indicesService) {
     }
 
     private void recordMetrics(
-            NodeStatsMetricsAllShardsPerCollectionStatus metrics,
-            String indexName,
-            String shardId) {
+            NodeStatsMetricsAllShardsPerCollectionStatus metrics, ShardId shardId) {
         Tags nodeStatsMetricsTag =
                 Tags.create()
-                        .addTag(RTFMetrics.CommonDimension.INDEX_NAME.toString(), indexName)
-                        .addTag(RTFMetrics.CommonDimension.SHARD_ID.toString(), shardId);
+                        .addTag(
+                                RTFMetrics.CommonDimension.INDEX_NAME.toString(),
+                                shardId.getIndexName())
+                        .addTag(
+                                RTFMetrics.CommonDimension.SHARD_ID.toString(),
+                                String.valueOf(shardId.getId()));
+
+        if (shardId.getIndex() != null) {
+            nodeStatsMetricsTag.addTag(
+                    RTFMetrics.CommonDimension.INDEX_UUID.toString(), shardId.getIndex().getUUID());
+        }
 
         cacheQueryMissMetrics.add(metrics.getQueryCacheMissCount(), nodeStatsMetricsTag);
         cacheQuerySizeMetrics.add(metrics.getQueryCacheInBytes(), nodeStatsMetricsTag);
@@ -267,8 +272,7 @@ private void recordMetrics(
     public void populateDiffMetricValue(
             NodeStatsMetricsAllShardsPerCollectionStatus prevValue,
             NodeStatsMetricsAllShardsPerCollectionStatus currValue,
-            String indexName,
-            int shardId) {
+            ShardId shardId) {
 
         NodeStatsMetricsAllShardsPerCollectionStatus metrics =
                 new NodeStatsMetricsAllShardsPerCollectionStatus(
@@ -289,7 +293,7 @@ public void populateDiffMetricValue(
                                 0),
                         currValue.requestCacheInBytes);
 
-        recordMetrics(metrics, indexName, String.valueOf(shardId));
+        recordMetrics(metrics, shardId);
     }
 
     public static class NodeStatsMetricsAllShardsPerCollectionStatus extends MetricStatus {

diff --git a/src/main/java/org/opensearch/performanceanalyzer/config/PerformanceAnalyzerController.java b/src/main/java/org/opensearch/performanceanalyzer/config/PerformanceAnalyzerController.java
@@ -383,4 +383,13 @@ public boolean isCollectorDisabled(
 
         return disabledCollectorsList.contains(collectorName);
     }
+
+    /**
+     * Collectors Setting value.
+     *
+     * @return collectorsSettingValue
+     */
+    public int getCollectorsRunModeValue() {
+        return collectorsSettingValue;
+    }
 }
diff --git a/...n/java/org/opensearch/performanceanalyzer/listener/PerformanceAnalyzerSearchListener.java b/...n/java/org/opensearch/performanceanalyzer/listener/PerformanceAnalyzerSearchListener.java
@@ -7,6 +7,7 @@
 
 import static org.opensearch.performanceanalyzer.commons.stats.metrics.StatExceptionCode.OPENSEARCH_REQUEST_INTERCEPTOR_ERROR;
 
+import com.google.common.annotations.VisibleForTesting;
 import org.apache.logging.log4j.LogManager;
 import org.apache.logging.log4j.Logger;
 import org.opensearch.index.shard.SearchOperationListener;
@@ -16,6 +17,7 @@
 import org.opensearch.performanceanalyzer.commons.metrics.MetricsProcessor;
 import org.opensearch.performanceanalyzer.commons.metrics.PerformanceAnalyzerMetrics;
 import org.opensearch.performanceanalyzer.commons.util.ThreadIDUtil;
+import org.opensearch.performanceanalyzer.commons.util.Util;
 import org.opensearch.performanceanalyzer.config.PerformanceAnalyzerController;
 import org.opensearch.search.internal.SearchContext;
 
@@ -36,8 +38,16 @@ public String toString() {
         return PerformanceAnalyzerSearchListener.class.getSimpleName();
     }
 
-    private SearchListener getSearchListener() {
-        return controller.isPerformanceAnalyzerEnabled() ? this : NO_OP_SEARCH_LISTENER;
+    @VisibleForTesting
+    SearchListener getSearchListener() {
+        return isSearchListenerEnabled() ? this : NO_OP_SEARCH_LISTENER;
+    }
+
+    private boolean isSearchListenerEnabled() {
+        return controller.isPerformanceAnalyzerEnabled()
+                && (controller.getCollectorsRunModeValue() == Util.CollectorMode.DUAL.getValue()
+                        || controller.getCollectorsRunModeValue()
+                                == Util.CollectorMode.RCA.getValue());
     }
 
     @Override