URI path filtering support in cluster stats API (opensearch-project#1…

…5938) * URI path filtering support in cluster stats API Signed-off-by: Swetha Guptha <[email protected]> (cherry picked from commit 1982427) Signed-off-by: Swetha Guptha <[email protected]>
SwethaGuptha · Oct 22, 2024 · a01c0c9 · a01c0c9
1 parent 4ed6a47
commit a01c0c9
Show file tree

Hide file tree

Showing 14 changed files with 1,483 additions and 116 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -25,8 +25,9 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 - Add changes to block calls in cat shards, indices and segments based on dynamic limit settings ([#15986](https://github.com/opensearch-project/OpenSearch/pull/15986))
 - Flat object field use IndexOrDocValuesQuery to optimize query ([#14383](https://github.com/opensearch-project/OpenSearch/issues/14383))
 - Add method to return dynamic SecureTransportParameters from SecureTransportSettingsProvider interface ([#16387](https://github.com/opensearch-project/OpenSearch/pull/16387)
-- Add _list/shards API as paginated alternate to _cat/shards ([#14641](https://github.com/opensearch-project/OpenSearch/pull/14641))
 - [Star Tree - Search] Add support for metric aggregations with/without term query ([15289](https://github.com/opensearch-project/OpenSearch/pull/15289))
+- URI path filtering support in cluster stats API ([#15938](https://github.com/opensearch-project/OpenSearch/pull/15938))
+
 
 ### Dependencies
 - Bump `org.apache.logging.log4j:log4j-core` from 2.23.1 to 2.24.0 ([#15858](https://github.com/opensearch-project/OpenSearch/pull/15858))

diff --git a/qa/rolling-upgrade/src/test/java/org/opensearch/upgrades/ClusterStatsIT.java b/qa/rolling-upgrade/src/test/java/org/opensearch/upgrades/ClusterStatsIT.java
@@ -0,0 +1,67 @@
+/*
+ * SPDX-License-Identifier: Apache-2.0
+ *
+ * The OpenSearch Contributors require contributions made to
+ * this file be licensed under the Apache-2.0 license or a
+ * compatible open source license.
+ */
+
+package org.opensearch.upgrades;
+
+import org.opensearch.Version;
+import org.opensearch.client.Request;
+import org.opensearch.client.Response;
+
+import java.io.IOException;
+import java.util.Collections;
+import java.util.List;
+import java.util.Map;
+
+public class ClusterStatsIT extends AbstractRollingTestCase {
+
+    private final List<String> nodeStatsMetrics = List.of("os", "process", "jvm", "fs", "plugins", "ingest", "network_types", "discovery_types", "packaging_types");
+
+    private final List<String> indicesStatsMetrics = List.of("shards", "docs", "store", "fielddata", "query_cache", "completion", "segments", "analysis", "mappings");
+
+    public void testClusterStats() throws IOException {
+        Response response = client().performRequest(new Request("GET", "/_cluster/stats"));
+        validateClusterStatsWithFilterResponse(response, nodeStatsMetrics, indicesStatsMetrics);
+        if (AbstractRollingTestCase.UPGRADE_FROM_VERSION.onOrAfter(Version.V_2_18_0) || (
+            CLUSTER_TYPE == ClusterType.UPGRADED && Version.CURRENT.onOrAfter(Version.V_2_18_0))) {
+            response = client().performRequest(new Request("GET", "/_cluster/stats/os/nodes/_all"));
+            validateClusterStatsWithFilterResponse(response, List.of("os"), Collections.emptyList());
+            response = client().performRequest(new Request("GET", "/_cluster/stats/indices/mappings/nodes/_all"));
+            validateClusterStatsWithFilterResponse(response, Collections.emptyList(), List.of("mappings"));
+            response = client().performRequest(new Request("GET", "/_cluster/stats/os,indices/mappings/nodes/_all"));
+            validateClusterStatsWithFilterResponse(response, List.of("os"), List.of("mappings"));
+        }
+    }
+
+    private void validateClusterStatsWithFilterResponse(Response response, List<String> requestedNodesStatsMetrics, List<String> requestedIndicesStatsMetrics) throws IOException {
+        assertEquals(200, response.getStatusLine().getStatusCode());
+        Map<String, Object> entity = entityAsMap(response);
+        if (requestedNodesStatsMetrics != null && !requestedNodesStatsMetrics.isEmpty()) {
+            assertTrue(entity.containsKey("nodes"));
+            Map<?, ?> nodesStats = (Map<?, ?>) entity.get("nodes");
+            for (String metric : nodeStatsMetrics) {
+                if (requestedNodesStatsMetrics.contains(metric)) {
+                    assertTrue(nodesStats.containsKey(metric));
+                } else {
+                    assertFalse(nodesStats.containsKey(metric));
+                }
+            }
+        }
+
+        if (requestedIndicesStatsMetrics != null && !requestedIndicesStatsMetrics.isEmpty()) {
+            assertTrue(entity.containsKey("indices"));
+            Map<?, ?> indicesStats = (Map<?, ?>) entity.get("indices");
+            for (String metric : indicesStatsMetrics) {
+                if (requestedIndicesStatsMetrics.contains(metric)) {
+                    assertTrue(indicesStats.containsKey(metric));
+                } else {
+                    assertFalse(indicesStats.containsKey(metric));
+                }
+            }
+        }
+    }
+}