Changed occurrences of "Benchmark", which is a historical artifact, t…

…o "OSB".

Signed-off-by: Govind Kamat <govkamat@amazon.com>

.fossa.yml

@@ -2,7 +2,7 @@ version: 2
 cli:
   server: https://app.fossa.com
   fetcher: custom
-  project: Benchmark
+  project: OSB
 analyze:
   modules:
   - name: .

.gitignore

@@ -100,7 +100,7 @@ target/
 # pyenv
 .python-version
 
-# Benchmark specific
+# OSB specific
 .benchmark_it/
 # Virtualenv for development
 .venv*/

benchmark

@@ -24,7 +24,7 @@ set -u
 # fail on pipeline errors, e.g. when grepping
 set -o pipefail
 
-# We assume here that this script will stay in the Benchmark git root directory (it does not make sense in any other place anyway)
+# We assume here that this script will stay in the OSB git root directory (it does not make sense in any other place anyway)
 
 SOURCE="${BASH_SOURCE[0]}"
 while [ -h "$SOURCE" ]; do # resolve $SOURCE until the file is no longer a symlink
@@ -40,7 +40,7 @@ cd "${BENCHMARK_SRC_HOME}" >/dev/null 2>&1
 
 # set variables that are needed for run.sh
 __BENCHMARK_INTERNAL_BINARY_NAME="osbenchmark"
-__BENCHMARK_INTERNAL_HUMAN_NAME="Benchmark"
+__BENCHMARK_INTERNAL_HUMAN_NAME="OpenSearch Benchmark"
 
 source run.sh
 

benchmarkd

@@ -24,7 +24,7 @@ set -u
 # fail on pipeline errors, e.g. when grepping
 set -o pipefail
 
-# We assume here that this script will stay in the Benchmark git root directory (it does not make sense in any other place anyway)
+# We assume here that this script will stay in the OSB git root directory (it does not make sense in any other place anyway)
 
 SOURCE="${BASH_SOURCE[0]}"
 while [ -h "$SOURCE" ]; do # resolve $SOURCE until the file is no longer a symlink
@@ -37,11 +37,11 @@ BENCHMARK_SRC_HOME="$( cd -P "$( dirname "$SOURCE" )" && pwd )"
 pushd . >/dev/null 2>&1
 cd "${BENCHMARK_SRC_HOME}" >/dev/null 2>&1
 
-# ensure the Actor system can find Benchmark sources (it is ok if PYTHONPATH is undefined yet. Hence we define an empty default).
+# ensure the Actor system can find OSB sources (it is ok if PYTHONPATH is undefined yet. Hence we define an empty default).
 export PYTHONPATH="${BENCHMARK_SRC_HOME}:${PYTHONPATH:-}"
 
 # set variables that are needed for run.sh
 __BENCHMARK_INTERNAL_BINARY_NAME="osbenchmarkd"
-__BENCHMARK_INTERNAL_HUMAN_NAME="Benchmark daemon"
+__BENCHMARK_INTERNAL_HUMAN_NAME="OpenSearch Benchmark Daemon"
 
 source run.sh

docs/api/client-options.md

@@ -1,6 +1,6 @@
 ---
 layout: default
 title: Client Options
-parent: Benchmark API
+parent: OSB API
 nav_order: 12
 ---

docs/api/execute-test.md

@@ -1,7 +1,7 @@
 ---
 layout: default
 title: Execute Test
-parent: Benchmark API
+parent: OSB API
 nav_order: 10
 ---
 
