Macrobenchmarking framework for Elasticsearch
Clone or download
danielmitterdorfer Always use remote branch for updates
With this commit we always attempt to checkout the remote branch first.
In a scenario where a user has already cloned the repository but uses
the `--offline` flag the correct branches might not be proper local
tracking branches but are already available on the target machine as
remote branches.

Closes #573
Relates #575
Latest commit 0d84a46 Oct 12, 2018
Permalink
Failed to load latest commit information.
.github Update issue template Jul 19, 2017
benchmarks Introduce explicit index management operations Dec 12, 2017
docs Switch to official approach for HTTP compression Sep 27, 2018
esrally Always use remote branch for updates Oct 12, 2018
scripts More flexible analysis script Jun 18, 2018
tests Always use remote branch for updates Oct 12, 2018
.coveragerc Add coverage configuration Nov 3, 2016
.gitignore Make Rally compatible with Python 3.7 Sep 17, 2018
AUTHORS Update changelog for Rally release 1.0.1 Sep 13, 2018
CHANGELOG.md Update changelog for Rally release 1.0.1 Sep 13, 2018
CONTRIBUTING.md Clarify git workflow for Elastic contributors Aug 24, 2016
Dockerfile Fix broken docker-it tests Oct 11, 2018
LICENSE Simplify first time setup of Rally Dec 3, 2015
MANIFEST.in Script the release process Jun 28, 2016
Makefile Make Rally compatible with Python 3.7 Sep 17, 2018
README.rst State clearly that only Unix is supported Jul 11, 2018
RELEASE.md Add check script and dependency for release make target Mar 12, 2018
changelog.py Show only PRs in changelog Apr 5, 2018
docker-compose.yml Add new Makefile target to run it tests inside Docker May 2, 2018
integration-test.sh Use non-standard port for metrics store in tests Aug 1, 2018
rally Fix venv detection with venv and Rally execution on non master Apr 3, 2018
rallyd Set default PYTHONPATH for rallyd Oct 12, 2017
release-checks.sh Add check script and dependency for release make target Mar 12, 2018
release.sh Disable automatic preparation of offline distro Sep 13, 2018
run.sh Upgrade to Thespian 3.9.3 Aug 27, 2018
setup.cfg Bump pytest* versions and beautify make test output Mar 12, 2018
setup.py Make Rally compatible with Python 3.7 Sep 17, 2018
tox.ini Make Rally compatible with Python 3.7 Sep 17, 2018
version.txt Continue in 1.0.2.dev0 Sep 13, 2018

README.rst

Rally

Rally is the macrobenchmarking framework for Elasticsearch

What is Rally?

You want to benchmark Elasticsearch? Then Rally is for you. It can help you with the following tasks:

  • Setup and teardown of an Elasticsearch cluster for benchmarking
  • Management of benchmark data and specifications even across Elasticsearch versions
  • Running benchmarks and recording results
  • Finding performance problems by attaching so-called telemetry devices
  • Comparing performance results

We have also put considerable effort in Rally to ensure that benchmarking data are reproducible.

In general, Rally works with all versions of Elasticsearch starting from 1.x but benchmarking with plugins and benchmarking source builds will only work from Elasticsearch 5.0 onwards.

Quick Start

Rally is developed for Unix and is actively tested on Linux and MacOS. Rally supports benchmarking Elasticsearch clusters running on Windows but Rally itself needs to be installed on machines running Unix.

Installing Rally

Note: If you actively develop on Elasticsearch, we recommend that you install Rally in development mode instead as Elasticsearch is fast moving and Rally always adapts accordingly to the latest master version.

Install Python 3.4+ including pip3, git 1.9+ and an appropriate JDK to run Elasticsearch Be sure that JAVA_HOME points to that JDK. Then run the following command, optionally prefixed by sudo if necessary:

pip3 install esrally

If you have any trouble or need more detailed instructions, please look in the detailed installation guide.

Configure

Just invoke esrally configure.

For more detailed instructions and a detailed walkthrough see the configuration guide.

