Skip to content

Use set-based interface for NodesStatsRequest #53637

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 24 commits into from
Mar 26, 2020
Merged

Use set-based interface for NodesStatsRequest #53637

Show file tree
Hide file tree
Changes from 17 commits
Commits
Show all changes
24 commits
Select commit Hold shift + click to select a range
0e5ac6e
Add set-based interface for NodesStatsRequest
williamrandolph Mar 12, 2020
60f8ec6
Remove unused imports
williamrandolph Mar 13, 2020
ed0d521
Add set-based checks to NodesStatsRequestTests
williamrandolph Mar 13, 2020
12131cd
Remove old setters from RestNodesStatsAction
williamrandolph Mar 13, 2020
476f32f
Remove old setters from NodesStatsRequestBuilder
williamrandolph Mar 13, 2020
27be1a7
Remove old getters from TransportNodesStatsAction
williamrandolph Mar 13, 2020
b17c48a
Remove old getters and setters from tests
williamrandolph Mar 13, 2020
4efb83c
Remove old getters from NodesStatsRequest
williamrandolph Mar 13, 2020
61b1215
Remove redundant setter
williamrandolph Mar 13, 2020
69819c5
Replace various uses of old metric setters
williamrandolph Mar 13, 2020
c362d49
Remove old metric setters from NodesStatsRequest
williamrandolph Mar 13, 2020
d06e74f
Make setter variatic instead of set-based
williamrandolph Mar 16, 2020
9ff0b53
Add test for exceptions
williamrandolph Mar 16, 2020
da864a4
Move metric list into stats request
williamrandolph Mar 16, 2020
a743ad8
Rename deserialization helper method
williamrandolph Mar 16, 2020
dc37c4b
Update javadoc
williamrandolph Mar 16, 2020
cb0ac9f
Slight refactor
williamrandolph Mar 16, 2020
d083ede
Merge branch 'master' into nodes-stats-request-interface-refactor
williamrandolph Mar 23, 2020
b877f9f
Simplify set-checking logic.
williamrandolph Mar 23, 2020
25a06b5
Move dispatch map and change token for adaptive selection
williamrandolph Mar 23, 2020
03d1f0d
Remove unused imports
williamrandolph Mar 23, 2020
e88027c
Merge branch 'master' into nodes-stats-request-interface-refactor
williamrandolph Mar 25, 2020
982cb76
Disable bwc tests
williamrandolph Mar 25, 2020
c55cdaf
Merge branch 'master' into nodes-stats-request-interface-refactor
williamrandolph Mar 25, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
242 changes: 77 additions & 165 deletions ...er/src/main/java/org/elasticsearch/action/admin/cluster/node/stats/NodesStatsRequest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,11 +24,16 @@
import org.elasticsearch.action.support.nodes.BaseNodesRequest;
import org.elasticsearch.common.io.stream.StreamInput;
import org.elasticsearch.common.io.stream.StreamOutput;

import java.io.IOException;
import java.util.Arrays;
import java.util.Collections;
import java.util.HashMap;
import java.util.HashSet;
import java.util.Map;
import java.util.Set;
import java.util.SortedSet;
import java.util.TreeSet;
import java.util.function.Consumer;
import java.util.stream.Collectors;

