OpenSearch

History

Michael Basnight e816ef89a2 Shade external dependencies in the rest client jar This commit removes all external dependencies from the rest client jar and shades them in an 'org.elasticsearch.client' package within the jar using shadowJar gradle plugin. All projects that depended on the existing jar have been converted to using the 'org.elasticsearch.client' package prefixes to interact with the rest client. Closes #25208		2017-07-24 12:55:43 -05:00
..
src/main	Shade external dependencies in the rest client jar	2017-07-24 12:55:43 -05:00
README.md	Add client-benchmark-noop-api-plugin to stress clients even more in benchmarks (#20103 )	2016-08-26 09:05:47 +02:00
build.gradle	Rename client artifacts (#25693 )	2017-07-13 09:44:25 +02:00

README.md

Steps to execute the benchmark

Build client-benchmark-noop-api-plugin with gradle :client:client-benchmark-noop-api-plugin:assemble
Install it on the target host with bin/elasticsearch-plugin install file:///full/path/to/client-benchmark-noop-api-plugin.zip
Start Elasticsearch on the target host (ideally not on the same machine)
Build an uberjar with gradle :client:benchmark:shadowJar and execute it.

Repeat all steps above for the other benchmark candidate.

Example benchmark

In general, you should define a few GC-related settings -Xms8192M -Xmx8192M -XX:+UseConcMarkSweepGC -verbose:gc -XX:+PrintGCDetails and keep an eye on GC activity. You can also define -XX:+PrintCompilation to see JIT activity.

Bulk indexing

Download benchmark data from http://benchmarks.elastic.co/corpora/geonames/documents.json.bz2 and decompress them.

Example command line parameters:

rest bulk 192.168.2.2 ./documents.json geonames type 8647880 5000

The parameters are in order:

Client type: Use either "rest" or "transport"
Benchmark type: Use either "bulk" or "search"
Benchmark target host IP (the host where Elasticsearch is running)
full path to the file that should be bulk indexed
name of the index
name of the (sole) type in the index
number of documents in the file
bulk size

Bulk indexing

Example command line parameters:

rest search 192.168.2.2 geonames "{ \"query\": { \"match_phrase\": { \"name\": \"Sankt Georgen\" } } }\"" 500,1000,1100,1200

The parameters are in order:

Client type: Use either "rest" or "transport"
Benchmark type: Use either "bulk" or "search"
Benchmark target host IP (the host where Elasticsearch is running)
name of the index
a search request body (remember to escape double quotes). The TransportClientBenchmark uses QueryBuilders.wrapperQuery() internally which automatically adds a root key query, so it must not be present in the command line parameter.
A comma-separated list of target throughput rates