OpenSearch

History

Mark Vieira 1287c7d91f [Backport] Replace usages RandomizedTestingTask with built-in Gradle Test (#40978 ) (#40993 ) * Replace usages RandomizedTestingTask with built-in Gradle Test (#40978) This commit replaces the existing RandomizedTestingTask and supporting code with Gradle's built-in JUnit support via the Test task type. Additionally, the previous workaround to disable all tasks named "test" and create new unit testing tasks named "unitTest" has been removed such that the "test" task now runs unit tests as per the normal Gradle Java plugin conventions. (cherry picked from commit 323f312bbc829a63056a79ebe45adced5099f6e6) * Fix forking JVM runner * Don't bump shadow plugin version		2019-04-09 11:52:50 -07:00
..
src/main	Remove NoopRequestBuilders (#36639 )	2018-12-14 18:28:45 +01:00
README.md	Use Gradle wrapper in client benchmark README	2018-11-08 15:32:47 +01:00
build.gradle	[Backport] Replace usages RandomizedTestingTask with built-in Gradle Test (#40978 ) (#40993 )	2019-04-09 11:52:50 -07:00

README.md

Steps to execute the benchmark

Build client-benchmark-noop-api-plugin with ./gradlew :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 machine that runs the benchmarks)
Run the benchmark with

./gradlew -p client/benchmark run --args ' params go here'

Everything in the ' gets sent on the command line to JMH. The leading inside the 's is important. Without it parameters are sometimes sent to gradle.

See below for some example invocations.

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.elasticsearch.org.s3.amazonaws.com/corpora/geonames and decompress them.

Example invocation:

wget http://benchmarks.elasticsearch.org.s3.amazonaws.com/corpora/geonames/documents-2.json.bz2
bzip2 -d documents-2.json.bz2
mv documents-2.json client/benchmark/build
gradlew -p client/benchmark run --args ' rest bulk localhost build/documents-2.json geonames type 8647880 5000'

The parameters are all in the 's and 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

Search

Example invocation:

./gradlew -p client/benchmark run --args ' rest search localhost 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