Rally 0.9.1

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. Benchmarking with plugins and benchmarking source builds will only work from Elasticsearch 5.0 onwards.

Getting Help or Contributing to Rally

Use our Discuss forum to provide feedback or ask questions about Rally. Please see our contribution guide on guidelines for contributors.

Source Code

Rally’s source code is available on Github. You can also check the changelog and the roadmap there.

Getting Started with Rally

• Quickstart
  • Install
  • Configure
  • Run your first race
  • Next steps
• Installation
  • Prerequisites
  • Installing Rally
  • Non-sudo Install
  • VirtualEnv Install
  • Kubernetes Job
  • Docker
  • Offline Install
  • Next Steps
• Configuration
  • Simple Configuration
  • Advanced Configuration
  • Proxy Configuration
• Run a Benchmark: Races
  • Definition
  • List Tracks
  • Starting a Race
• Compare Results: Tournaments
• Tips and Tricks
  • Benchmarking an existing cluster
  • Benchmarking a remote cluster
  • Distributing the load test driver
  • Changing the default track repository

Extending Rally

• Define Custom Workloads: Tracks
  • Definition
  • Example track
  • Adding support for test mode
  • Structuring your track
  • Sharing your track with others
  • Advanced topics
• Developing Rally
  • Prerequisites
  • Installation Instructions for Development
  • Key Components of Rally
  • How to contribute code

Reference Documentation

• Command Line Reference
  • Subcommands
  • Command Line Flags
• Offline Usage
  • Installation and Configuration
  • Command Line Usage
  • Using tracks
  • Using cars
• Track Reference
  • Definition
  • Track File Format and Storage
  • Anatomy of a track
  • Track elements
  • Examples
• Configure Elasticsearch: Cars
  • Definition
  • The Anatomy of a car
• Using Elasticsearch Plugins
  • Listing plugins
  • Running a benchmark with plugins
  • Building plugins from sources
  • Anatomy of a plugin specification
• Telemetry Devices
  • jfr
  • jit
  • gc
  • perf
• Rally Daemon
  • Preparation
  • Starting
  • Stopping
  • Status
• Pipelines
  • benchmark-only
  • from-distribution
  • from-sources-complete
  • from-sources-skip-build
• Metrics
  • Metrics Records
  • Metric Keys
• Summary Report
  • Indexing time
  • Indexing throttle time
  • Merge time
  • Refresh time
  • Flush time
  • Merge throttle time
  • Merge time (X)
  • Median CPU usage
  • Total Young Gen GC
  • Total Old Gen GC
  • Index size
  • Totally written
  • Heap used for X
  • Segment count
  • Throughput
  • Latency
  • Service time
  • Error rate

Additional Information

• Migration Guide
  • 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 does latency and service_time mean and how do they related 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?
• Glossary
• Community Resources
  • Talks
  • Articles

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.