Installing Esrally

Esrally is a benchmarking tool designed to evaluate Elasticsearch performance. This section describes how to install Esrally.

Esrally is a tool used to benchmark Elasticsearch performance. It can evaluate Elasticsearch performance across different environment configurations and workloads. The test workloads mean the datasets and test scenarios used in the benchmark test. These workloads simulate different real-world scenarios to evaluate Elasticsearch performance.

1. Install Esrally.

   pip3 install esrally

   After the installation is successful, run the following command to check the version.

   esrally --version

2. View the available tracks.

   esrally list tracks

   This step automatically downloads the Esrally configuration file and saves it to /root/.rally.

3. Configure rally.ini.

   mv /root/.rally /home/elasticsearch/
   cd /home/elasticsearch/.rally
   vim rally.ini

   Modify the configuration file as follows: Change the value of datastore.host to the actual server IP address.

   [meta]
   config.version = 17
   
   [system]
   env.name = local
   
   [node]
   root.dir = ${CONFIG_DIR}/benchmarks
   src.root.dir = ${CONFIG_DIR}/benchmarks/src
   
   [source]
   remote.repo.url = https://github.com/elastic/elasticsearch.git
   elasticsearch.src.subdir = elasticsearch
   
   [benchmarks]
   local.dataset.cache = ${CONFIG_DIR}/benchmarks/data
   
   [reporting]
   datastore.type = elasticsearch
   #datastore.host = localhost
   datastore.host = X.X.X.X
   datastore.port = 9200
   datastore.secure = False
   datastore.user =
   datastore.password =
   
   
   [tracks]
   default.url = https://github.com/elastic/rally-tracks
   
   [teams]
   default.url = https://github.com/elastic/rally-teams
   
   [defaults]
   preserve_benchmark_candidate = false
   
   [distributions]
   release.cache = true