Run your first race

Now we're ready to run our first race:

esrally --distribution-version=6.0.0

This will download Elasticsearch 6.0.0 and run Rally's default track - the geonames track - against it. After the race, a summary report is written to the command line::

------------------------------------------------------
    _______             __   _____
   / ____(_)___  ____ _/ /  / ___/_________  ________
  / /_  / / __ \/ __ `/ /   \__ \/ ___/ __ \/ ___/ _ \
 / __/ / / / / / /_/ / /   ___/ / /__/ /_/ / /  /  __/
/_/   /_/_/ /_/\__,_/_/   /____/\___/\____/_/   \___/
------------------------------------------------------

|                         Metric |                 Task |     Value |   Unit |
|-------------------------------:|---------------------:|----------:|-------:|
|            Total indexing time |                      |   28.0997 |    min |
|               Total merge time |                      |   6.84378 |    min |
|             Total refresh time |                      |   3.06045 |    min |
|               Total flush time |                      |  0.106517 |    min |
|      Total merge throttle time |                      |   1.28193 |    min |
|               Median CPU usage |                      |     471.6 |      % |
|             Total Young Gen GC |                      |    16.237 |      s |
|               Total Old Gen GC |                      |     1.796 |      s |
|                     Index size |                      |   2.60124 |     GB |
|                Totally written |                      |   11.8144 |     GB |
|         Heap used for segments |                      |   14.7326 |     MB |
|       Heap used for doc values |                      |  0.115917 |     MB |
|            Heap used for terms |                      |   13.3203 |     MB |
|            Heap used for norms |                      | 0.0734253 |     MB |
|           Heap used for points |                      |    0.5793 |     MB |
|    Heap used for stored fields |                      |  0.643608 |     MB |
|                  Segment count |                      |        97 |        |
|                 Min Throughput |         index-append |   31925.2 | docs/s |
|              Median Throughput |         index-append |   39137.5 | docs/s |
|                 Max Throughput |         index-append |   39633.6 | docs/s |
|      50.0th percentile latency |         index-append |   872.513 |     ms |
|      90.0th percentile latency |         index-append |   1457.13 |     ms |
|      99.0th percentile latency |         index-append |   1874.89 |     ms |
|       100th percentile latency |         index-append |   2711.71 |     ms |
| 50.0th percentile service time |         index-append |   872.513 |     ms |
| 90.0th percentile service time |         index-append |   1457.13 |     ms |
| 99.0th percentile service time |         index-append |   1874.89 |     ms |
|  100th percentile service time |         index-append |   2711.71 |     ms |
|                           ...  |                  ... |       ... |    ... |
|                           ...  |                  ... |       ... |    ... |
|                 Min Throughput |     painless_dynamic |   2.53292 |  ops/s |
|              Median Throughput |     painless_dynamic |   2.53813 |  ops/s |
|                 Max Throughput |     painless_dynamic |   2.54401 |  ops/s |
|      50.0th percentile latency |     painless_dynamic |    172208 |     ms |
|      90.0th percentile latency |     painless_dynamic |    310401 |     ms |
|      99.0th percentile latency |     painless_dynamic |    341341 |     ms |
|      99.9th percentile latency |     painless_dynamic |    344404 |     ms |
|       100th percentile latency |     painless_dynamic |    344754 |     ms |
| 50.0th percentile service time |     painless_dynamic |    393.02 |     ms |
| 90.0th percentile service time |     painless_dynamic |   407.579 |     ms |
| 99.0th percentile service time |     painless_dynamic |   430.806 |     ms |
| 99.9th percentile service time |     painless_dynamic |   457.352 |     ms |
|  100th percentile service time |     painless_dynamic |   459.474 |     ms |

----------------------------------
[INFO] SUCCESS (took 2634 seconds)
----------------------------------

Getting help

How to Contribute

See all details in the contributor guidelines.

License

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

Copyright 2015-2018 Elasticsearch <https://www.elastic.co>

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.