Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Enhance opensearch-benchmark quickstart documentation #382

Closed
cgchinmay opened this issue Oct 4, 2023 · 1 comment
Closed

Enhance opensearch-benchmark quickstart documentation #382

cgchinmay opened this issue Oct 4, 2023 · 1 comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request

Comments

@cgchinmay
Copy link
Collaborator

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

  1. A step by step guide with sample command illustrating the required client options to run benchmark against locally provisioned cluster
  2. 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.

@cgchinmay cgchinmay added the enhancement New feature or request label Oct 4, 2023
@IanHoang IanHoang added documentation Improvements or additions to documentation and removed untriaged labels Oct 4, 2023
@IanHoang
Copy link
Collaborator

IanHoang commented Oct 5, 2023

Going to close this since duplicate with #383.

@IanHoang IanHoang closed this as completed Oct 5, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants