Skip to content

Commit 1af1bde

Browse files
IanHoangIan Hoang
IanHoang
and
Ian Hoang
authored
Replace "esrally" or "rally" with "osbenchmark" or "benchmark" respecitvely (opensearch-project#13) (opensearch-project#48)
* Replacing esrally with osbenchmark Signed-off-by: Ian Hoang <hoangia@amazon.com> * Renamed variables with rally terms to benchmark Signed-off-by: Ian Hoang <hoangia@amazon.com> * Rename all Rally Exceptions to appropriate replacements Signed-off-by: Ian Hoang <hoangia@amazon.com> * Docker adjustments to get integ tests working Signed-off-by: Ian Hoang <hoangia@amazon.com> * Replacing rally.ini config files Signed-off-by: Ian Hoang <hoangia@amazon.com> * Changing .rally to .benchmark Signed-off-by: Ian Hoang <hoangia@amazon.com> * Renaming RALLY_HOME to BENCHMARK_HOME Signed-off-by: Ian Hoang <hoangia@amazon.com> * Renamed processes that process.py should look and kill Signed-off-by: Ian Hoang <hoangia@amazon.com> * Replacing references of rally across nodes and clusters Signed-off-by: Ian Hoang <hoangia@amazon.com> * Replacing rally_ references Signed-off-by: Ian Hoang <hoangia@amazon.com> * Changed RALLY env variables to BENCHMARK Signed-off-by: Ian Hoang <hoangia@amazon.com> * Updated rally.log to benchmark.log Signed-off-by: Ian Hoang <hoangia@amazon.com> * More esrally to osbenchmark changes Signed-off-by: Ian Hoang <hoangia@amazon.com> * Renamed rally terms in docker files Signed-off-by: Ian Hoang <hoangia@amazon.com> * Rally node in tests Signed-off-by: Ian Hoang <hoangia@amazon.com> * More rally changes Signed-off-by: Ian Hoang <hoangia@amazon.com> * Rally urls replacement Signed-off-by: Ian Hoang <hoangia@amazon.com> * RallyActor to BenchmarkActor replacement Signed-off-by: Ian Hoang <hoangia@amazon.com> * Replace instances of Rally with Benchmark (mostly comments) Signed-off-by: Ian Hoang <hoangia@amazon.com> * Minor replacements for esrally Signed-off-by: Ian Hoang <hoangia@amazon.com> * Fix docker files Signed-off-by: Ian Hoang <hoangia@amazon.com> * Pylint fixes Signed-off-by: Ian Hoang <hoangia@amazon.com> * Fixed docker compose yml file Signed-off-by: Ian Hoang <hoangia@amazon.com> * Replacing _es to _os Signed-off-by: Ian Hoang <hoangia@amazon.com> * Removed sphinx dependencies Signed-off-by: Ian Hoang <hoangia@amazon.com> * Removed print statements Signed-off-by: Ian Hoang <hoangia@amazon.com> Co-authored-by: Ian Hoang <hoangia@amazon.com>
1 parent b3c8a1e commit 1af1bde

File tree

157 files changed

+1512
-1483
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

157 files changed

+1512
-1483
lines changed

‎.ci/build.sh

+7-7
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ function update_pyenv {
3030
}
3131

3232
function build {
33-
export THESPLOG_FILE="${THESPLOG_FILE:-${RALLY_HOME}/.rally/logs/actor-system-internal.log}"
33+
export THESPLOG_FILE="${THESPLOG_FILE:-${BENCHMARK_HOME}/.benchmark/logs/actor-system-internal.log}"
3434
# this value is in bytes, the default is 50kB. We increase it to 200kiB.
3535
export THESPLOG_FILE_MAXSIZE=${THESPLOG_FILE_MAXSIZE:-204800}
3636
# adjust the default log level from WARNING
@@ -55,7 +55,7 @@ function build {
5555
}
5656

5757
function build_it {
58-
export THESPLOG_FILE="${THESPLOG_FILE:-${RALLY_HOME}/.rally/logs/actor-system-internal.log}"
58+
export THESPLOG_FILE="${THESPLOG_FILE:-${BENCHMARK_HOME}/.benchmark/logs/actor-system-internal.log}"
5959
# this value is in bytes, the default is 50kB. We increase it to 200kiB.
6060
export THESPLOG_FILE_MAXSIZE=${THESPLOG_FILE_MAXSIZE:-204800}
6161
# adjust the default log level from WARNING
@@ -67,7 +67,7 @@ function build_it {
6767
export PATH="$HOME/.pyenv/bin:$PATH"
6868
export TERM=dumb
6969
export LC_ALL=en_US.UTF-8
70-
export RALLY_HOME=$WORKSPACE
70+
export BENCHMARK_HOME=$WORKSPACE
7171
export JAVA_PATH="/opt/hostedtoolcache/Java_Adopt_jdk"
7272
export JAVA_HOME="$JAVA_PATH/15.0.2-7/x64"
7373
export JAVA8_HOME="$JAVA_PATH/8.0.292-1/x64"
@@ -108,11 +108,11 @@ function archive {
108108
set -u
109109

110110
# this will only be done if the build number variable is present
111-
RALLY_DIR=${RALLY_HOME}/.rally
112-
if [[ -d ${RALLY_DIR} ]]; then
113-
find ${RALLY_DIR} -name "*.log" -printf "%P\\0" | tar -cvjf ${RALLY_DIR}/${BUILD_NUMBER}.tar.bz2 -C ${RALLY_DIR} --transform "s,^,ci-${BUILD_NUMBER}/," --null -T -
111+
BENCHMARK_DIR=${BENCHMARK_HOME}/.benchmark
112+
if [[ -d ${BENCHMARK_DIR} ]]; then
113+
find ${BENCHMARK_DIR} -name "*.log" -printf "%P\\0" | tar -cvjf ${BENCHMARK_DIR}/${BUILD_NUMBER}.tar.bz2 -C ${BENCHMARK_DIR} --transform "s,^,ci-${BUILD_NUMBER}/," --null -T -
114114
else
115-
echo "Rally directory [${RALLY_DIR}] not present. Ensure the RALLY_DIR environment variable is correct"
115+
echo "Benchmark directory [${BENCHMARK_DIR}] not present. Ensure the BENCHMARK_DIR environment variable is correct"
116116
exit 1
117117
fi
118118
}

‎.fossa.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ version: 2
22
cli:
33
server: https://app.fossa.com
44
fetcher: custom
5-
project: Rally
5+
project: Benchmark
66
analyze:
77
modules:
88
- name: .

‎.github/workflows/main.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ jobs:
1111
- name: Run the CI build script
1212
run: bash .ci/build.sh build
1313
env:
14-
RALLY_HOME: env.GITHUB_WORKSPACE
14+
BENCHMARK_HOME: env.GITHUB_WORKSPACE
1515
DCO-Check:
1616
runs-on: ubuntu-latest
1717
steps:

‎.github/workflows/manual-integ.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -26,4 +26,4 @@ jobs:
2626
- name: Run the CI build_it script
2727
run: bash .ci/build.sh build_it
2828
env:
29-
RALLY_HOME: env.GITHUB_WORKSPACE
29+
BENCHMARK_HOME: env.GITHUB_WORKSPACE

‎.gitignore

+2-2
Original file line numberDiff line numberDiff line change
@@ -103,8 +103,8 @@ target/
103103
# pyenv
104104
.python-version
105105

106-
# Rally specific
107-
.rally_it/
106+
# Benchmark specific
107+
.benchmark_it/
108108
# Virtualenv for development
109109
.venv*/
110110
# Autogenerated files

‎.pylintrc

+1-1
Original file line numberDiff line numberDiff line change
@@ -145,7 +145,7 @@ disable=print-statement,
145145
deprecated-sys-function,
146146
exception-escape,
147147
comprehension-escape,
148-
# custom rally ignores start here
148+
# custom benchmark ignores start here
149149
invalid-name,
150150
missing-module-docstring,
151151
missing-function-docstring,

‎MANIFEST.in

+2-2
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,9 @@ include MANIFEST.in
55
include README.rst
66
include setup.py
77
include version.txt
8-
include esrally/min-es-version.txt
8+
include osbenchmark/min-es-version.txt
99
recursive-include docs *
10-
recursive-include esrally/resources *
10+
recursive-include osbenchmark/resources *
1111
# recursive-exclude * __pycache__
1212
# recursive-exclude * *.py[co]
1313
# prune docs/_build

‎Makefile

+2-2
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,7 @@ install: install-user
6666
clean: nondocs-clean docs-clean
6767

6868
nondocs-clean:
69-
rm -rf .benchmarks .eggs .tox .rally_it .cache build dist esrally.egg-info logs junit-py*.xml NOTICE.txt
69+
rm -rf .benchmarks .eggs .tox .benchmark_it .cache build dist osbenchmark.egg-info logs junit-py*.xml NOTICE.txt
7070

7171
docs-clean:
7272
cd docs && $(MAKE) clean
@@ -87,7 +87,7 @@ tox-env-clean:
8787
rm -rf .tox
8888

8989
lint: check-venv
90-
@find esrally benchmarks scripts tests it -name "*.py" -exec $(VEPYLINT) -j0 -rn --load-plugins pylint_quotes --rcfile=$(CURDIR)/.pylintrc \{\} +
90+
@find osbenchmark benchmarks scripts tests it -name "*.py" -exec $(VEPYLINT) -j0 -rn --load-plugins pylint_quotes --rcfile=$(CURDIR)/.pylintrc \{\} +
9191

9292
docs: check-venv
9393
@. $(VENV_ACTIVATE_FILE); cd docs && $(MAKE) html

‎README.rst

+22-22
Original file line numberDiff line numberDiff line change
@@ -1,46 +1,46 @@
1-
Rally
1+
Benchmark
22
=====
33

4-
Rally is the macrobenchmarking framework for Elasticsearch
4+
Benchmark is the macrobenchmarking framework for OpenSearch
55

6-
What is Rally?
6+
What is Benchmark?
77
--------------
88

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:
1010

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
1313
* Running benchmarks and recording results
1414
* Finding performance problems by attaching so-called telemetry devices
1515
* Comparing performance results
1616

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.
1818

1919
Quick Start
2020
-----------
2121

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.
2323

24-
Installing Rally
24+
Installing Benchmark
2525
~~~~~~~~~~~~~~~~
2626

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.
2828

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::
3030

31-
pip3 install esrally
31+
pip3 install osbenchmark
3232

3333

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>`_.
3535

3636
Run your first race
3737
-------------------
3838

3939
Now we're ready to run our first race::
4040

41-
esrally race --distribution-version=6.0.0 --track=geonames
41+
osbenchmark race --distribution-version=6.0.0 --track=geonames
4242

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:::
4444

4545
------------------------------------------------------
4646
_______ __ _____
@@ -104,22 +104,22 @@ This will download Elasticsearch 6.0.0 and run Rally's default track - the `geon
104104
Getting help
105105
------------
106106

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>`_.
111111

112112
How to Contribute
113113
-----------------
114114

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>`_.
116116

117117
License
118118
-------
119-
119+
120120
This software is licensed under the Apache License, version 2 ("ALv2"), quoted below.
121121

122-
Copyright 2015-2021 Elasticsearch <https://www.elastic.co>
122+
Copyright 2015-2021 OpenSearch <https://www.elastic.co>
123123

124124
Licensed under the Apache License, Version 2.0 (the "License"); you may not
125125
use this file except in compliance with the License. You may obtain a copy of

‎rally ‎benchmark

+5-5
Original file line numberDiff line numberDiff line change
@@ -24,23 +24,23 @@ set -u
2424
# fail on pipeline errors, e.g. when grepping
2525
set -o pipefail
2626

27-
# We assume here that this script will stay in the Rally git root directory (it does not make sense in any other place anyway)
27+
# We assume here that this script will stay in the Benchmark git root directory (it does not make sense in any other place anyway)
2828

2929
SOURCE="${BASH_SOURCE[0]}"
3030
while [ -h "$SOURCE" ]; do # resolve $SOURCE until the file is no longer a symlink
3131
DIR="$( cd -P "$( dirname "$SOURCE" )" && pwd )"
3232
SOURCE="$(readlink "$SOURCE")"
3333
[[ $SOURCE != /* ]] && SOURCE="$DIR/$SOURCE" # if $SOURCE was a relative symlink, we need to resolve it relative to the path where the symlink file was located
3434
done
35-
RALLY_SRC_HOME="$( cd -P "$( dirname "$SOURCE" )" && pwd )"
35+
BENCHMARK_SRC_HOME="$( cd -P "$( dirname "$SOURCE" )" && pwd )"
3636

3737
pushd . >/dev/null 2>&1
38-
cd "${RALLY_SRC_HOME}" >/dev/null 2>&1
38+
cd "${BENCHMARK_SRC_HOME}" >/dev/null 2>&1
3939

4040

4141
# set variables that are needed for run.sh
42-
__RALLY_INTERNAL_BINARY_NAME="esrally"
43-
__RALLY_INTERNAL_HUMAN_NAME="Rally"
42+
__BENCHMARK_INTERNAL_BINARY_NAME="osbenchmark"
43+
__BENCHMARK_INTERNAL_HUMAN_NAME="Benchmark"
4444

4545
source run.sh
4646

‎rallyd ‎benchmarkd

+7-7
Original file line numberDiff line numberDiff line change
@@ -24,24 +24,24 @@ set -u
2424
# fail on pipeline errors, e.g. when grepping
2525
set -o pipefail
2626

27-
# We assume here that this script will stay in the Rally git root directory (it does not make sense in any other place anyway)
27+
# We assume here that this script will stay in the Benchmark git root directory (it does not make sense in any other place anyway)
2828

2929
SOURCE="${BASH_SOURCE[0]}"
3030
while [ -h "$SOURCE" ]; do # resolve $SOURCE until the file is no longer a symlink
3131
DIR="$( cd -P "$( dirname "$SOURCE" )" && pwd )"
3232
SOURCE="$(readlink "$SOURCE")"
3333
[[ $SOURCE != /* ]] && SOURCE="$DIR/$SOURCE" # if $SOURCE was a relative symlink, we need to resolve it relative to the path where the symlink file was located
3434
done
35-
RALLY_SRC_HOME="$( cd -P "$( dirname "$SOURCE" )" && pwd )"
35+
BENCHMARK_SRC_HOME="$( cd -P "$( dirname "$SOURCE" )" && pwd )"
3636

3737
pushd . >/dev/null 2>&1
38-
cd "${RALLY_SRC_HOME}" >/dev/null 2>&1
38+
cd "${BENCHMARK_SRC_HOME}" >/dev/null 2>&1
3939

40-
# ensure the Actor system can find Rally sources (it is ok if PYTHONPATH is undefined yet. Hence we define an empty default).
41-
export PYTHONPATH="${RALLY_SRC_HOME}:${PYTHONPATH:-}"
40+
# ensure the Actor system can find Benchmark sources (it is ok if PYTHONPATH is undefined yet. Hence we define an empty default).
41+
export PYTHONPATH="${BENCHMARK_SRC_HOME}:${PYTHONPATH:-}"
4242

4343
# set variables that are needed for run.sh
44-
__RALLY_INTERNAL_BINARY_NAME="esrallyd"
45-
__RALLY_INTERNAL_HUMAN_NAME="Rally daemon"
44+
__BENCHMARK_INTERNAL_BINARY_NAME="osbenchmarkd"
45+
__BENCHMARK_INTERNAL_HUMAN_NAME="Benchmark daemon"
4646

4747
source run.sh

‎benchmarks/worker_coordinator/parsing_test.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@
3030
import pytest
3131
import ujson
3232

33-
from esrally.worker_coordinator import runner
33+
from osbenchmark.worker_coordinator import runner
3434

3535
@pytest.mark.benchmark(
3636
group="parse",

‎benchmarks/worker_coordinator/runner_test.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@
2424

2525
import pytest
2626

27-
from esrally.worker_coordinator import runner
27+
from osbenchmark.worker_coordinator import runner
2828

2929
bulk_index = runner.BulkIndex()
3030

‎benchmarks/workload/bulk_params_test.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@
2626

2727
import pytest
2828

29-
from esrally.workload import params
29+
from osbenchmark.workload import params
3030

3131

3232
class StaticSource:

‎changelog.py

+3-3
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@
3131
import github3
3232

3333
ORG = "elastic"
34-
REPO = "rally"
34+
REPO = "benchmark"
3535

3636

3737
def find_milestone(repo, title):
@@ -98,9 +98,9 @@ def main():
9898
# requires a personal Github access token with permission `public_repo` (see https://github.com/settings/tokens)
9999
gh = github3.login(token=open("%s/.github/rally_release_changelog.token" % os.getenv("HOME"), "r").readline().strip())
100100

101-
rally_repo = gh.repository(ORG, REPO)
101+
benchmark_repo = gh.repository(ORG, REPO)
102102

103-
milestone = find_milestone(rally_repo, title=milestone_name)
103+
milestone = find_milestone(benchmark_repo, title=milestone_name)
104104
if not milestone:
105105
print("No open milestone named [%s] found." % milestone_name, file=sys.stderr)
106106
exit(2)

0 commit comments

Comments
 (0)