/**
Expand All @@ -49,18 +54,18 @@ public NodesStatsRequest(StreamInput in) throws IOException {
indices = new CommonStatsFlags(in);
requestedMetrics.clear();
if (in.getVersion().before(Version.V_7_7_0)) {
addOrRemoveMetric(in.readBoolean(), Metric.OS.metricName());
addOrRemoveMetric(in.readBoolean(), Metric.PROCESS.metricName());
addOrRemoveMetric(in.readBoolean(), Metric.JVM.metricName());
addOrRemoveMetric(in.readBoolean(), Metric.THREAD_POOL.metricName());
addOrRemoveMetric(in.readBoolean(), Metric.FS.metricName());
addOrRemoveMetric(in.readBoolean(), Metric.TRANSPORT.metricName());
addOrRemoveMetric(in.readBoolean(), Metric.HTTP.metricName());
addOrRemoveMetric(in.readBoolean(), Metric.BREAKER.metricName());
addOrRemoveMetric(in.readBoolean(), Metric.SCRIPT.metricName());
addOrRemoveMetric(in.readBoolean(), Metric.DISCOVERY.metricName());
addOrRemoveMetric(in.readBoolean(), Metric.INGEST.metricName());
addOrRemoveMetric(in.readBoolean(), Metric.ADAPTIVE_SELECTION.metricName());
optionallyAddMetric(in.readBoolean(), Metric.OS.metricName());
optionallyAddMetric(in.readBoolean(), Metric.PROCESS.metricName());
optionallyAddMetric(in.readBoolean(), Metric.JVM.metricName());
optionallyAddMetric(in.readBoolean(), Metric.THREAD_POOL.metricName());
optionallyAddMetric(in.readBoolean(), Metric.FS.metricName());
optionallyAddMetric(in.readBoolean(), Metric.TRANSPORT.metricName());
optionallyAddMetric(in.readBoolean(), Metric.HTTP.metricName());
optionallyAddMetric(in.readBoolean(), Metric.BREAKER.metricName());
optionallyAddMetric(in.readBoolean(), Metric.SCRIPT.metricName());
optionallyAddMetric(in.readBoolean(), Metric.DISCOVERY.metricName());
optionallyAddMetric(in.readBoolean(), Metric.INGEST.metricName());
optionallyAddMetric(in.readBoolean(), Metric.ADAPTIVE_SELECTION.metricName());
} else {
requestedMetrics.addAll(in.readStringList());
}
Expand Down Expand Up @@ -92,10 +97,21 @@ public NodesStatsRequest clear() {
return this;
}

/**
* Get indices. Handles separately from other metrics because it may or
* may not have submetrics.
* @return flags indicating which indices stats to return
*/
public CommonStatsFlags indices() {
return indices;
}

