Skip to content

Commit

Permalink
Update concepts.md
Browse files Browse the repository at this point in the history
Signed-off-by: Naarcha-AWS <[email protected]>
  • Loading branch information
Naarcha-AWS authored Sep 20, 2023
1 parent 9535205 commit 1cb62d9
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions _benchmark/user-guide/concepts.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,8 +22,8 @@ Before using OpenSearch Benchmark, familiarize yourself with the following conce

A workload is a specification of one or more benchmarking scenarios. A workload typically includes the following:

- One or more data streams that are ingested into indexes
- A set of queries and operations that are invoked as part of the benchmark
- One or more data streams that are ingested into indexes.
- A set of queries and operations that are invoked as part of the benchmark.

## Anatomy of a workload

Expand Down Expand Up @@ -99,7 +99,7 @@ A workload usually includes the following elements:

### Indices

To create an index, specify its `name`. To add definitions to your index, use the `body` option and point it to the JSON file containing the index definitions. For more information, see [indices]({{site.url}}{{site.baseurl}}/benchmark/workloads/Indices/).
To create an index, specify its `name`. To add definitions to your index, use the `body` option and point it to the JSON file containing the index definitions. For more information, see [indices]({{site.url}}{{site.baseurl}}/benchmark/workloads/indices/).

### Corpora

Expand Down Expand Up @@ -168,4 +168,4 @@ According to this schedule, the actions will run in the following order:
5. The `clients` field defines the number of clients that will run the remaining actions in the schedule concurrently.
6. The `search` runs a `match_all` query to match all documents after they have been indexed by the `bulk` API using the 8 clients specified.
- The `iterations` field indicates the number of times each client runs the `search` operation. The report generated by the benchmark automatically adjusts the percentile numbers based on this number. To generate a precise percentile, the benchmark needs to run at least 1,000 iterations.
- Lastly, the `target-throughput` field defines the number of requests per second each client performs, which, when set, can help reduce the latency of the benchmark. For example, a `target-throughput` of 100 requests divided by 8 clients means that each client will issue 12 requests per second.
- Lastly, the `target-throughput` field defines the number of requests per second each client performs, which, when set, can help reduce the latency of the benchmark. For example, a `target-throughput` of 100 requests divided by 8 clients means that each client will issue 12 requests per second.

0 comments on commit 1cb62d9

Please sign in to comment.