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

Add additional details aboutworkload-params #691

Open
Naarcha-AWS opened this issue Nov 8, 2024 · 1 comment
Open

Add additional details aboutworkload-params #691

Naarcha-AWS opened this issue Nov 8, 2024 · 1 comment
Labels
documentation Improvements or additions to documentation

Comments

@Naarcha-AWS
Copy link
Contributor

Please provide details on how and where the documentation can be improved

Recently, a developer encountered the following issue running Vectorsearch with Mensor:

 File "/home/ec2-user/.pyenv/versions/3.8.0/lib/python3.8/site-packages/osbenchmark/test_execution_orchestrator.py", line 378, in run
    pipeline(cfg)
  File "/home/ec2-user/.pyenv/versions/3.8.0/lib/python3.8/site-packages/osbenchmark/test_execution_orchestrator.py", line 69, in __call__
    self.target(cfg)
  File "/home/ec2-user/.pyenv/versions/3.8.0/lib/python3.8/site-packages/osbenchmark/test_execution_orchestrator.py", line 314, in benchmark_only
    return execute_test(cfg, external=True)
  File "/home/ec2-user/.pyenv/versions/3.8.0/lib/python3.8/site-packages/osbenchmark/test_execution_orchestrator.py", line 273, in execute_test
    raise exceptions.BenchmarkError(result.message, result.cause)
osbenchmark.exceptions.BenchmarkError: Error in test execution orchestrator (Unused workload parameters ['target_index_primary_shards', 'target_index_replica_shards'].) 

On the VectorSearch readme, certain parameters that existed in the error were not present in readme. This is because certain workload-params behaviors do not exist in the documentation.

We should modify the documentation to detail how workload-params can be used. Govnid gave the following summary:

  • As the path to a JSON file containing the parameters to pass in, such as /tmp/params.json
  • As verbatim JSON, such as { "field": 10 }
  • As a list of key-value pairs: a:1,cluster_health:green

Provide references

No response

Additional context

No response

@IanHoang
Copy link
Collaborator

IanHoang commented Nov 8, 2024

Thanks Nate, will insert this into the triage board.

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
Projects
Development

No branches or pull requests

2 participants