Refactor nodes stats request builders to match requests (#54363) (#54604)

* Refactor nodes stats request builders to match requests (#54363)

* Remove hard-coded setters from NodesInfoRequestBuilder

* Remove hard-coded setters from NodesStatsRequest

* Use static imports to reduce clutter

* Remove uses of old info APIs

Author: williamrandolph

modules/ingest-common/src/test/java/org/elasticsearch/ingest/common/IngestRestartIT.java

@@ -39,6 +39,7 @@
 import java.util.function.Consumer;
 import java.util.function.Function;
 
+import static org.elasticsearch.action.admin.cluster.node.stats.NodesStatsRequest.Metric.INGEST;
 import static org.hamcrest.Matchers.equalTo;
 import static org.hamcrest.Matchers.greaterThanOrEqualTo;
 
@@ -99,7 +100,9 @@ public void testFailureInConditionalProcessor() {
         );
         assertTrue(e.getMessage().contains("this script always fails"));
 
-        NodesStatsResponse r = client().admin().cluster().prepareNodesStats(internalCluster().getNodeNames()).setIngest(true).get();
+        NodesStatsResponse r = client().admin().cluster().prepareNodesStats(internalCluster().getNodeNames())
+            .addMetric(INGEST.metricName())
+            .get();
         int nodeCount = r.getNodes().size();
         for (int k = 0; k < nodeCount; k++) {
             List<IngestStats.ProcessorStat> stats = r.getNodes().get(k).getIngestStats().getProcessorStats().get(pipelineId);

modules/transport-netty4/src/test/java/org/elasticsearch/transport/netty4/Netty4TransportMultiPortIntegrationIT.java

@@ -40,6 +40,7 @@
 import java.util.Arrays;
 import java.util.Locale;
 
+import static org.elasticsearch.action.admin.cluster.node.info.NodesInfoRequest.Metric.TRANSPORT;
 import static org.hamcrest.Matchers.allOf;
 import static org.hamcrest.Matchers.greaterThanOrEqualTo;
 import static org.hamcrest.Matchers.hasKey;
@@ -88,7 +89,7 @@ public void testThatTransportClientCanConnect() throws Exception {
 
     @Network
     public void testThatInfosAreExposed() throws Exception {
-        NodesInfoResponse response = client().admin().cluster().prepareNodesInfo().clear().setTransport(true).get();
+        NodesInfoResponse response = client().admin().cluster().prepareNodesInfo().clear().addMetric(TRANSPORT.metricName()).get();
         for (NodeInfo nodeInfo : response.getNodes()) {
             assertThat(nodeInfo.getTransport().getProfileAddresses().keySet(), hasSize(1));
             assertThat(nodeInfo.getTransport().getProfileAddresses(), hasKey("client1"));

server/src/main/java/org/elasticsearch/action/admin/cluster/node/info/NodesInfoRequestBuilder.java

@@ -22,7 +22,6 @@
 import org.elasticsearch.action.support.nodes.NodesOperationRequestBuilder;
 import org.elasticsearch.client.ElasticsearchClient;
 
-// TODO: This class's interface should match that of NodesInfoRequest
 public class NodesInfoRequestBuilder extends NodesOperationRequestBuilder<NodesInfoRequest, NodesInfoResponse, NodesInfoRequestBuilder> {
 
     public NodesInfoRequestBuilder(ElasticsearchClient client, NodesInfoAction action) {
@@ -46,90 +45,24 @@ public NodesInfoRequestBuilder all() {
     }
 
     /**
-     * Should the node settings be returned.
+     * Add a single metric to the request.
+     *
+     * @param metric Name of metric as a string.
+     * @return This, for request chaining.
      */
-    public NodesInfoRequestBuilder setSettings(boolean settings) {
-        addOrRemoveMetric(settings, NodesInfoRequest.Metric.SETTINGS);
+    public NodesInfoRequestBuilder addMetric(String metric) {
+        request.addMetric(metric);
         return this;
     }
 
     /**
-     * Should the node OS info be returned.
+     * Add an array of metrics to the request.
+     *
+     * @param metrics Metric names as strings.
+     * @return This, for request chaining.
      */
-    public NodesInfoRequestBuilder setOs(boolean os) {
-        addOrRemoveMetric(os, NodesInfoRequest.Metric.OS);
+    public NodesInfoRequestBuilder addMetrics(String... metrics) {
+        request.addMetrics(metrics);
         return this;
     }
-
-    /**
-     * Should the node OS process be returned.
-     */
-    public NodesInfoRequestBuilder setProcess(boolean process) {
-        addOrRemoveMetric(process, NodesInfoRequest.Metric.PROCESS);
-        return this;
-    }
-
-    /**
-     * Should the node JVM info be returned.
-     */
-    public NodesInfoRequestBuilder setJvm(boolean jvm) {
-        addOrRemoveMetric(jvm, NodesInfoRequest.Metric.JVM);
-        return this;
-    }
-
-    /**
-     * Should the node thread pool info be returned.
-     */
-    public NodesInfoRequestBuilder setThreadPool(boolean threadPool) {
-        addOrRemoveMetric(threadPool, NodesInfoRequest.Metric.THREAD_POOL);
-        return this;
-    }
-
-    /**
-     * Should the node Transport info be returned.
-     */
-    public NodesInfoRequestBuilder setTransport(boolean transport) {
-        addOrRemoveMetric(transport, NodesInfoRequest.Metric.TRANSPORT);
-        return this;
-    }
-
-    /**
-     * Should the node HTTP info be returned.
-     */
-    public NodesInfoRequestBuilder setHttp(boolean http) {
-        addOrRemoveMetric(http, NodesInfoRequest.Metric.HTTP);
-        return this;
-    }
-
-    /**
-     * Should the node plugins info be returned.
-     */
-    public NodesInfoRequestBuilder setPlugins(boolean plugins) {
-        addOrRemoveMetric(plugins, NodesInfoRequest.Metric.PLUGINS);
-        return this;
-    }
-
-    /**
-     * Should the node ingest info be returned.
-     */
-    public NodesInfoRequestBuilder setIngest(boolean ingest) {
-        addOrRemoveMetric(ingest, NodesInfoRequest.Metric.INGEST);
-        return this;
-    }
-
-    /**
-     * Should the node indices info be returned.
-     */
-    public NodesInfoRequestBuilder setIndices(boolean indices) {
-        addOrRemoveMetric(indices, NodesInfoRequest.Metric.INDICES);
-        return this;
-    }
-
-    private void addOrRemoveMetric(boolean includeMetric, NodesInfoRequest.Metric metric) {
-        if (includeMetric) {
-            request.addMetric(metric.metricName());
-        } else {
-            request.removeMetric(metric.metricName());
-        }
-    }
 }

server/src/main/java/org/elasticsearch/action/admin/cluster/node/stats/NodesStatsRequestBuilder.java

@@ -47,125 +47,40 @@ public NodesStatsRequestBuilder clear() {
     }
 
     /**
-     * Should the node indices stats be returned.
-     */
-    public NodesStatsRequestBuilder setIndices(boolean indices) {
-        request.indices(indices);
-        return this;
-    }
-
-    public NodesStatsRequestBuilder setBreaker(boolean breaker) {
-        addOrRemoveMetric(breaker, NodesStatsRequest.Metric.BREAKER);
-        return this;
-    }
-
-    public NodesStatsRequestBuilder setScript(boolean script) {
-        addOrRemoveMetric(script, NodesStatsRequest.Metric.SCRIPT);
-        return this;
-    }
-
-    /**
-     * Should the node indices stats be returned.
-     */
-    public NodesStatsRequestBuilder setIndices(CommonStatsFlags indices) {
-        request.indices(indices);
-        return this;
-    }
-
-    /**
-     * Should the node OS stats be returned.
-     */
-    public NodesStatsRequestBuilder setOs(boolean os) {
-        addOrRemoveMetric(os, NodesStatsRequest.Metric.OS);
-        return this;
-    }
-
-    /**
-     * Should the node OS stats be returned.
-     */
-    public NodesStatsRequestBuilder setProcess(boolean process) {
-        addOrRemoveMetric(process, NodesStatsRequest.Metric.PROCESS);
-        return this;
-    }
-
-    /**
-     * Should the node JVM stats be returned.
-     */
-    public NodesStatsRequestBuilder setJvm(boolean jvm) {
-        addOrRemoveMetric(jvm, NodesStatsRequest.Metric.JVM);
-        return this;
-    }
-
-    /**
-     * Should the node thread pool stats be returned.
-     */
-    public NodesStatsRequestBuilder setThreadPool(boolean threadPool) {
-        addOrRemoveMetric(threadPool, NodesStatsRequest.Metric.THREAD_POOL);
-        return this;
-    }
-
-    /**
-     * Should the node file system stats be returned.
+     * Add a single metric to the request.
+     *
+     * @param metric Name of metric as a string.
+     * @return This, for request chaining.
      */
-    public NodesStatsRequestBuilder setFs(boolean fs) {
-        addOrRemoveMetric(fs, NodesStatsRequest.Metric.FS);
+    public NodesStatsRequestBuilder addMetric(String metric) {
+        request.addMetric(metric);
         return this;
     }
 
     /**
-     * Should the node Transport stats be returned.
+     * Add an array of metrics to the request.
+     *
+     * @param metrics Metric names as strings.
+     * @return This, for request chaining.
      */
-    public NodesStatsRequestBuilder setTransport(boolean transport) {
-        addOrRemoveMetric(transport, NodesStatsRequest.Metric.TRANSPORT);
+    public NodesStatsRequestBuilder addMetrics(String... metrics) {
+        request.addMetrics(metrics);
         return this;
     }
 
     /**
-     * Should the node HTTP stats be returned.
-     */
-    public NodesStatsRequestBuilder setHttp(boolean http) {
-        addOrRemoveMetric(http, NodesStatsRequest.Metric.HTTP);
-        return this;
-    }
-
-    /**
-     * Should the discovery stats be returned.
-     */
-    public NodesStatsRequestBuilder setDiscovery(boolean discovery) {
-        addOrRemoveMetric(discovery, NodesStatsRequest.Metric.DISCOVERY);
-        return this;
-    }
-
-    /**
-     * Should ingest statistics be returned.
+     * Should the node indices stats be returned.
      */
-    public NodesStatsRequestBuilder setIngest(boolean ingest) {
-        addOrRemoveMetric(ingest, NodesStatsRequest.Metric.INGEST);
-        return this;
-    }
-
-    public NodesStatsRequestBuilder setAdaptiveSelection(boolean adaptiveSelection) {
-        addOrRemoveMetric(adaptiveSelection, NodesStatsRequest.Metric.ADAPTIVE_SELECTION);
+    public NodesStatsRequestBuilder setIndices(boolean indices) {
+        request.indices(indices);
         return this;
     }
 
     /**
-     * Should script context cache statistics be returned
+     * Should the node indices stats be returned.
      */
-    public NodesStatsRequestBuilder setScriptCache(boolean scriptCache) {
-        addOrRemoveMetric(scriptCache, NodesStatsRequest.Metric.SCRIPT_CACHE);
+    public NodesStatsRequestBuilder setIndices(CommonStatsFlags indices) {
+        request.indices(indices);
         return this;
     }
-
-    /**
-     * Helper method for adding metrics to a request
-     */
-    private void addOrRemoveMetric(boolean includeMetric, NodesStatsRequest.Metric metric) {
-        if (includeMetric) {
-            request.addMetric(metric.metricName());
-        } else {
-            request.removeMetric(metric.metricName());
-        }
-    }
-
 }

server/src/test/java/org/elasticsearch/action/admin/cluster/stats/ClusterStatsIT.java

@@ -41,6 +41,7 @@
 import java.util.Map;
 import java.util.concurrent.ExecutionException;
 
+import static org.elasticsearch.action.admin.cluster.node.stats.NodesStatsRequest.Metric.OS;
 import static org.hamcrest.Matchers.equalTo;
 import static org.hamcrest.Matchers.is;
 
@@ -193,7 +194,7 @@ public void testValuesSmokeScreen() throws IOException, ExecutionException, Inte
         assertThat(msg, response.nodesStats.getProcess().getMinOpenFileDescriptors(), Matchers.greaterThanOrEqualTo(-1L));
         assertThat(msg, response.nodesStats.getProcess().getMaxOpenFileDescriptors(), Matchers.greaterThanOrEqualTo(-1L));
 
-        NodesStatsResponse nodesStatsResponse = client().admin().cluster().prepareNodesStats().setOs(true).get();
+        NodesStatsResponse nodesStatsResponse = client().admin().cluster().prepareNodesStats().addMetric(OS.metricName()).get();
         long total = 0;
         long free = 0;
         long used = 0;

server/src/test/java/org/elasticsearch/cluster/coordination/ZenDiscoveryIT.java

@@ -47,6 +47,7 @@
 import java.util.concurrent.TimeUnit;
 import java.util.concurrent.TimeoutException;
 
+import static org.elasticsearch.action.admin.cluster.node.stats.NodesStatsRequest.Metric.DISCOVERY;
 import static org.hamcrest.Matchers.containsString;
 import static org.hamcrest.Matchers.equalTo;
 import static org.hamcrest.Matchers.greaterThanOrEqualTo;
@@ -165,7 +166,7 @@ public void testDiscoveryStats() throws Exception {
                 equalTo(0))); // see https://github.com/elastic/elasticsearch/issues/24388
 
         logger.info("--> request node discovery stats");
-        NodesStatsResponse statsResponse = client().admin().cluster().prepareNodesStats().clear().setDiscovery(true).get();
+        NodesStatsResponse statsResponse = client().admin().cluster().prepareNodesStats().clear().addMetric(DISCOVERY.metricName()).get();
         assertThat(statsResponse.getNodes().size(), equalTo(1));
 
         DiscoveryStats stats = statsResponse.getNodes().get(0).getDiscoveryStats();

server/src/test/java/org/elasticsearch/cluster/settings/SettingsFilteringIT.java

@@ -33,6 +33,7 @@
 import java.util.Collection;
 import java.util.List;
 
+import static org.elasticsearch.action.admin.cluster.node.info.NodesInfoRequest.Metric.SETTINGS;
 import static org.elasticsearch.test.ESIntegTestCase.Scope.SUITE;
 import static org.elasticsearch.test.hamcrest.ElasticsearchAssertions.assertAcked;
 import static org.hamcrest.Matchers.equalTo;
@@ -89,7 +90,7 @@ public void testSettingsFiltering() {
     }
 
     public void testNodeInfoIsFiltered() {
-        NodesInfoResponse nodeInfos = client().admin().cluster().prepareNodesInfo().clear().setSettings(true).get();
+        NodesInfoResponse nodeInfos = client().admin().cluster().prepareNodesInfo().clear().addMetric(SETTINGS.metricName()).get();
         for(NodeInfo info : nodeInfos.getNodes()) {
             Settings settings = info.getSettings();
             assertNotNull(settings);

server/src/test/java/org/elasticsearch/index/shard/IndexShardIT.java

@@ -110,6 +110,7 @@
 import static com.carrotsearch.randomizedtesting.RandomizedTest.randomAsciiLettersOfLength;
 import static java.util.Collections.emptyMap;
 import static java.util.Collections.emptySet;
+import static org.elasticsearch.action.admin.cluster.node.stats.NodesStatsRequest.Metric.BREAKER;
 import static org.elasticsearch.action.support.WriteRequest.RefreshPolicy.IMMEDIATE;
 import static org.elasticsearch.action.support.WriteRequest.RefreshPolicy.NONE;
 import static org.elasticsearch.cluster.metadata.IndexMetadata.SETTING_NUMBER_OF_REPLICAS;
@@ -583,7 +584,7 @@ private void checkAccountingBreaker() {
         CircuitBreaker acctBreaker = breakerService.getBreaker(CircuitBreaker.ACCOUNTING);
         long usedMem = acctBreaker.getUsed();
         assertThat(usedMem, greaterThan(0L));
-        NodesStatsResponse response = client().admin().cluster().prepareNodesStats().setIndices(true).setBreaker(true).get();
+        NodesStatsResponse response = client().admin().cluster().prepareNodesStats().setIndices(true).addMetric(BREAKER.metricName()).get();
         NodeStats stats = response.getNodes().get(0);
         assertNotNull(stats);
         SegmentsStats segmentsStats = stats.getIndices().getSegments();

server/src/test/java/org/elasticsearch/index/shard/RemoveCorruptedShardDataCommandIT.java

@@ -89,6 +89,7 @@
 import java.util.stream.Stream;
 import java.util.stream.StreamSupport;
 
+import static org.elasticsearch.action.admin.cluster.node.stats.NodesStatsRequest.Metric.FS;
 import static org.elasticsearch.common.util.CollectionUtils.iterableAsArrayList;
 import static org.elasticsearch.index.query.QueryBuilders.matchAllQuery;
 import static org.elasticsearch.test.hamcrest.ElasticsearchAssertions.assertAcked;
@@ -599,7 +600,7 @@ private Path getPathToShardData(String indexName, String dirSuffix) {
     }
 
     public static Path getPathToShardData(String nodeId, ShardId shardId, String shardPathSubdirectory) {
-        final NodesStatsResponse nodeStatsResponse = client().admin().cluster().prepareNodesStats(nodeId).setFs(true).get();
+        final NodesStatsResponse nodeStatsResponse = client().admin().cluster().prepareNodesStats(nodeId).addMetric(FS.metricName()).get();
         final Set<Path> paths = StreamSupport.stream(nodeStatsResponse.getNodes().get(0).getFs().spliterator(), false)
             .map(nodePath -> PathUtils.get(nodePath.getPath())
                 .resolve(NodeEnvironment.INDICES_FOLDER)