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

[DOCUMENTATION] Performance Testing Best Practices #673

Open
IanHoang opened this issue Oct 3, 2024 · 2 comments
Open

[DOCUMENTATION] Performance Testing Best Practices #673

IanHoang opened this issue Oct 3, 2024 · 2 comments
Labels
documentation Improvements or additions to documentation enhancement New feature or request

Comments

@IanHoang
Copy link
Collaborator

IanHoang commented Oct 3, 2024

Is your feature request related to a problem? Please describe

Many users ask us how to recreate the nightly runs or best practices related to performance testing.

Describe the solution you'd like

We should have an article detailing high-level points.

Describe alternatives you've considered

No response

Additional context

No response

@IanHoang IanHoang added enhancement New feature or request untriaged documentation Improvements or additions to documentation and removed untriaged labels Oct 3, 2024
@IanHoang IanHoang removed the untriaged label Oct 3, 2024
@IanHoang
Copy link
Collaborator Author

@rishabh6788 We can put something together for @Naarcha-AWS based your experience with constructing the nightly runs.

@IanHoang
Copy link
Collaborator Author

In addition to performance testing best practices, we should create documentation for explaining the public nightly runs and dashboards. Users have expressed that the docs and content in dashboards is not intuitive or self explanatory.

Some points we should address in this document:

  • unit to the numbers that are in the graphs? it is milliseconds? requests per second?
  • How is the metrics calculated? important so customers can compare against other competitors they are looking at.
  • Why each metric is important and how it translates to real world application?
  • Maybe a video on the OpenSearch youtube channel with a walkthrough of the metrics would be super helpful and can also be embedded on the webpage.

This documentation should be straightforward so that readers of all backgrounds can understand.

@IanHoang IanHoang moved this from Todo to In Progress in OpenSearch Benchmark Documentation Triage Nov 20, 2024
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
Development

No branches or pull requests

1 participant