Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,35 @@ OpenSearch Benchmark configuration data is stored in `~/.benchmark/benchmark.ini

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

## client_options

This section explains how to customize client-level settings during benchmark execution using the `--client-options` command line flag.

You can pass client-specific parameters to OpenSearch Benchmark using the `--client-options` flag. These parameters let you control low-level client behavior such as timeouts, authentication methods, and SSL settings.

The `--client-options` flag accepts a comma-separated list of key-value pairs, as shown in the following example:

```bash
--client-options=timeout:120,verify_certs:false
```

You can customize `--client-options` with the following settings.

| Option | Type | Description |
| :---- | :---- | :---- |
| `timeout` | Integer | Sets the request timeout value in seconds. |
| `verify_certs` | Boolean | Determines whether to verify SSL certificates when connecting to the OpenSearch cluster. |

This example runs a benchmark with a 2-minute timeout and disabled certificate verification:

```bash
opensearch-benchmark execute-test \
--target-hosts=https://localhost:9200 \
--pipeline=benchmark-only \
--workload=geonames \
--client-options=timeout:120,verify_certs:false
```

<!-- vale off -->
## meta
<!-- vale on -->
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,35 @@ Results from the test appear in the directory set by the `--output-path` option

If you want to run the test in test mode to make sure that your workload operates as intended, add the `--test-mode` option to the `execute-test` command. Test mode ingests only the first 1,000 documents from each index provided and runs query operations against them.

### Working with `--workload-params`

You can customize the behavior of a workload by passing workload-specific parameters using the `--workload-params` option. This flag accepts a comma-separated list of key-value pairs that override default values defined in the workload's `workload.json` file.

For example, some workloads let you configure the number of documents indexed, the number of clients used for query execution, or the index name. These parameters can be critical for tailoring benchmarks to your specific use case or infrastructure constraints.

To pass workload parameters, use the following syntax:

```bash
--workload-params="number_of_documents:100000,index_name:custom-index"
```

Add this option to your `execute-test` command, as shown in the following example:

```bash
opensearch-benchmark execute-test \
--pipeline=benchmark-only \
--workload=nyc_taxis \
--target-host=https://localhost:9200 \
--client-options=basic_auth_user:admin,basic_auth_password:admin,verify_certs:false \
--workload-params="bulk_size:500,index_name:nyc_custom"
```

Available workload parameters can be found in the `README` of each workload in the [OpenSearch Benchmark Workloads GitHub repository](https://github.com/opensearch-project/opensearch-benchmark-workloads).
{: .tip}




## Step 3: Validate the test

After running an OpenSearch Benchmark test, take the following steps to verify that it has run properly:
Expand Down
Loading