@@ -23,10 +23,10 @@ Argument | Description | Required
 :--- | :--- |:---
 `workload` | The dataset and operations that execute during a test. See [OpenSearch Benchmark Workloads repository](https://github.com/opensearch-project/opensearch-benchmark-workloads) for more details on workloads. | Yes
 `workload-params` | Parameters defined within each workload that can be overwritten. These parameters are outlined in the README of each workload. You can find an example of the parameters for the eventdata workload [here](https://github.com/opensearch-project/opensearch-benchmark-workloads/tree/main/eventdata#parameters).  | No
-`test_procedure` | Test Procedures define the sequence of operations and parameters for a specific workload. When no `test_procedure` is specified, Benchmark selects the default for the workload. You can find an example test procedure [here](https://github.com/opensearch-project/opensearch-benchmark-workloads/blob/main/eventdata/test_procedures/default.json). | No
+`test_procedure` | Test Procedures define the sequence of operations and parameters for a specific workload. When no `test_procedure` is specified, OSB selects the default for the workload. You can find an example test procedure [here](https://github.com/opensearch-project/opensearch-benchmark-workloads/blob/main/eventdata/test_procedures/default.json). | No
 `client-options` | Options for the [OpenSearch Python client](https://opensearch.org/docs/latest/clients/python/). Required if testing against a cluster with security enabled. | No
 `pipeline` | Steps required to execute a test, including provisioning an OpenSearch from source code or a specified distribution. Defaults to `from-sources` which provisions an OpenSearch cluster from source code. | No
-`distribution-version` | The OpenSearch version to use for a given test. Defining a version can be useful when using a `pipeline` that includes provisioning. When using a `pipeline` without provisioning, Benchmark will automatically determine the version | No
+`distribution-version` | The OpenSearch version to use for a given test. Defining a version can be useful when using a `pipeline` that includes provisioning. When using a `pipeline` without provisioning, OSB will automatically determine the version | No
 `target-hosts` | The OpenSearch endpoint(s) to execute a test against. This should only be specified with  `--pipeline=benchmark-only`  | No
 `test-mode` | Run a single iteration of each operation in the test procedure. The test provides a quick way for sanity checking a testing configuration. Therefore, do not use `test-mode` for actual benchmarking. | No
 `kill-running-processes` | Kill any running OpenSearch Benchmark processes on the local machine before the test executes. | No
@@ -62,14 +62,14 @@ Argument | Description | Required
 :--- | :--- |:---
 `distribution-version` | Define the version of the OpenSearch distribution to download. Check https://opensearch.org/docs/version-history/ for released versions. | No
 `provision-config-path` | Define the path to the provision_config_instance and plugin configurations to use. | No
-`provision-config-repository` | Define repository from where Benchmark will load provision_configs and provision_config_instances (default: `default`). | No
-`provision-config-revision` | Define a specific revision in the provision_config repository that Benchmark should use. | No
+`provision-config-repository` | Define repository from where OSB will load provision_configs and provision_config_instances (default: `default`). | No
+`provision-config-revision` | Define a specific revision in the provision_config repository that OSB should use. | No
 `test-execution-id` | Define a unique id for this test_execution. | No
 `pipeline` | Select the pipeline to run. | No
 `revision` | Define the source code revision for building the benchmark candidate. 'current' uses the source tree as is, 'latest' fetches the latest version on main. It is also possible to specify a commit id or an ISO timestamp. The timestamp must be specified as: "@ts" where "ts" must be a valid ISO 8601 timestamp, e.g. "@2013-07-27T10:37:00Z" (default: `current`). | No
-`workload-repository` | Define the repository from where Benchmark will load workloads (default: `default`). | No
+`workload-repository` | Define the repository from where OSB will load workloads (default: `default`). | No
 `workload-path` | Define the path to a workload. | No
-`workload-revision` | Define a specific revision in the workload repository that Benchmark should use. | No
+`workload-revision` | Define a specific revision in the workload repository that OSB should use. | No
 `workload` | Define the workload to use. List possible workloads with `opensearch-benchmark list workloads`. | No
 `workload-params` | Define a comma-separated list of key:value pairs that are injected verbatim to the workload as variables. | No
 `test-procedure` | Define the test_procedure to use. List possible test_procedures for workloads with `opensearch-benchmark list workloads`. | No
@@ -81,7 +81,7 @@ Argument | Description | Required
 `target-hosts` | Define a comma-separated list of host:port pairs which should be targeted if using the pipeline 'benchmark-only' (default: `localhost:9200`). | No
 `load-worker-coordinator-hosts` | Define a comma-separated list of hosts which should generate load (default: `localhost`). | No
 `client-options` | Define a comma-separated list of client options to use. The options will be passed to the OpenSearch Python client (default: `timeout:60`). | No
-`on-error` | Controls how Benchmark behaves on response errors. Options are `continue` and `abort` (default: `continue`). | No
+`on-error` | Controls how OSB behaves on response errors. Options are `continue` and `abort` (default: `continue`). | No
 `telemetry` | Enable the provided telemetry devices, provided as a comma-separated list. List possible telemetry devices with `opensearch-benchmark list telemetry`. | No
 `telemetry-params` | Define a comma-separated list of key:value pairs that are injected verbatim to the telemetry devices as parameters. | No
 `distribution-repository` | Define the repository from where the OpenSearch distribution should be downloaded (default: `release`). | No
@@ -94,9 +94,9 @@ Argument | Description | Required
 `results-file` | Write the command line results also to the provided file. | No
 `preserve-install` | Keep the benchmark candidate and its index. (default: false). | No
 `test-mode` | Runs the given workload in 'test mode'. Meant to check a workload for errors but not for real benchmarks (default: false). | No
-`enable-worker-coordinator-profiling` | Enables a profiler for analyzing the performance of calls in Benchmark's worker coordinator (default: false). | No
+`enable-worker-coordinator-profiling` | Enables a profiler for analyzing the performance of calls in OSB's worker coordinator (default: false). | No
 `enable-assertions` | Enables assertion checks for tasks (default: false). | No
-`kill-running-processes` | If any processes is running, it is going to kill them and allow Benchmark to continue to run. | No
+`kill-running-processes` | If any processes is running, it is going to kill them and allow OSB to continue to run. | No
 `quiet` | Suppress as much as output as possible (default: false). | No
-`offline` | Assume that Benchmark has no connection to the Internet (default: false). | No
+`offline` | Assume that OSB has no connection to the Internet (default: false). | No
 

docs/api/index.md

@@ -1,6 +1,6 @@
 ---
 layout: default
-title: Benchmark API
+title: OSB API
 nav_order: 2
 has_children: true
 ---

docs/api/kill-running-process.md

@@ -1,6 +1,6 @@
 ---
 layout: default
 title: Kill Running Process
-parent: Benchmark API
+parent: OSB API
 nav_order: 14
 ---

docs/api/pipeline.md

@@ -1,6 +1,6 @@
 ---
 layout: default
 title: Pipeline
-parent: Benchmark API
+parent: OSB API
 nav_order: 11
 ---

docs/api/target-hosts.md

@@ -1,6 +1,6 @@
 ---
 layout: default
 title: Target Hosts
-parent: Benchmark API
+parent: OSB API
 nav_order: 15
 ---

docs/api/test-mode.md

@@ -1,6 +1,6 @@
 ---
 layout: default
 title: Test Mode
-parent: Benchmark API
+parent: OSB API
 nav_order: 13
 ---

docs/api/workload.md

@@ -1,6 +1,6 @@
 ---
 layout: default
 title: Execute Test
-parent: Benchmark API
+parent: OSB API
 nav_order: 16
 ---

docs/get-started.md

@@ -1,6 +1,6 @@
 ---
 layout: default
 title: Get Started
-parent: Benchmark
+parent: OSB
 nav_order: 1
 ---

docs/user-guides/create-pipeline.md

@@ -1,7 +1,7 @@
 ---
 layout: default
 title: Create and manage pipelines
-parent: Benchmark Use Cases
+parent: OSB Use Cases
 nav_order: 20
 ---
 

osbenchmark/__init__.py

@@ -30,7 +30,7 @@
 
 __version__ = pkg_resources.require("opensearch-benchmark")[0].version
 
-# Allow an alternative program name be set in case Benchmark is invoked a wrapper script
+# Allow an alternative program name be set in case OSB is invoked a wrapper script
 PROGRAM_NAME = os.getenv("BENCHMARK_ALTERNATIVE_BINARY_NAME", os.path.basename(sys.argv[0]))
 
 DOC_LINK = "https://opensearch.org/docs"
@@ -80,7 +80,7 @@
 
 def check_python_version():
     if sys.version_info.major != 3 or sys.version_info.minor < 8:
-        raise RuntimeError("Benchmark requires at least Python 3.8 but you are using:\n\nPython %s" % str(sys.version))
+        raise RuntimeError("OSB requires at least Python 3.8 but you are using:\n\nPython %s" % str(sys.version))
 
 
 def doc_link(path=None):

osbenchmark/actor.py

@@ -67,7 +67,7 @@ def no_retry(f, actor_name):
 
     Decorator intended for Thespian message handlers with the signature ``receiveMsg_$MSG_NAME(self, msg, sender)``. Thespian will
     assume that a message handler that raises an exception can be retried. It will then retry once and give up afterwards just leaving
-    a trace of that in the actor system's internal log file. However, this is usually *not* what we want in Benchmark. If handling of a
+    a trace of that in the actor system's internal log file. However, this is usually *not* what we want in OSB. If handling of a
     message fails we instead want to notify a node higher up in the actor hierarchy.
 
     We achieve that by sending a ``BenchmarkFailure`` message to the original sender. Note that this might as well be the current
@@ -232,7 +232,7 @@ def bootstrap_actor_system(try_join=False, prefer_local_only=False, local_ip=Non
                 local_ip = None
         else:
             if system_base not in ("multiprocTCPBase", "multiprocUDPBase"):
-                raise exceptions.SystemSetupError("Benchmark requires a network-capable system base but got [%s]." % system_base)
+                raise exceptions.SystemSetupError("OSB requires a network-capable system base but got [%s]." % system_base)
             if not coordinator_ip:
                 raise exceptions.SystemSetupError("coordinator IP is required")
             if not local_ip:

osbenchmark/async_connection.py

@@ -174,7 +174,7 @@ def __init__(self,
                          http_auth=http_auth,
                          use_ssl=use_ssl,
                          ssl_assert_fingerprint=ssl_assert_fingerprint,
-                         # provided to the base class via `maxsize` to keep base class state consistent despite Benchmark
+                         # provided to the base class via `maxsize` to keep base class state consistent despite OSB
                          # calling the attribute differently.
                          maxsize=max(256, kwargs.get("max_connections", 0)),
                          headers=headers,
@@ -251,7 +251,7 @@ def __init__(self,
                          http_auth=http_auth,
                          use_ssl=use_ssl,
                          ssl_assert_fingerprint=ssl_assert_fingerprint,
-                         # provided to the base class via `maxsize` to keep base class state consistent despite Benchmark
+                         # provided to the base class via `maxsize` to keep base class state consistent despite OSB
                          # calling the attribute differently.
                          maxsize=max(256, kwargs.get("max_connections", 0)),
                          headers=headers,