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

[DOC] Benchmark user guide improvements #5815

Closed
17 of 26 tasks
Naarcha-AWS opened this issue Dec 7, 2023 · 4 comments
Closed
17 of 26 tasks

[DOC] Benchmark user guide improvements #5815

Naarcha-AWS opened this issue Dec 7, 2023 · 4 comments
Assignees
Labels
2 - In progress Issue/PR: The issue or PR is in progress. benchmark

Comments

@Naarcha-AWS
Copy link
Collaborator

Naarcha-AWS commented Dec 7, 2023

What do you want to do?

  • Request a change to existing documentation
  • Add new documentation
  • Report a technical problem with the documentation
  • Other

Tell us about your request. Provide a summary of the request and all versions that are affected.

The User Guide doesn't tell a complete story quite yet. Lets add additional content and restructure the section so it can go through everything:

  • Concepts
  • Installing Benchmark
  • Configuring OpenSearch Benchmark
  • Understanding workloads
    • Anatomy of a workload
    • Choosing a workload
      • Description of available workloads and what do they.
      • The most popular workloads:
        • NYC Taxis: A basic, well-rounded search workload.
        • HTTP_logs: A well-rounded time-series workload. If your cluster uses HTTP log data, this might be a good fit for you.
    • Creating a custom workload.
  • Running a workload
    • Connecting your current OpenSearch cluster
      • Docker
    • Provisioning an OpenSearch cluster with OSB
    • Running the test
      • Enabling telemetry devices
  • Understanding Benchmark results (Add understanding results page #6984)
    • Understanding the summary report
    • Going deeper with data stores
      • Telemetry device results are published to the data store.
  • Running distributed loads

What other resources are available? Provide links to related issues, POCs, steps for testing, etc.

@Naarcha-AWS Naarcha-AWS added benchmark 1 - Backlog - DEV Developer assigned to issue is responsible for creating PR. 1 - Backlog - DOC Doc writer assigned to issue responsible for creating PR. labels Dec 7, 2023
@Naarcha-AWS Naarcha-AWS self-assigned this Dec 7, 2023
@Naarcha-AWS Naarcha-AWS removed untriaged 1 - Backlog - DEV Developer assigned to issue is responsible for creating PR. labels Dec 7, 2023
@hdhalter hdhalter added 2 - In progress Issue/PR: The issue or PR is in progress. and removed 1 - Backlog - DOC Doc writer assigned to issue responsible for creating PR. labels Jan 8, 2024
@hdhalter
Copy link
Contributor

@Naarcha-AWS - What is left to do on this issue? Can you please summarize what is left to do? Thanks!

@hdhalter
Copy link
Contributor

Hi @Naarcha-AWS, We received feedback on this page: https://opensearch.org/docs/latest/benchmark/user-guide/telemetry/:
20231123 | It would be nice to have steps on how to do it.

Since the title of the topic is "Enabling telemetry devices", I would expect a process. Are we going to add something to this topic? If not, maybe we can add this text to the topic on 'Summary reports"?

@Naarcha-AWS
Copy link
Collaborator Author

Link to the current User Guide: https://opensearch.org/docs/latest/benchmark/user-guide/index/

The only remaining items are the following:

  • Going deeper with data stores
  • Enabling telemetry devices

@Naarcha-AWS
Copy link
Collaborator Author

Closing this as complete for now.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
2 - In progress Issue/PR: The issue or PR is in progress. benchmark
Projects
None yet
Development

No branches or pull requests

2 participants