Add support to cluster stats API for enabling/disabling mapping_stats…

CHANGELOG.md

@@ -5,6 +5,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 
 ## [Unreleased 2.x]
 ### Added
+- Add request param in _cluster/stats API for including/excluding mapping stats and analysis stats in response. ([#15377](https://github.com/opensearch-project/OpenSearch/pull/15377))
 - [Offline Nodes] Adds offline-tasks library containing various interfaces to be used for Offline Background Tasks. ([#13574](https://github.com/opensearch-project/OpenSearch/pull/13574))
 - Fix for hasInitiatedFetching to fix allocation explain and manual reroute APIs (([#14972](https://github.com/opensearch-project/OpenSearch/pull/14972))
 - [Workload Management] Add queryGroupId to Task ([14708](https://github.com/opensearch-project/OpenSearch/pull/14708))

server/src/internalClusterTest/java/org/opensearch/action/admin/cluster/stats/ClusterStatsIT.java

@@ -384,6 +384,49 @@ public void testFieldTypes() {
         }
     }
 
+    public void testIndicesStatsAnalysisAndMappingStatsInclusion() {
+        internalCluster().startNode();
+        ensureGreen();
+
+        client().admin().indices().prepareCreate("test1").setMapping("{\"properties\":{\"foo\":{\"type\": \"keyword\"}}}").get();
+        client().admin()
+            .indices()
+            .prepareCreate("test2")
+            .setMapping(
+                "{\"properties\":{\"foo\":{\"type\": \"keyword\"},\"bar\":{\"properties\":{\"baz\":{\"type\":\"keyword\"},"
+                    + "\"eggplant\":{\"type\":\"integer\"}}}}}"
+            )
+            .get();
+
+        ClusterStatsResponse response = client().admin()
+            .cluster()
+            .prepareClusterStats()
+            .useAggregatedNodeLevelResponses(randomBoolean())
+            .includeMappingStats(false)
+            .includeAnalysisStats(false)
+            .get();
+        assertNull(response.getIndicesStats().getMappings());
+        assertNull(response.getIndicesStats().getAnalysis());
+
+        response = client().admin().cluster().prepareClusterStats().useAggregatedNodeLevelResponses(randomBoolean()).get();
+        assertNotNull(response.getIndicesStats().getAnalysis());
+        assertThat(response.getIndicesStats().getMappings().getFieldTypeStats().size(), equalTo(3));
+        Set<IndexFeatureStats> stats = response.getIndicesStats().getMappings().getFieldTypeStats();
+        for (IndexFeatureStats stat : stats) {
+            switch (stat.getName()) {
+                case "integer":
+                    assertThat(stat.getCount(), greaterThanOrEqualTo(1));
+                    break;
+                case "keyword":
+                    assertThat(stat.getCount(), greaterThanOrEqualTo(3));
+                    break;
+                case "object":
+                    assertThat(stat.getCount(), greaterThanOrEqualTo(1));
+                    break;
+            }
+        }
+    }
+
     public void testNodeRolesWithMasterLegacySettings() throws ExecutionException, InterruptedException {
         int total = 1;
         Settings legacyMasterSettings = Settings.builder()

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

@@ -48,6 +48,10 @@
 @PublicApi(since = "1.0.0")
 public class ClusterStatsRequest extends BaseNodesRequest<ClusterStatsRequest> {
 
+    private boolean includeMappingStats = true;
+
+    private boolean includeAnalysisStats = true;
+
     public ClusterStatsRequest(StreamInput in) throws IOException {
         super(in);
         if (in.getVersion().onOrAfter(Version.V_2_16_0)) {
@@ -73,6 +77,22 @@ public void useAggregatedNodeLevelResponses(boolean useAggregatedNodeLevelRespon
         this.useAggregatedNodeLevelResponses = useAggregatedNodeLevelResponses;
     }
 
+    public void setIncludeMappingStats(boolean setIncludeMappingStats) {
+        this.includeMappingStats = setIncludeMappingStats;
+    }
+
+    public boolean isIncludeMappingStats() {
+        return includeMappingStats;
+    }
+
+    public void setIncludeAnalysisStats(boolean setIncludeAnalysisStats) {
+        this.includeAnalysisStats = setIncludeAnalysisStats;
+    }
+
+    public boolean isIncludeAnalysisStats() {
+        return includeAnalysisStats;
+    }
+
     @Override
     public void writeTo(StreamOutput out) throws IOException {
         super.writeTo(out);

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

@@ -55,4 +55,14 @@ public final ClusterStatsRequestBuilder useAggregatedNodeLevelResponses(boolean
         request.useAggregatedNodeLevelResponses(useAggregatedNodeLevelResponses);
         return this;
     }
+
+    public ClusterStatsRequestBuilder includeMappingStats(boolean value) {
+        request.setIncludeMappingStats(value);
+        return this;
+    }
+
+    public ClusterStatsRequestBuilder includeAnalysisStats(boolean value) {
+        request.setIncludeAnalysisStats(value);
+        return this;
+    }
 }

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

@@ -105,6 +105,35 @@
         this.status = status;
     }
 
+    public ClusterStatsResponse(
+        long timestamp,
+        String clusterUUID,
+        ClusterName clusterName,
+        List<ClusterStatsNodeResponse> nodes,
+        List<FailedNodeException> failures,
+        ClusterState state,
+        ClusterStatsRequest request
+    ) {
+        super(clusterName, nodes, failures);
+        this.clusterUUID = clusterUUID;
+        this.timestamp = timestamp;
+        nodesStats = new ClusterStatsNodes(nodes);
+        indicesStats = new ClusterStatsIndices(
+            nodes,
+            request.isIncludeMappingStats() ? MappingStats.of(state) : null,
+            request.isIncludeAnalysisStats() ? AnalysisStats.of(state) : null
+        );
+        ClusterHealthStatus status = null;
+        for (ClusterStatsNodeResponse response : nodes) {
+            // only the cluster-manager node populates the status
+            if (response.clusterStatus() != null) {
+                status = response.clusterStatus();
+                break;
+            }
+        }
+        this.status = status;
+    }
+
     public String getClusterUUID() {
         return this.clusterUUID;
     }

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

@@ -129,7 +129,8 @@ protected ClusterStatsResponse newResponse(
             clusterService.getClusterName(),
             responses,
             failures,
-            state
+            state,
+            request
         );
     }
 

server/src/main/java/org/opensearch/rest/action/admin/cluster/RestClusterStatsAction.java

@@ -68,6 +68,8 @@ public RestChannelConsumer prepareRequest(final RestRequest request, final NodeC
         clusterStatsRequest.timeout(request.param("timeout"));
         clusterStatsRequest.setIncludeDiscoveryNodes(false);
         clusterStatsRequest.useAggregatedNodeLevelResponses(true);
+        clusterStatsRequest.setIncludeMappingStats(request.paramAsBoolean("include_mapping_stats", true));
+        clusterStatsRequest.setIncludeAnalysisStats(request.paramAsBoolean("include_analysis_stats", true));
         return channel -> client.admin().cluster().clusterStats(clusterStatsRequest, new NodesResponseRestListener<>(channel));
     }
 

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

@@ -0,0 +1,60 @@
+/*
+ * 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.action.admin.cluster.stats;
+
+import org.opensearch.test.OpenSearchTestCase;
+import org.opensearch.test.client.NoOpClient;
+import org.junit.After;
+import org.junit.Before;
+
+public class ClusterStatsRequestBuilderTests extends OpenSearchTestCase {
+
+    private NoOpClient testClient;
+
+    @Override
+    @Before
+    public void setUp() throws Exception {
+        super.setUp();
+        this.testClient = new NoOpClient(getTestName());
+    }
+
+    @Override
+    @After
+    public void tearDown() throws Exception {
+        this.testClient.close();
+        super.tearDown();
+    }
+
+    public void testUseAggregatedNodeLevelResponses() {
+        ClusterStatsRequestBuilder clusterStatsRequestBuilder = new ClusterStatsRequestBuilder(
+            this.testClient,
+            ClusterStatsAction.INSTANCE
+        );
+        clusterStatsRequestBuilder.useAggregatedNodeLevelResponses(false);
+        assertFalse(clusterStatsRequestBuilder.request().useAggregatedNodeLevelResponses());
+    }
+
+    public void testIncludeMappingStats() {
+        ClusterStatsRequestBuilder clusterStatsRequestBuilder = new ClusterStatsRequestBuilder(
+            this.testClient,
+            ClusterStatsAction.INSTANCE
+        );
+        clusterStatsRequestBuilder.includeMappingStats(false);
+        assertFalse(clusterStatsRequestBuilder.request().isIncludeMappingStats());
+    }
+
+    public void testIncludeAnalysisStats() {
+        ClusterStatsRequestBuilder clusterStatsRequestBuilder = new ClusterStatsRequestBuilder(
+            this.testClient,
+            ClusterStatsAction.INSTANCE
+        );
+        clusterStatsRequestBuilder.includeAnalysisStats(false);
+        assertFalse(clusterStatsRequestBuilder.request().isIncludeAnalysisStats());
+    }
+}