/**
* Set indices. Handles separately from other metrics because it may or
* may not involve submetrics.
* @param indices flags indicating which indices stats to return
* @return This object, for request chaining.
*/
public NodesStatsRequest indices(CommonStatsFlags indices) {
this.indices = indices;
return this;
Expand All @@ -114,178 +130,65 @@ public NodesStatsRequest indices(boolean indices) {
}

/**
* Should the node OS be returned.
*/
public boolean os() {
return Metric.OS.containedIn(requestedMetrics);
}

/**
* Should the node OS be returned.
*/
public NodesStatsRequest os(boolean os) {
addOrRemoveMetric(os, Metric.OS.metricName());
return this;
}

/**
* Should the node Process be returned.
*/
public boolean process() {
return Metric.PROCESS.containedIn(requestedMetrics);
}

/**
* Should the node Process be returned.
*/
public NodesStatsRequest process(boolean process) {
addOrRemoveMetric(process, Metric.PROCESS.metricName());
return this;
}

/**
* Should the node JVM be returned.
* Get the names of requested metrics, excluding indices, which are
* handled separately.
*/
public boolean jvm() {
return Metric.JVM.containedIn(requestedMetrics);
}

/**
* Should the node JVM be returned.
*/
public NodesStatsRequest jvm(boolean jvm) {
addOrRemoveMetric(jvm, Metric.JVM.metricName());
return this;
}

/**
* Should the node Thread Pool be returned.
*/
public boolean threadPool() {
return Metric.THREAD_POOL.containedIn(requestedMetrics);
}

/**
* Should the node Thread Pool be returned.
*/
public NodesStatsRequest threadPool(boolean threadPool) {
addOrRemoveMetric(threadPool, Metric.THREAD_POOL.metricName());
return this;
}

/**
* Should the node file system stats be returned.
*/
public boolean fs() {
return Metric.FS.containedIn(requestedMetrics);
}

/**
* Should the node file system stats be returned.
*/
public NodesStatsRequest fs(boolean fs) {
addOrRemoveMetric(fs, Metric.FS.metricName());
return this;
public Set<String> requestedMetrics() {
return Set.copyOf(requestedMetrics);
}

/**
* Should the node Transport be returned.
* Add metric
*/
public boolean transport() {
return Metric.TRANSPORT.containedIn(requestedMetrics);
}

/**
* Should the node Transport be returned.
*/
public NodesStatsRequest transport(boolean transport) {
addOrRemoveMetric(transport, Metric.TRANSPORT.metricName());
return this;
}

/**
* Should the node HTTP be returned.
*/
public boolean http() {
return Metric.HTTP.containedIn(requestedMetrics);
}

/**
* Should the node HTTP be returned.
*/
public NodesStatsRequest http(boolean http) {
addOrRemoveMetric(http, Metric.HTTP.metricName());
return this;
}

public boolean breaker() {
return Metric.BREAKER.containedIn(requestedMetrics);
}

/**
* Should the node's circuit breaker stats be returned.
*/
public NodesStatsRequest breaker(boolean breaker) {
addOrRemoveMetric(breaker, Metric.BREAKER.metricName());
return this;
}

public boolean script() {
return Metric.SCRIPT.containedIn(requestedMetrics);
}

public NodesStatsRequest script(boolean script) {
addOrRemoveMetric(script, Metric.SCRIPT.metricName());
return this;
}


public boolean discovery() {
return Metric.DISCOVERY.containedIn(requestedMetrics);
}

/**
* Should the node's discovery stats be returned.
*/
public NodesStatsRequest discovery(boolean discovery) {
addOrRemoveMetric(discovery, Metric.DISCOVERY.metricName());
public NodesStatsRequest addMetric(String metric) {
if (Metric.allMetrics().contains(metric) == false) {
throw new IllegalStateException("Used an illegal metric: " + metric);
}
requestedMetrics.add(metric);
return this;
}

public boolean ingest() {
return Metric.INGEST.containedIn(requestedMetrics);
}

/**
* Should ingest statistics be returned.
* Add an array of metric names
*/
public NodesStatsRequest ingest(boolean ingest) {
addOrRemoveMetric(ingest, Metric.INGEST.metricName());
public NodesStatsRequest addMetrics(String... metrics) {
// use sorted set for reliable ordering in error messages
SortedSet<String> illegalMetrics = new TreeSet<>();
Set<String> validMetrics = new HashSet<>();
for (String metric : metrics) {
if (Metric.allMetrics().contains(metric)) {
validMetrics.add(metric);
} else {
illegalMetrics.add(metric);
}
}
if (illegalMetrics.isEmpty() == false) {
String plural = illegalMetrics.size() == 1 ? "" : "s";
throw new IllegalStateException("Used illegal metric" + plural + ": " + illegalMetrics);
}
requestedMetrics.addAll(validMetrics);
return this;
}

public boolean adaptiveSelection() {
return Metric.ADAPTIVE_SELECTION.containedIn(requestedMetrics);
}

/**
* Should adaptiveSelection statistics be returned.
* Remove metric
*/
public NodesStatsRequest adaptiveSelection(boolean adaptiveSelection) {
addOrRemoveMetric(adaptiveSelection, Metric.ADAPTIVE_SELECTION.metricName());
public NodesStatsRequest removeMetric(String metric) {
if (Metric.allMetrics().contains(metric) == false) {
throw new IllegalStateException("Used an illegal metric: " + metric);
}
requestedMetrics.remove(metric);
return this;
}

/**
* Helper method for adding and removing metrics.
* Helper method for adding metrics during deserialization.
* @param includeMetric Whether or not to include a metric.
* @param metricName Name of the metric to include or remove.
* @param metricName Name of the metric to add.
*/
private void addOrRemoveMetric(boolean includeMetric, String metricName) {
private void optionallyAddMetric(boolean includeMetric, String metricName) {
if (includeMetric) {
requestedMetrics.add(metricName);
} else {
requestedMetrics.remove(metricName);
}
}

Expand All @@ -311,11 +214,20 @@ public void writeTo(StreamOutput out) throws IOException {
}
}

public static Map<String, Consumer<NodesStatsRequest>> getDispatchMap() {
Map<String, Consumer<NodesStatsRequest>> map = new HashMap<>();
for (Metric metric : Metric.values()) {
map.put(metric.metricName(), request -> request.addMetric(metric.metricName()));
}
map.put("indices", request -> request.indices(true));
return Collections.unmodifiableMap(map);
}

/**
* An enumeration of the "core" sections of metrics that may be requested
* from the nodes stats endpoint. Eventually this list will be pluggable.
*/
private enum Metric {
public enum Metric {
OS("os"),
PROCESS("process"),
JVM("jvm"),
Expand All @@ -327,15 +239,15 @@ private enum Metric {
SCRIPT("script"),
DISCOVERY("discovery"),
INGEST("ingest"),
ADAPTIVE_SELECTION("adaptiveSelection");
ADAPTIVE_SELECTION("adaptiveSelection"); // TODO: Should this be removed?

private String metricName;

Metric(String name) {
this.metricName = name;
}

String metricName() {
public String metricName() {
return this.metricName;
}

Expand Down
Loading