You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Is your feature request related to a problem? Please describe.
The quickstart guide for opensearch-benchmark demonstrates sample command to execute-test but it can be enhanced with an example of running against locally provisioned cluster as instructed here
Describe the solution you'd like
A step by step guide with sample command illustrating the required client options to run benchmark against locally provisioned cluster
Sample command to debug errors or an FAQ section for frequently encountered errors
Would like the quickstart documentation to have steps similar to below
Here are the steps that I performed to run opensearch-benchmark against locally provisioned cluster
1. As instructed in Opensearch [quickstart](https://opensearch.org/docs/latest/quickstart/) spin up an Opensearch cluster on your local machine
2. Verify that Opensearch service is running
curl https://localhost:9200 -ku admin:admin
{
"name" : "opensearch-node1",
"cluster_name" : "opensearch-cluster",
"cluster_uuid" : "dJMmqiX5Q7ug2aqNtQXDNA",
"version" : {
"distribution" : "opensearch",
"number" : "2.10.0",
"build_type" : "tar",
"build_hash" : "eee49cb340edc6c4d489bcd9324dda571fc8dc03",
"build_date" : "2023-09-20T23:55:20.784011088Z",
"build_snapshot" : false,
"lucene_version" : "9.7.0",
"minimum_wire_compatibility_version" : "7.10.0",
"minimum_index_compatibility_version" : "7.0.0"
},
"tagline" : "The OpenSearch Project: https://opensearch.org/"
}
3. Verify that the cluster health status is green
curl -X GET "https://localhost:9200/_cluster/health?pretty" -ku admin:admin
{
"cluster_name" : "opensearch-cluster",
"status" : "green",
"timed_out" : false,
"number_of_nodes" : 2,
"number_of_data_nodes" : 2,
"discovered_master" : true,
"discovered_cluster_manager" : true,
"active_primary_shards" : 56,
"active_shards" : 62,
"relocating_shards" : 0,
"initializing_shards" : 0,
"unassigned_shards" : 0,
"delayed_unassigned_shards" : 0,
"number_of_pending_tasks" : 0,
"number_of_in_flight_fetch" : 0,
"task_max_waiting_in_queue_millis" : 0,
"active_shards_percent_as_number" : 100.0
}
4. Run benchmark tests against this cluster
opensearch-benchmark execute-test --workload=geonames --pipeline=benchmark-only --target-hosts=https://localhost:9200 --distribution-version=2.10.0 --client-options="basic_auth_user:'admin',basic_auth_password:'admin',verify_certs:false,use_ssl:false" --test-mode --kill-running-processes
**Note**
Only for this locally provisioned cluster we set `use_ssl:false` and `verify_certs:false`
5. In another terminal, monitor the logs to debug any issues with the test execution
tail -f ~/.bencmark/logs/bechmark.log
Describe alternatives you've considered
Additional context
Add any other context or screenshots about the feature request here.
The text was updated successfully, but these errors were encountered:
Is your feature request related to a problem? Please describe.
The quickstart guide for opensearch-benchmark demonstrates sample command to execute-test but it can be enhanced with an example of running against locally provisioned cluster as instructed here
Describe the solution you'd like
Would like the quickstart documentation to have steps similar to below
Here are the steps that I performed to run opensearch-benchmark against locally provisioned cluster
Describe alternatives you've considered
Additional context
Add any other context or screenshots about the feature request here.
The text was updated successfully, but these errors were encountered: