Skip to content

[DOC] Benchmark user guide improvements #5815

@Naarcha-AWS

Description

@Naarcha-AWS

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.

Metadata

Metadata

Assignees

Labels

In progressIssue/PR: The issue or PR is in progress.

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions