|
1 |
| -Rally |
| 1 | +Benchmark |
2 | 2 | =====
|
3 | 3 |
|
4 |
| -Rally is the macrobenchmarking framework for Elasticsearch |
| 4 | +Benchmark is the macrobenchmarking framework for OpenSearch |
5 | 5 |
|
6 |
| -What is Rally? |
| 6 | +What is Benchmark? |
7 | 7 | --------------
|
8 | 8 |
|
9 |
| -You want to benchmark Elasticsearch? Then Rally is for you. It can help you with the following tasks: |
| 9 | +You want to benchmark OpenSearch? Then Benchmark is for you. It can help you with the following tasks: |
10 | 10 |
|
11 |
| -* Setup and teardown of an Elasticsearch cluster for benchmarking |
12 |
| -* Management of benchmark data and specifications even across Elasticsearch versions |
| 11 | +* Setup and teardown of an OpenSearch cluster for benchmarking |
| 12 | +* Management of benchmark data and specifications even across OpenSearch versions |
13 | 13 | * Running benchmarks and recording results
|
14 | 14 | * Finding performance problems by attaching so-called telemetry devices
|
15 | 15 | * Comparing performance results
|
16 | 16 |
|
17 |
| -We have also put considerable effort in Rally to ensure that benchmarking data are reproducible. |
| 17 | +We have also put considerable effort in Benchmark to ensure that benchmarking data are reproducible. |
18 | 18 |
|
19 | 19 | Quick Start
|
20 | 20 | -----------
|
21 | 21 |
|
22 |
| -Rally is developed for Unix and is actively tested on Linux and MacOS. Rally supports `benchmarking Elasticsearch clusters running on Windows <http://esrally.readthedocs.io/en/stable/recipes.html#benchmarking-an-existing-cluster>`_ but Rally itself needs to be installed on machines running Unix. |
| 22 | +Benchmark is developed for Unix and is actively tested on Linux and MacOS. Benchmark supports `benchmarking OpenSearch clusters running on Windows <http://osbenchmark.readthedocs.io/en/stable/recipes.html#benchmarking-an-existing-cluster>`_ but Benchmark itself needs to be installed on machines running Unix. |
23 | 23 |
|
24 |
| -Installing Rally |
| 24 | +Installing Benchmark |
25 | 25 | ~~~~~~~~~~~~~~~~
|
26 | 26 |
|
27 |
| -**Note**: If you actively develop on Elasticsearch, we recommend that you `install Rally in development mode <https://esrally.readthedocs.io/en/latest/developing.html#installation-instructions-for-development>`_ instead as Elasticsearch is fast moving and Rally always adapts accordingly to the latest master version. |
| 27 | +**Note**: If you actively develop on OpenSearch, we recommend that you `install Benchmark in development mode <https://osbenchmark.readthedocs.io/en/latest/developing.html#installation-instructions-for-development>`_ instead as OpenSearch is fast moving and Benchmark always adapts accordingly to the latest master version. |
28 | 28 |
|
29 |
| -Install Python 3.8+ including ``pip3``, git 1.9+ and an `appropriate JDK to run Elasticsearch <https://www.elastic.co/support/matrix#matrix_jvm>`_ Be sure that ``JAVA_HOME`` points to that JDK. Then run the following command, optionally prefixed by ``sudo`` if necessary:: |
| 29 | +Install Python 3.8+ including ``pip3``, git 1.9+ and an `appropriate JDK to run OpenSearch <https://www.elastic.co/support/matrix#matrix_jvm>`_ Be sure that ``JAVA_HOME`` points to that JDK. Then run the following command, optionally prefixed by ``sudo`` if necessary:: |
30 | 30 |
|
31 |
| - pip3 install esrally |
| 31 | + pip3 install osbenchmark |
32 | 32 |
|
33 | 33 |
|
34 |
| -If you have any trouble or need more detailed instructions, please look in the `detailed installation guide <https://esrally.readthedocs.io/en/latest/install.html>`_. |
| 34 | +If you have any trouble or need more detailed instructions, please look in the `detailed installation guide <https://osbenchmark.readthedocs.io/en/latest/install.html>`_. |
35 | 35 |
|
36 | 36 | Run your first race
|
37 | 37 | -------------------
|
38 | 38 |
|
39 | 39 | Now we're ready to run our first race::
|
40 | 40 |
|
41 |
| - esrally race --distribution-version=6.0.0 --track=geonames |
| 41 | + osbenchmark race --distribution-version=6.0.0 --track=geonames |
42 | 42 |
|
43 |
| -This will download Elasticsearch 6.0.0 and run Rally's default track - the `geonames track <https://github.com/elastic/rally-tracks/tree/master/geonames>`_ - against it. After the race, a summary report is written to the command line::: |
| 43 | +This will download OpenSearch 6.0.0 and run Benchmark's default track - the `geonames track <https://github.com/opensearch-project/OpenSearch-Benchmark-tracks/tree/master/geonames>`_ - against it. After the race, a summary report is written to the command line::: |
44 | 44 |
|
45 | 45 | ------------------------------------------------------
|
46 | 46 | _______ __ _____
|
@@ -104,22 +104,22 @@ This will download Elasticsearch 6.0.0 and run Rally's default track - the `geon
|
104 | 104 | Getting help
|
105 | 105 | ------------
|
106 | 106 |
|
107 |
| -* Quick help: ``esrally --help`` |
108 |
| -* Look in `Rally's user guide <https://esrally.readthedocs.io/>`_ for more information |
109 |
| -* Ask questions about Rally in the `Rally Discuss forum <https://discuss.elastic.co/tags/c/elastic-stack/elasticsearch/rally>`_. |
110 |
| -* File improvements or bug reports in our `Github repo <https://github.com/elastic/rally/issues>`_. |
| 107 | +* Quick help: ``osbenchmark --help`` |
| 108 | +* Look in `Benchmark's user guide <https://osbenchmark.readthedocs.io/>`_ for more information |
| 109 | +* Ask questions about Benchmark in the `Benchmark Discuss forum <https://discuss.elastic.co/tags/c/elastic-stack/elasticsearch/benchmark>`_. |
| 110 | +* File improvements or bug reports in our `Github repo <https://github.com/opensearch-project/OpenSearch-Benchmark/issues>`_. |
111 | 111 |
|
112 | 112 | How to Contribute
|
113 | 113 | -----------------
|
114 | 114 |
|
115 |
| -See all details in the `contributor guidelines <https://github.com/elastic/rally/blob/master/CONTRIBUTING.md>`_. |
| 115 | +See all details in the `contributor guidelines <https://github.com/opensearch-project/OpenSearch-Benchmark/blob/master/CONTRIBUTING.md>`_. |
116 | 116 |
|
117 | 117 | License
|
118 | 118 | -------
|
119 |
| - |
| 119 | + |
120 | 120 | This software is licensed under the Apache License, version 2 ("ALv2"), quoted below.
|
121 | 121 |
|
122 |
| -Copyright 2015-2021 Elasticsearch <https://www.elastic.co> |
| 122 | +Copyright 2015-2021 OpenSearch <https://www.elastic.co> |
123 | 123 |
|
124 | 124 | Licensed under the Apache License, Version 2.0 (the "License"); you may not
|
125 | 125 | use this file except in compliance with the License. You may obtain a copy of
|
|
0 commit comments