Configuring OpenSearch Benchmark

OpenSearch Benchmark configuration data is stored in ~/.benchmark/benchmark.ini, which is automatically created the first time OpenSearch Benchmark runs.

The file is separated into the following sections, which you can customize based on the needs of your cluster.

meta

This section contains meta information about the configuration file.

system

This section contains global information for the current benchmark environment. This information should be identical on all machines on which OpenSearch Benchmark is installed.

node

This section contains node-specific information that can be customized according to the needs of your cluster.

source

This section contains more details about the OpenSearch source tree.

benchmarks

This section contains the settings that can be customized in the OpenSearch Benchmark data directory.

results_publishing

This section defines how benchmark metrics are stored.

datastore.type parameters

When datastore.type is set to opensearch, the following reporting settings can be customized.

Examples

You can use the following examples to set reporting values in your cluster.

This example defines an unprotected metrics store in the local network:

[results_publishing]
datastore.type = opensearch
datastore.host = 192.168.10.17
datastore.port = 9200
datastore.secure = false
datastore.user =
datastore.password =

This example defines a secure connection to a metrics store in the local network with a self-signed certificate:

[results_publishing]
datastore.type = opensearch
datastore.host = 192.168.10.22
datastore.port = 9200
datastore.secure = true
datastore.ssl.verification_mode = none
datastore.user = user-name
datastore.password = the-password-to-your-cluster

workloads

This section defines how workloads are retrieved. All keys are read by OpenSearch using the syntax <<workload-repository-name>>.url, which you can select using the OpenSearch Benchmark CLI --workload-repository=workload-repository-name" option. By default, OpenSearch chooses the workload repository using the default.url https://github.com/opensearch-project/opensearch-benchmark-workloads.

defaults

This section defines the default values of certain OpenSearch Benchmark CLI parameters.

distributions

This section defines how OpenSearch versions are distributed.

Proxy configurations

OpenSearch automatically downloads all the necessary proxy data for you, including:

• OpenSearch distributions, when you specify --distribution-version=<OPENSEARCH-VERSION>.
• OpenSearch source code, when you specify a Git revision number, for example, --revision=1e04b2w.
• Any metadata tracked from the OpenSearch GitHub repository.

As of OpenSearch Benchmark 0.5.0, only http_proxy is supported.

You can use an http_proxy to connect OpenSearch Benchmark to a specific proxy and connect the proxy to a benchmark workload. To add the proxy:

1. Add your proxy URL to your shell profile:

   export http_proxy=http://proxy.proxy.org:4444/

2. Source your shell profile and verify that the proxy URL is set correctly:

   source ~/.bash_profile ; echo $http_proxy

3. Configure Git to connect to your proxy by using the following command. For more information, see the Git documentation.

   git config --global http_proxy $http_proxy

4. Use git clone to clone the workloads repository by using the following command. If the proxy configured correctly, the clone is successful.

   git clone http://github.com/opensearch-project/opensearch-benchmark-workloads.git

5. Lastly, verify that OpenSearch Benchmark can connect to the proxy server by checking the /.benchmark/logs/benchmark.log log. When OpenSearch Benchmark starts, you should see the following at the top of the log:

    Connecting via proxy URL [http://proxy.proxy.org:4444/] to the Internet (picked up from the environment variable [http_proxy]).

Logging

Logs from OpenSearch Benchmark can be configured in the ~/.benchmark/logging.json file. For more information about how to format the log file, see the following Python documentation:

• For general tips and tricks, use the Python Logging Cookbook.
• For the file format, see the Python logging configuration schema.
• For instructions on how to customize where the log output is written, see the logging handlers documentation.

By default, OpenSearch Benchmark logs all output to ~/.benchmark/logs/benchmark.log.