-
Notifications
You must be signed in to change notification settings - Fork 1.8k
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.
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
Remove legacy versions support for Low-Level RestClient Sniffer library #3087
Comments
Created a Java project that built by Maven to test the behavior of the Sniffer library: Main.java import org.apache.http.HttpHost;
import org.opensearch.client.Node;
import org.opensearch.client.RestClient;
import org.opensearch.client.sniff.Sniffer;
import java.io.IOException;
import java.util.concurrent.TimeUnit;
public class Main {
public static void main(String[] args) throws IOException, InterruptedException {
RestClient restClient = RestClient.builder(new HttpHost("localhost", 9200, "http"))
.build();
Sniffer sniffer = Sniffer.builder(restClient).setSniffIntervalMillis(500).build();
TimeUnit.MILLISECONDS.sleep(100); // wait for sniffer update
for (Node node: restClient.getNodes()) {
System.out.println(node);
}
sniffer.close();
restClient.close();
}
} The dependency in <dependencies>
<!-- https://mvnrepository.com/artifact/org.opensearch.client/opensearch-rest-client-sniffer -->
<dependency>
<groupId>org.opensearch.client</groupId>
<artifactId>opensearch-rest-client-sniffer</artifactId>
<version>1.0.0</version>
</dependency>
</dependencies> Cluster setting:
node 2:
node 3:
Running result of the Java program: [host=http://127.0.0.1:9200, bound=[http://127.0.0.1:9200, http://[::1]:9200], name=node-1.1.0, version=1.1.0, roles=data,ingest,master,remote_cluster_client, attributes={}]
[host=http://127.0.0.1:9201, bound=[http://127.0.0.1:9201, http://[::1]:9201], name=node-2.0, version=2.0.0, roles=data,master, attributes={shard_indexing_pressure_enabled=[true]}]
[host=http://127.0.0.1:9202, bound=[http://[::1]:9202, http://127.0.0.1:9202], name=node-1.3.2, version=1.3.2, roles=data, attributes={shard_indexing_pressure_enabled=[true]}] Actual node roles: $ curl -X GET http://localhost:9200/_cat/nodes\?v
ip heap.percent ram.percent cpu load_1m load_5m load_15m node.role master name
127.0.0.1 18 10 0 0.30 0.17 0.20 d - node-1.3.2
127.0.0.1 17 10 0 0.30 0.17 0.20 d - node-2.0.0
127.0.0.1 18 10 0 0.30 0.17 0.20 dimr * node-1.1.0 |
It shows that the node role is not properly retrieved for OpenSearch node of version 2.0.0, the "master" role is set into the properties of the node by mistake. The issue is validated. |
My following plan is to:
About the unit test, I found there is a shell script to generate the response of Nodes Info API into a file, which will be used for testing the Sniffer parsing the nodes info. |
Is your feature request related to a problem? Please describe.
Since OpenSearch version 2.0 comes out, there are code in Low-level REST Client
Sniffer
library to deal with Legacy ES version 2.x, which may cause inappropriate behavior when communicating with OpenSearch version 2.x:https://github.com/opensearch-project/OpenSearch/blob/1.3.1/client/sniffer/src/main/java/org/opensearch/client/sniff/OpenSearchNodesSniffer.java#L262
Also in the tests, there are codes to test compatibility with Legacy version 2.x 5.x 6.x and 7.x:
https://github.com/opensearch-project/OpenSearch/blob/1.3.1/client/sniffer/src/test/java/org/opensearch/client/sniff/OpenSearchNodesSnifferParseTests.java#L88
RestClient
Sniffer
library:It allows to automatically discover nodes from a running OpenSearch cluster and set them to an existing
RestClient
instance. It retrieves the nodes that belong to the cluster using the Nodes Info API (GET /_nodes/http
) and usesjackson
to parse the obtained json response. It's compatible with Legacy version 2.x and upwards.Describe the solution you'd like
Do manual testing:
After validating:
In OpenSearch version 2.0:
At least remove the logic for Sniffer to be compatible with Legacy version 2.x.
In OpenSearch version 3.0:
Remove support to all legacy versions.
If necessary, add integration test to validate the actual behavior with a real cluster.
Describe alternatives you've considered
Additional context
Related to issue #2748 and #2773
The text was updated successfully, but these errors were encountered: