Migrating from 1.X to 2.X

For users who already have systems that integrate with OpenSearch Benchmark, we recommend performing the following steps for a smooth transition to OpenSearch Benchmark 2.0.

Update Benchmark.ini

OpenSearch Benchmark relies on benchmark.ini, which by default can be found in the ~/.benchmark directory. This configuration file provides configurations related to where metrics are reported, how workloads are fetched, and much more. OpenSearch Benchmark 2.0 renames [results_publishing] to [reporting].

The configuration file should appear as follows:

[reporting]
datastore.type = in-memory
datastore.host = <host-url>
datastore.port = <host-port>
datastore.secure = False
datastore.ssl.verification_mode = <ssl-verification-details>
datastore.user = <username>
datastore.password = <password>
...

For information about how to configure OpenSearch Benchmark, see Configuring OpenSearch Benchmark.

Update external metrics data store

Many users use an external metrics data store to store results and metrics from previous test runs.

OpenSearch Benchmark 1.X stored test details in indexes with the benchmark-test-executions-* index pattern. However, in 2.X, it stores them in indexes with the benchmark-test-runs-* index patttern. We recommend adding this new index pattern in your metrics data store as well as updating dashboards that might still be using the old index pattern.

Update scripts

Some users wrap OpenSearch Benchmark with custom scripts to run nightly performance tests. These scripts may rely on some terminology that has been deprecated in 2.X.

Please see the following terms and adjust your scripts accordingly.

If you encounter any issues when migrating OpenSearch Benchmark from 1.X to 2.X, reach out to the OpenSearch Benchmark maintainers through any of the following ways:

• Post a question in the OpenSearch Benchmark Slack channel.
• Attend the Community Meeting, Office Hours, and Issue Triage.
• Create an issue in the OpenSearch Benchmark Github repository.