Skip to content

OSB: fix incorrect links and add a FAQ #11475

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.

Sign up for GitHub

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

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
+33 −2
Open

OSB: fix incorrect links and add a FAQ #11475

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
1004e4d
OSB: fix incorrect links and add a FAQ.
gkamat Oct 31, 2025
5f57149
Update _benchmark/FAQs.md
gkamat Nov 7, 2025
7b36cdb
Update _benchmark/FAQs.md
gkamat Nov 7, 2025
d35d3c3
Update _benchmark/FAQs.md
gkamat Nov 7, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 30 additions & 0 deletions _benchmark/FAQs.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
---
layout: default
title: FAQs
nav_order: 103
---

# FAQs

This section provides answers to frequently asked questions.


## How can I get more information about an error that I encountered?

Check failure on line 12 in _benchmark/FAQs.md

View workflow job for this annotation

GitHub Actions / style-job 

[vale] reported by reviewdog 🐶
[OpenSearch.HeadingPunctuation] Don't use punctuation at the end of a heading.

Raw Output:
{"message": "[OpenSearch.HeadingPunctuation] Don't use punctuation at the end of a heading.", "location": {"path": "_benchmark/FAQs.md", "range": {"start": {"line": 12, "column": 68}}}, "severity": "ERROR"}

Check the end of the OSB log files to view messages from the latest run.

You also have the following options:
Copy link
Collaborator

@kolchfa-aws kolchfa-aws Nov 3, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
You also have the following options:
If you need more help, you can:

- [Post a question in the OpenSearch Benchmark Slack channel](https://opensearch.slack.com/archives/C082PLA3VPW).
- [Attend the community meeting, office hours, or issue triage session](https://www.meetup.com/opensearch/events/309982456/?eventOrigin=group_upcoming_events).


## Where are the OSB log files located?

Check failure on line 21 in _benchmark/FAQs.md

View workflow job for this annotation

GitHub Actions / style-job 

[vale] reported by reviewdog 🐶
[OpenSearch.HeadingPunctuation] Don't use punctuation at the end of a heading.

Raw Output:
{"message": "[OpenSearch.HeadingPunctuation] Don't use punctuation at the end of a heading.", "location": {"path": "_benchmark/FAQs.md", "range": {"start": {"line": 21, "column": 39}}}, "severity": "ERROR"}

By default, they are in the user's home directory, under `$HOME/.osb/osb.log`.
Copy link
Collaborator

@kolchfa-aws kolchfa-aws Nov 3, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
By default, they are in the user's home directory, under `$HOME/.osb/osb.log`.
By default, the OSB log files are located in the your home directory, under `$HOME/.osb/osb.log`.



## I'm looking for the latest updates to OSB. Where can I find the latest incremental build of OSB?

Check failure on line 26 in _benchmark/FAQs.md

View workflow job for this annotation

GitHub Actions / style-job 

[vale] reported by reviewdog 🐶
[OpenSearch.HeadingPunctuation] Don't use punctuation at the end of a heading.

Raw Output:
{"message": "[OpenSearch.HeadingPunctuation] Don't use punctuation at the end of a heading.", "location": {"path": "_benchmark/FAQs.md", "range": {"start": {"line": 26, "column": 100}}}, "severity": "ERROR"}

Check failure on line 26 in _benchmark/FAQs.md

View workflow job for this annotation

GitHub Actions / style-job 

[vale] reported by reviewdog 🐶
[OpenSearch.SpacingPunctuation] There should be no space before and one space after the punctuation mark in 'OSB. Where'.

Raw Output:
{"message": "[OpenSearch.SpacingPunctuation] There should be no space before and one space after the punctuation mark in 'OSB. Where'.", "location": {"path": "_benchmark/FAQs.md", "range": {"start": {"line": 26, "column": 42}}}, "severity": "ERROR"}

Incremental OSB builds are generated as Docker images when any new changes are merged to the codebase. They are available [here](https://hub.docker.com/r/opensearchstaging/opensearch-benchmark/tags).

Check failure on line 28 in _benchmark/FAQs.md

View workflow job for this annotation

GitHub Actions / style-job 

[vale] reported by reviewdog 🐶
[OpenSearch.SpacingPunctuation] There should be no space before and one space after the punctuation mark in 'codebase. They'.

Raw Output:
{"message": "[OpenSearch.SpacingPunctuation] There should be no space before and one space after the punctuation mark in 'codebase. They'.", "location": {"path": "_benchmark/FAQs.md", "range": {"start": {"line": 28, "column": 94}}}, "severity": "ERROR"}
Copy link
Collaborator

@kolchfa-aws kolchfa-aws Nov 3, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Incremental OSB builds are generated as Docker images when any new changes are merged to the codebase. They are available [here](https://hub.docker.com/r/opensearchstaging/opensearch-benchmark/tags).
Incremental OSB builds are generated as Docker images when any new changes are merged to the codebase. They are available on the [OpenSearch Benchmark Docker Hub page](https://hub.docker.com/r/opensearchstaging/opensearch-benchmark/tags).



3 changes: 2 additions & 1 deletion _benchmark/reference/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,4 +10,5 @@ redirect_from:

# Reference

The following section contains reference materials for commands, metrics, and workloads for OpenSearch Benchmark.
The following section contains reference materials for [commands]({{site.url}}{{site.baseurl}}/benchmark/reference/commands/), [metrics]({{site.url}}{{site.baseurl}}/benchmark/reference/metrics/), and [workloads]({{site.url}}{{site.baseurl}}/benchmark/reference/workloads/) for OpenSearch Benchmark.

2 changes: 1 addition & 1 deletion _benchmark/user-guide/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ redirect_from:

# OpenSearch Benchmark User Guide

The OpenSearch Benchmark User Guide includes core [concepts]({{site.url}}{{site.baseurl}}/benchmark/user-guide/concepts/), [installation]({{site.url}}{{site.baseurl}}/benchmark/installing-benchmark/) instructions, and [configuration options]({{site.url}}{{site.baseurl}}/benchmark/configuring-benchmark/) to help you get the most out of OpenSearch Benchmark.
The OpenSearch Benchmark User Guide includes core [concepts]({{site.url}}{{site.baseurl}}/benchmark/user-guide/concepts/), [installation instructions]({{site.url}}{{site.baseurl}}/benchmark/installing-benchmark/), and [configuration options]({{site.url}}{{site.baseurl}}/benchmark/configuring-benchmark/) to help you get the most out of OpenSearch Benchmark.


{% include cards.html cards=page.more_cards %}
Loading