info

The info command prints details about an OpenSearch Benchmark component.

Usage

The following example returns information about a workload named nyc_taxis:

  1. opensearch-benchmark info --workload=nyc_taxis

OpenSearch Benchmark returns information about the workload, as shown in the following example response:

  1.    ____                  _____                      __       ____                  __                         __
  2.   / __ \____  ___  ____ / ___/___  ____ ___________/ /_     / __ )___  ____  _____/ /_  ____ ___  ____ ______/ /__
  3.  / / / / __ \/ _ \/ __ \\__ \/ _ \/ __ `/ ___/ ___/ __ \   / __  / _ \/ __ \/ ___/ __ \/ __ `__ \/ __ `/ ___/ //_/
  4. / /_/ / /_/ /  __/ / / /__/ /  __/ /_/ / /  / /__/ / / /  / /_/ /  __/ / / / /__/ / / / / / / / / /_/ / /  / ,<
  5. \____/ .___/\___/_/ /_/____/\___/\__,_/_/   \___/_/ /_/  /_____/\___/_/ /_/\___/_/ /_/_/ /_/ /_/\__,_/_/  /_/|_|
  6.     /_/
  8. Showing details for workload [nyc_taxis]:
  10. * Description: Taxi rides in New York in 2015
  11. * Documents: 165,346,692
  12. * Compressed Size: 4.5 GB
  13. * Uncompressed Size: 74.3 GB
  15. ===================================
  16. TestProcedure [searchable-snapshot]
  17. ===================================
  19. Measuring performance for Searchable Snapshot feature. Based on the default test procedure 'append-no-conflicts'.
  21. Schedule: 
  22. ----------
  24. 1. delete-index
  25. 2. create-index 
  26. 3. check-cluster-health
  27. 4. index (8 clients)
  28. 5. refresh-after-index
  29. 6. force-merge
  30. 7. refresh-after-force-merge
  31. 8. wait-until-merges-finish
  32. 9. create-snapshot-repository
  33. 10. delete-snapshot
  34. 11. create-snapshot
  35. 12. wait-for-snapshot-creation
  36. 13. delete-local-index
  37. 14. restore-snapshot
  38. 15. default 
  39. 16. range
  40. 17. distance_amount_agg
  41. 18. autohisto_agg
  42. 19. date_histogram_agg
  44. ====================================================
  45. TestProcedure [append-no-conflicts] (run by default) 
  46. ====================================================
  48. Indexes the entire document corpus using a setup that will lead to a larger indexing throughput than the default settings and produce a smaller index (higher compression rate). Document IDs are unique, so all index operations are append only. After that, a couple of queries are run. 
  50. Schedule:
  51. ----------
  53. 1. delete-index
  54. 2. create-index
  55. 3. check-cluster-health
  56. 4. index (8 clients)
  57. 5. refresh-after-index
  58. 6. force-merge
  59. 7. refresh-after-force-merge
  60. 8. wait-until-merges-finish
  61. 9. default
  62. 10. range
  63. 11. distance_amount_agg
  64. 12. autohisto_agg
  65. 13. date_histogram_agg
  67. ==============================================
  68. TestProcedure [append-no-conflicts-index-only]
  69. ==============================================
  71. Indexes the whole document corpus using a setup that will lead to a larger indexing throughput than the default settings and produce a smaller index (higher compression rate). Document ids are unique so all index operations are append only.
  73. Schedule:
  74. ----------
  76. 1. delete-index
  77. 2. create-index
  78. 3. check-cluster-health
  79. 4. index (8 clients)
  80. 5. refresh-after-index
  81. 6. force-merge
  82. 7. refresh-after-force-merge
  83. 8. wait-until-merges-finish
  85. =====================================================
  86. TestProcedure [append-sorted-no-conflicts-index-only]
  87. =====================================================
  89. Indexes the whole document corpus in an index sorted by pickup_datetime field in descending order (most recent first) and using a setup that will lead to a larger indexing throughput than the default settings and produce a smaller index (higher compression rate). Document ids are unique so all index operations are append only.
  91. Schedule:
  92. ----------
  94. 1. delete-index
  95. 2. create-index
  96. 3. check-cluster-health
  97. 4. index (8 clients)
  98. 5. refresh-after-index
  99. 6. force-merge
  100. 7. refresh-after-force-merge
  101. 8. wait-until-merges-finish
  103. ======================
  104. TestProcedure [update]
  105. ======================
  107. Schedule:
  108. ----------
  110. 1. delete-index
  111. 2. create-index
  112. 3. check-cluster-health
  113. 4. update (8 clients)
  114. 5. refresh-after-index
  115. 6. force-merge
  116. 7. refresh-after-force-merge
  117. 8. wait-until-merges-finish
  120. -------------------------------
  121. [INFO] SUCCESS (took 2 seconds)
  122. -------------------------------

Options

You can use the following options with the info command:

  • --workload-repository: Defines the repository from where OpenSearch Benchmark loads workloads.
  • --workload-path: Defines the path to a downloaded or custom workload.
  • --workload-revision: Defines a specific revision from the workload source tree that OpenSearch Benchmark should use.
  • --workload: Defines the workload to use based on the workload’s name. You can find a list of preloaded workloads using opensearch-benchmark list workloads.
  • --test-procedure: Defines a test procedure to use. You can find a list of test procedures using opensearch-benchmark list test_procedures.
  • --include-tasks: Defines a comma-separated list of test procedure tasks to run. By default, all tasks listed in a test procedure array are run.
  • --exclude-tasks: Defines a comma-separated list of test procedure tasks not to run.