/es-membench

es-membench is a simple wrapper script around Rally to run memory-sizing benchmarks.

Primary LanguageShellApache License 2.0Apache-2.0

es-membench

es-membench is a simple wrapper script around Rally to run memory-sizing benchmarks.

Installation

# Install Rally - do this in the directory *next* to your Elasticsearch checkout. This allows you
# to make local changes to Elasticsearch and directly benchmark them.
git clone https://github.com/elastic/rally.git
# make the 'rally' alias callable system-wide
ln -s $(pwd)/rally/rally /usr/local/bin/rally
# Run the initial Rally configuration routine
rally configure

# Install es-membench
git clone https://github.com/danielmitterdorfer/es-membench.git

Usage

Run a benchmark with:

./benchmark.sh

Available command line parameters:

  • --track="TRACK": Rally track to run. The default is geonames.
  • --challenge="CHALLENGE": Challenge to run. The default is append-no-conflicts-index-only.
  • --skip-build: Allows to skip the build. The default is to build Elasticsearch every time.
  • --profile: Enables Java flight recorder with allocation profiling capabilities (requires an Oracle JDK).

You can adapt the Elasticsearch configuration in es-config/cars/config.

You can change track-related settings (like index settings) by modifying track-params.json.

In case of an OutOfMemoryError, heap dumps are stored in ~/.rally/benchmarks/races/RACE_TIMESTAMP/rally-node-0/heapdump.

Caveats

  • Benchmarks are run only locally. As the focus of these benchmarks is rather measuring memory usage instead of getting very accurate performance metrics this is not a major problem. However, analysis on the network layer should not be done locally. Therefore, we recommend to use at least two separate machines for these benchmarks. Also use Rally directly in this case instead of relying on the wrapper script.

License

This software is licensed under the Apache License, version 2 ("ALv2"), quoted below.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.