This documentation is for the version of Rally currently under development. Were you looking for the documentation of the latest stable version?
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.
Getting Help or Contributing to Rally#
Use our Discuss forum to provide feedback or ask questions about Rally.
See our contribution guide on guidelines for contributors.
Rally’s source code is available on Github. You can also check the changelog and the roadmap there.
- Running Rally with Docker
- Run a Benchmark: Races
- Compare Results: Tournaments
- Setting up a Cluster
- Tips and Tricks
- Benchmarking an Elastic Cloud cluster
- Benchmarking an existing cluster
- Benchmarking a remote cluster
- Distributing the load test driver
- Changing the default track repository
- Testing Rally against CCR clusters using a remote metric store
- Identifying when errors have been encountered
- Checking Queries and Responses
- Define Custom Workloads: Tracks
- Advanced Topics
- Developing Rally
- Elasticsearch Version Support
- Command Line Reference
- Offline Usage
- Track Reference
- Configure Elasticsearch: Cars
- Using Elasticsearch Plugins
- Telemetry Devices
- Rally Daemon
- Summary Report
- Cumulative indexing time of primary shards
- Cumulative indexing time across primary shards
- Cumulative indexing throttle time of primary shards
- Cumulative indexing throttle time across primary shards
- Cumulative merge time of primary shards
- Cumulative merge count of primary shards
- Cumulative merge time across primary shards
- Cumulative refresh time of primary shards
- Cumulative refresh count of primary shards
- Cumulative refresh time across primary shards
- Cumulative flush time of primary shards
- Cumulative flush count of primary shards
- Cumulative flush time across primary shards
- Cumulative merge throttle time of primary shards
- Cumulative merge throttle time across primary shards
- ML processing time
- Total Young Gen GC time
- Total Young Gen GC count
- Total Old Gen GC time
- Total Old Gen GC count
- Total ZGC Cycles GC time
- Total ZGC Cycles GC count
- Total ZGC Pauses GC time
- Total ZGC Pauses GC count
- Store size
- Translog size
- Heap used for
- Segment count
- Total Ingest Pipeline count
- Total Ingest Pipeline time
- Total Ingest Pipeline failed
- Service time
- Processing time
- Error rate
- Disk usage
- Migration Guide
- Migrating to Rally 2.7.1
- Migrating to Rally 2.5.1
- Migrating to Rally 2.4.0
- Migrating to Rally 2.3.0
- Migrating to Rally 2.2.1
- Migrating to Rally 2.2.0
- Migrating to Rally 2.1.0
- Migrating to Rally 2.0.4
- Migrating to Rally 2.0.3
- Migrating to Rally 2.0.1
- Migrating to Rally 2.0.0
- Migrating to Rally 1.4.1
- Migrating to Rally 1.4.0
- Migrating to Rally 1.3.0
- Migrating to Rally 1.2.1
- Migrating to Rally 1.1.0
- Migrating to Rally 1.0.1
- Migrating to Rally 1.0.0
- Migrating to Rally 0.11.0
- Migrating to Rally 0.10.0
- Migrating to Rally 0.9.0
- Frequently Asked Questions (FAQ)
- A benchmark aborts with
Couldn't find a tar.gz distribution. What’s the problem?
- Where does Rally get the benchmark data from?
- Will Rally destroy my existing indices?
- What do latency and service_time mean and how do they relate to the took field that Elasticsearch returns?
- Where and how long does Rally keep its data?
- Does Rally spy on me?
- Do I need an Internet connection?
- A benchmark aborts with
- Community Resources
This software is licensed under the Apache License, version 2 (“ALv2”), quoted below.
Copyright 2015-2023 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
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.