-
Notifications
You must be signed in to change notification settings - Fork 507
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 understanding results page #6984
Conversation
Signed-off-by: Archer <[email protected]>
Signed-off-by: Archer <[email protected]>
Signed-off-by: Archer <[email protected]>
Signed-off-by: Archer <[email protected]>
Signed-off-by: Archer <[email protected]>
| error rate | term | 0 | % | | ||
``` | ||
|
||
The unique metrics to yhe cluster begin at the `index` task line. The following two use cases can give you an idea of what metrics might be relevant to you: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
yhe -> the
The unique metrics to yhe cluster begin at the `index` task line. The following two use cases can give you an idea of what metrics might be relevant to you: | ||
|
||
- To assess how much load your cluster can handle, the `index` task metrics provide the number of documents ingested during the workload run. | ||
- To assess how fast you can query against documents in your cluster, the `match_all` and `term` give both the number of query operations performed per second and the measurable latency of the query. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
the measurable latency and service time of the query
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Maybe add error rate associated with the ingesting documents and running query operations should be added to both points.
|
||
While [running a test](https://opensearch.org/docs/latest/benchmark/reference/commands/execute-test/#general-settings), you can also customize where the results are stored, using any combination of the following command flags: | ||
|
||
* `--results-file`: When provided a file path, writes the compare results to the file indicated in the path. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
the compare results --> the summary report
|
||
* `--results-file`: When provided a file path, writes the compare results to the file indicated in the path. | ||
* `--results-format`: Defines the output format for the command line results, either markdown or csv. Default is `markdown`. | ||
* `--show-in-results`: Determines whether or not to include a comparison to previous runs in the results file. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
--show-in-results {available,all-percentiles,all}
Define which values are shown in the summary publish (default: available).
Allows users to define which values are shown in the summary report
* `--results-file`: When provided a file path, writes the compare results to the file indicated in the path. | ||
* `--results-format`: Defines the output format for the command line results, either markdown or csv. Default is `markdown`. | ||
* `--show-in-results`: Determines whether or not to include a comparison to previous runs in the results file. | ||
* `--user-tag`: Defines user-specific key-value pairs to be used in metric record as meta information, for example, `intention:baseline-ticket-12345`. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We can also add how this is useful when storing metrics and results in an external metric store
|
||
## Selecting metrics to compare | ||
|
||
While an OpenSearch Benchmark summary report provides many metrics related to the performance of your cluster, how to compare and use those metrics depends on your use case. Some users might be interested in the number of documents their can index, while another might be interested in how much latency it takes to query a document. For example, during the OpenSearch Benchmark nightly runs, the OpenSearch teams pulls metrics similar to the following summary report: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
interested in the latency or service time for a document to be queried.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We should stick with summary report (instead of using command line results)
--- | ||
|
||
|
||
At the end of each test run, a summary table is produced which includes metrics like service time, throughput, latency and more. These metrics provide insights into how the workload selected performed on a benchmarked OpenSearch cluster. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
a summary results table
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
on an OpenSearch cluster
|
||
At the end of each test run, a summary table is produced which includes metrics like service time, throughput, latency and more. These metrics provide insights into how the workload selected performed on a benchmarked OpenSearch cluster. | ||
|
||
The following guide gives information about to understand the results of the summary report and what steps to take before running another test on your cluster. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
about how to understand the summary results
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think we can also remove "what steps to take before running another test on your cluster" as that's not found here.
Signed-off-by: Naarcha-AWS <[email protected]>
Signed-off-by: Naarcha-AWS <[email protected]>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks, Nate! I reviewed the first half and will do the second half later today. I left a few suggestions for reorganizing some of the info and some wording tweaks.
|
||
## OpenSearch Benchmark runs | ||
|
||
OpenSearch Benchmark runs a series of nightly tests targeting the overall OpenSearch development cluster. These runs can be found on https://opensearch.org/benchmarks. It compares several metrics across different test runs targeting both recent and future versions of OpenSearch. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This sounds better as the opening paragraph because the first paragraph doesn't give any context. Can you move it up?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is specific to the link provided in the paragraph. It only applies as an example and not as the standard for summary reports. In the orginal draft, this section was at the bottom and included a disclaimer similar to the following, "Use the nightly benchmark runs as an example of how to present your benchmark results in OpenSearch Dashboards."
@@ -0,0 +1,125 @@ | |||
--- | |||
layout: default | |||
title: Understanding results |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Understanding workload test results?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
"Understanding benchmark results?" What do you think @IanHoang
--- | ||
|
||
|
||
At the end of each test run, a summary table is produced which includes metrics like service time, throughput, latency, and more. These metrics provide insights into how the workload selected performed on a benchmarked OpenSearch cluster. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This should come later in the topic, perhaps to introduce a sample table.
|
||
At the end of each test run, a summary table is produced which includes metrics like service time, throughput, latency, and more. These metrics provide insights into how the workload selected performed on a benchmarked OpenSearch cluster. | ||
|
||
The following guide gives information about how to understand the results of the summary report. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Is this necessary?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
HI Nate, here are a few tweaks to the second half.
|
||
Results from OpenSearch Benchmark are stored in two ways, either in-memory or in an external metric store. | ||
|
||
When stored in-memory, results can be found in the `/.benchmark/benchmarks/test_executions/<test_execution_id>` directory. Results are named based off of the `test_execution_id` given to the workload test during its last run. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
When stored in-memory, results can be found in the `/.benchmark/benchmarks/test_executions/<test_execution_id>` directory. Results are named based off of the `test_execution_id` given to the workload test during its last run. | |
When stored in-memory, results are found in the `/.benchmark/benchmarks/test_executions/<test_execution_id>` directory. The name of the result is based on the `test_execution_id` given to the workload test during its most recent run. |
Co-authored-by: Heather Halter <[email protected]> Signed-off-by: Naarcha-AWS <[email protected]>
Signed-off-by: Naarcha-AWS <[email protected]>
Signed-off-by: Naarcha-AWS <[email protected]>
Signed-off-by: Naarcha-AWS <[email protected]>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good! Just one comment on a heading. Thanks.
|
||
## OpenSearch Benchmark runs | ||
|
||
OpenSearch Benchmark runs a series of nightly tests targeting the OpenSearch development cluster. The results of these test runs can be found on https://opensearch.org/benchmarks. The results show the metrics that span different test runs and target both recent and future versions of OpenSearch. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Can we define 'runs' here if that is the terminology that we are using for the nightly test? OpenSearch Benchmark runs are the nightly tests that target the OS dev cluster..."
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@Naarcha-AWS Please see my comments and changes and let me know if you have any questions. Thanks!
Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: Naarcha-AWS <[email protected]>
* Add refresh API. Signed-off-by: Archer <[email protected]> * Add Understanding Results section Signed-off-by: Archer <[email protected]> * Additional feedback. Signed-off-by: Archer <[email protected]> * Rework important metrics section. Signed-off-by: Archer <[email protected]> * Add summary report breakdown Signed-off-by: Archer <[email protected]> * Apply suggestions from code review Signed-off-by: Naarcha-AWS <[email protected]> * Apply suggestions from code review Signed-off-by: Naarcha-AWS <[email protected]> * Apply suggestions from code review Signed-off-by: Naarcha-AWS <[email protected]> * Delete _api-reference/index-apis/refresh.md Signed-off-by: Naarcha-AWS <[email protected]> * Update understanding-results.md Signed-off-by: Naarcha-AWS <[email protected]> * Apply suggestions from code review Signed-off-by: Naarcha-AWS <[email protected]> * Apply suggestions from code review Signed-off-by: Naarcha-AWS <[email protected]> * Apply suggestions from code review Co-authored-by: Heather Halter <[email protected]> Signed-off-by: Naarcha-AWS <[email protected]> * Apply suggestions from code review Signed-off-by: Naarcha-AWS <[email protected]> * Apply suggestions from code review Signed-off-by: Naarcha-AWS <[email protected]> * Apply suggestions from code review Signed-off-by: Naarcha-AWS <[email protected]> * Apply suggestions from code review Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: Naarcha-AWS <[email protected]> --------- Signed-off-by: Archer <[email protected]> Signed-off-by: Naarcha-AWS <[email protected]> Co-authored-by: Heather Halter <[email protected]> Co-authored-by: Nathan Bower <[email protected]> (cherry picked from commit e45e461) Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
* Add refresh API. Signed-off-by: Archer <[email protected]> * Add Understanding Results section Signed-off-by: Archer <[email protected]> * Additional feedback. Signed-off-by: Archer <[email protected]> * Rework important metrics section. Signed-off-by: Archer <[email protected]> * Add summary report breakdown Signed-off-by: Archer <[email protected]> * Apply suggestions from code review Signed-off-by: Naarcha-AWS <[email protected]> * Apply suggestions from code review Signed-off-by: Naarcha-AWS <[email protected]> * Apply suggestions from code review Signed-off-by: Naarcha-AWS <[email protected]> * Delete _api-reference/index-apis/refresh.md Signed-off-by: Naarcha-AWS <[email protected]> * Update understanding-results.md Signed-off-by: Naarcha-AWS <[email protected]> * Apply suggestions from code review Signed-off-by: Naarcha-AWS <[email protected]> * Apply suggestions from code review Signed-off-by: Naarcha-AWS <[email protected]> * Apply suggestions from code review Co-authored-by: Heather Halter <[email protected]> Signed-off-by: Naarcha-AWS <[email protected]> * Apply suggestions from code review Signed-off-by: Naarcha-AWS <[email protected]> * Apply suggestions from code review Signed-off-by: Naarcha-AWS <[email protected]> * Apply suggestions from code review Signed-off-by: Naarcha-AWS <[email protected]> * Apply suggestions from code review Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: Naarcha-AWS <[email protected]> --------- Signed-off-by: Archer <[email protected]> Signed-off-by: Naarcha-AWS <[email protected]> Co-authored-by: Heather Halter <[email protected]> Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: Sagar Upadhyaya <[email protected]>
* Add cache plugin and tiered cache documentation Signed-off-by: Sagar Upadhyaya <[email protected]> * Apply suggestions from code review Signed-off-by: Naarcha-AWS <[email protected]> Signed-off-by: Sagar Upadhyaya <[email protected]> * Apply suggestions from code review Signed-off-by: Naarcha-AWS <[email protected]> Signed-off-by: Sagar Upadhyaya <[email protected]> * Update index.md Signed-off-by: Sagar Upadhyaya <[email protected]> * Update concepts.md (#7049) Signed-off-by: Naarcha-AWS <[email protected]> Signed-off-by: Sagar Upadhyaya <[email protected]> * Update alert-finding-api.md (#7036) Signed-off-by: Heather Halter <[email protected]> Signed-off-by: Sagar Upadhyaya <[email protected]> * [DOC] Add urldecode processor documentation (#5994) * Add urldecode processor documentation Signed-off-by: Melissa Vagi <[email protected]> * Add text and examples Signed-off-by: Melissa Vagi <[email protected]> * Update urldecode.md Signed-off-by: Melissa Vagi <[email protected]> Signed-off-by: Melissa Vagi <[email protected]> * Update _ingest-pipelines/processors/urldecode.md Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: Melissa Vagi <[email protected]> * Update _ingest-pipelines/processors/urldecode.md Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: Melissa Vagi <[email protected]> * Update _ingest-pipelines/processors/urldecode.md Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: Melissa Vagi <[email protected]> * Update _ingest-pipelines/processors/urldecode.md Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: Melissa Vagi <[email protected]> * Update _ingest-pipelines/processors/urldecode.md Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: Melissa Vagi <[email protected]> * Update urldecode.md Signed-off-by: Melissa Vagi <[email protected]> Signed-off-by: Melissa Vagi <[email protected]> --------- Signed-off-by: Melissa Vagi <[email protected]> Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: Sagar Upadhyaya <[email protected]> * clarify "contexts" (#7063) Signed-off-by: Stavros Macrakis <[email protected]> Signed-off-by: Sagar Upadhyaya <[email protected]> * Add documentation for indices.replication.max_bytes_per_sec (#7048) * Add documentation for indices.replication.max_bytes_per_sec Signed-off-by: Marc Handalian <[email protected]> * Update _install-and-configure/configuring-opensearch/index-settings.md Signed-off-by: Naarcha-AWS <[email protected]> * Apply suggestions from code review Signed-off-by: Naarcha-AWS <[email protected]> --------- Signed-off-by: Marc Handalian <[email protected]> Signed-off-by: Naarcha-AWS <[email protected]> Co-authored-by: Naarcha-AWS <[email protected]> Signed-off-by: Sagar Upadhyaya <[email protected]> * Update concurrent search docs with composite aggs updates (#7043) Signed-off-by: Jay Deng <[email protected]> Signed-off-by: Sagar Upadhyaya <[email protected]> * add query_by_tokens option in Neural Sparse Search (#7040) * query tokens Signed-off-by: zhichao-aws <[email protected]> * fix typo Signed-off-by: zhichao-aws <[email protected]> * typo Signed-off-by: zhichao-aws <[email protected]> * fix Signed-off-by: zhichao-aws <[email protected]> * Update _query-dsl/specialized/neural-sparse.md Co-authored-by: Naarcha-AWS <[email protected]> Signed-off-by: zhichao-aws <[email protected]> * Update _query-dsl/specialized/neural-sparse.md Co-authored-by: Naarcha-AWS <[email protected]> Signed-off-by: zhichao-aws <[email protected]> * Update _query-dsl/specialized/neural-sparse.md Co-authored-by: Naarcha-AWS <[email protected]> Signed-off-by: zhichao-aws <[email protected]> * Update _query-dsl/specialized/neural-sparse.md Co-authored-by: Naarcha-AWS <[email protected]> Signed-off-by: zhichao-aws <[email protected]> * Update _query-dsl/specialized/neural-sparse.md Co-authored-by: Naarcha-AWS <[email protected]> Signed-off-by: zhichao-aws <[email protected]> * Update _search-plugins/neural-sparse-search.md Co-authored-by: Naarcha-AWS <[email protected]> Signed-off-by: zhichao-aws <[email protected]> * Update _search-plugins/neural-sparse-search.md Co-authored-by: Naarcha-AWS <[email protected]> Signed-off-by: zhichao-aws <[email protected]> * Apply suggestions from code review Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: Naarcha-AWS <[email protected]> --------- Signed-off-by: zhichao-aws <[email protected]> Signed-off-by: Naarcha-AWS <[email protected]> Co-authored-by: Naarcha-AWS <[email protected]> Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: Sagar Upadhyaya <[email protected]> * Update bundled JDK version (April 2024 Patch releases) (#7031) Signed-off-by: Andriy Redko <[email protected]> Signed-off-by: Sagar Upadhyaya <[email protected]> * Updating documentation for ignore_unavailable search request parameter (#6987) * Updating documentation for ignore_unavailable search request parameter Signed-off-by: Ankit Jain <[email protected]> * Update _api-reference/search.md Co-authored-by: Naarcha-AWS <[email protected]> Signed-off-by: Ankit Jain <[email protected]> * Update _api-reference/document-apis/delete-by-query.md Co-authored-by: Naarcha-AWS <[email protected]> Signed-off-by: Ankit Jain <[email protected]> * Update _api-reference/document-apis/update-by-query.md Co-authored-by: Naarcha-AWS <[email protected]> Signed-off-by: Ankit Jain <[email protected]> --------- Signed-off-by: Ankit Jain <[email protected]> Co-authored-by: Naarcha-AWS <[email protected]> Signed-off-by: Sagar Upadhyaya <[email protected]> * Add documentation for hardware-accelerated compression codecs. (#6841) * Add documentation for hardware-accelerated compression codecs. Signed-off-by: Mulugeta Mammo <[email protected]> * Fix based on the review from reviewdog. Signed-off-by: Mulugeta Mammo <[email protected]> * Use the registered symbol for Intel and Xeon. Signed-off-by: mulugetam <[email protected]> * Minor modifications to the text. Signed-off-by: mulugetam <[email protected]> * Rephrasing. Signed-off-by: mulugetam <[email protected]> * Paraphrasing. Signed-off-by: mulugetam <[email protected]> * Apply suggestions from code review Signed-off-by: Naarcha-AWS <[email protected]> * Update _im-plugin/index-codecs.md Signed-off-by: Naarcha-AWS <[email protected]> * Update _install-and-configure/configuring-opensearch/index-settings.md Signed-off-by: Naarcha-AWS <[email protected]> * Apply suggestions from code review Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: Naarcha-AWS <[email protected]> --------- Signed-off-by: Mulugeta Mammo <[email protected]> Signed-off-by: mulugetam <[email protected]> Signed-off-by: Naarcha-AWS <[email protected]> Co-authored-by: Naarcha-AWS <[email protected]> Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: Sagar Upadhyaya <[email protected]> * Correct the release version for the upgrade API feature (#6955) Signed-off-by: Peter Nied <[email protected]> Signed-off-by: Sagar Upadhyaya <[email protected]> * [DOC] Add user agent processor documentation (#5995) * Add user agent processor documentation Signed-off-by: Melissa Vagi <[email protected]> * Add user agent processor documentation Signed-off-by: Melissa Vagi <[email protected]> * Add examples Signed-off-by: Melissa Vagi <[email protected]> * Add user agent processor documentation Signed-off-by: Melissa Vagi <[email protected]> * Add user agent processor documentation Signed-off-by: Melissa Vagi <[email protected]> * Add examples Signed-off-by: Melissa Vagi <[email protected]> * Add examples and text Signed-off-by: Melissa Vagi <[email protected]> * Update user-agent.md Signed-off-by: Melissa Vagi <[email protected]> Signed-off-by: Melissa Vagi <[email protected]> * Update user-agent.md Signed-off-by: Melissa Vagi <[email protected]> Signed-off-by: Melissa Vagi <[email protected]> * Update _ingest-pipelines/processors/user-agent.md Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: Melissa Vagi <[email protected]> * Update _ingest-pipelines/processors/user-agent.md Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: Melissa Vagi <[email protected]> * Update _ingest-pipelines/processors/user-agent.md Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: Melissa Vagi <[email protected]> * Update _ingest-pipelines/processors/user-agent.md Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: Melissa Vagi <[email protected]> * Update _ingest-pipelines/processors/user-agent.md Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: Melissa Vagi <[email protected]> * Update _ingest-pipelines/processors/user-agent.md Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: Melissa Vagi <[email protected]> * Update user-agent.md Signed-off-by: Melissa Vagi <[email protected]> Signed-off-by: Melissa Vagi <[email protected]> --------- Signed-off-by: Melissa Vagi <[email protected]> Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: Sagar Upadhyaya <[email protected]> * Add understanding results page (#6984) * Add refresh API. Signed-off-by: Archer <[email protected]> * Add Understanding Results section Signed-off-by: Archer <[email protected]> * Additional feedback. Signed-off-by: Archer <[email protected]> * Rework important metrics section. Signed-off-by: Archer <[email protected]> * Add summary report breakdown Signed-off-by: Archer <[email protected]> * Apply suggestions from code review Signed-off-by: Naarcha-AWS <[email protected]> * Apply suggestions from code review Signed-off-by: Naarcha-AWS <[email protected]> * Apply suggestions from code review Signed-off-by: Naarcha-AWS <[email protected]> * Delete _api-reference/index-apis/refresh.md Signed-off-by: Naarcha-AWS <[email protected]> * Update understanding-results.md Signed-off-by: Naarcha-AWS <[email protected]> * Apply suggestions from code review Signed-off-by: Naarcha-AWS <[email protected]> * Apply suggestions from code review Signed-off-by: Naarcha-AWS <[email protected]> * Apply suggestions from code review Co-authored-by: Heather Halter <[email protected]> Signed-off-by: Naarcha-AWS <[email protected]> * Apply suggestions from code review Signed-off-by: Naarcha-AWS <[email protected]> * Apply suggestions from code review Signed-off-by: Naarcha-AWS <[email protected]> * Apply suggestions from code review Signed-off-by: Naarcha-AWS <[email protected]> * Apply suggestions from code review Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: Naarcha-AWS <[email protected]> --------- Signed-off-by: Archer <[email protected]> Signed-off-by: Naarcha-AWS <[email protected]> Co-authored-by: Heather Halter <[email protected]> Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: Sagar Upadhyaya <[email protected]> * Add cluster setting for filter rewrite optimization in aggregation (#7033) * Add cluster setting for filter rewrite optimization in aggregation Signed-off-by: bowenlan-amzn <[email protected]> * Update search-settings.md Signed-off-by: Melissa Vagi <[email protected]> --------- Signed-off-by: bowenlan-amzn <[email protected]> Signed-off-by: Melissa Vagi <[email protected]> Co-authored-by: Melissa Vagi <[email protected]> Signed-off-by: Sagar Upadhyaya <[email protected]> * remove-has-childreren (#7072) Signed-off-by: Heather Halter <[email protected]> Signed-off-by: Sagar Upadhyaya <[email protected]> * Update csp configuration instructions for OSD (#7026) * Update docs about configuring frame-ancestors Signed-off-by: Tianle Huang <[email protected]> * update fgac info Signed-off-by: Tianle Huang <[email protected]> * add fgac info Signed-off-by: Tianle Huang <[email protected]> * fix vale Signed-off-by: Tianle Huang <[email protected]> * fix readme Signed-off-by: Tianle Huang <[email protected]> * Update _dashboards/csp/csp-dynamic-configuration.md Co-authored-by: Melissa Vagi <[email protected]> Signed-off-by: Tianle Huang <[email protected]> * Update _dashboards/csp/csp-dynamic-configuration.md Co-authored-by: Melissa Vagi <[email protected]> Signed-off-by: Tianle Huang <[email protected]> * Update _dashboards/csp/csp-dynamic-configuration.md Co-authored-by: Melissa Vagi <[email protected]> Signed-off-by: Tianle Huang <[email protected]> * Update _dashboards/csp/csp-dynamic-configuration.md Co-authored-by: Melissa Vagi <[email protected]> Signed-off-by: Tianle Huang <[email protected]> * Update _dashboards/csp/csp-dynamic-configuration.md Co-authored-by: Melissa Vagi <[email protected]> Signed-off-by: Tianle Huang <[email protected]> * Update csp-dynamic-configuration.md Signed-off-by: Melissa Vagi <[email protected]> Signed-off-by: Melissa Vagi <[email protected]> * Update _dashboards/csp/csp-dynamic-configuration.md Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: Tianle Huang <[email protected]> * Update _dashboards/csp/csp-dynamic-configuration.md Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: Tianle Huang <[email protected]> * Update _dashboards/csp/csp-dynamic-configuration.md Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: Tianle Huang <[email protected]> * Update _dashboards/csp/csp-dynamic-configuration.md Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: Tianle Huang <[email protected]> * Update _dashboards/csp/csp-dynamic-configuration.md Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: Tianle Huang <[email protected]> * Update _dashboards/csp/csp-dynamic-configuration.md Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: Tianle Huang <[email protected]> * Update _dashboards/csp/csp-dynamic-configuration.md Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: Tianle Huang <[email protected]> * Update _dashboards/csp/csp-dynamic-configuration.md Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: Tianle Huang <[email protected]> * Update _dashboards/csp/csp-dynamic-configuration.md Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: Tianle Huang <[email protected]> * Update _dashboards/csp/csp-dynamic-configuration.md Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: Melissa Vagi <[email protected]> * Update _dashboards/csp/csp-dynamic-configuration.md Signed-off-by: Melissa Vagi <[email protected]> --------- Signed-off-by: Tianle Huang <[email protected]> Signed-off-by: Tianle Huang <[email protected]> Signed-off-by: Melissa Vagi <[email protected]> Co-authored-by: Melissa Vagi <[email protected]> Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: Sagar Upadhyaya <[email protected]> * adding do_not_fail_on_forbidden section to docs #4896 (#6958) * adding do_not_fail_on_forbidden section to docs #4896 Signed-off-by: AntonEliatra <[email protected]> * Update _security/access-control/permissions.md Co-authored-by: Stephen Crawford <[email protected]> Signed-off-by: Melissa Vagi <[email protected]> * Update _security/access-control/permissions.md Co-authored-by: Stephen Crawford <[email protected]> Signed-off-by: Melissa Vagi <[email protected]> * Update _security/access-control/permissions.md Co-authored-by: Stephen Crawford <[email protected]> Signed-off-by: Melissa Vagi <[email protected]> * Update permissions.md Signed-off-by: Melissa Vagi <[email protected]> Signed-off-by: Melissa Vagi <[email protected]> * Update _security/access-control/permissions.md Signed-off-by: Melissa Vagi <[email protected]> * Update permissions.md Signed-off-by: Melissa Vagi <[email protected]> Signed-off-by: Melissa Vagi <[email protected]> * Update permissions.md Signed-off-by: Melissa Vagi <[email protected]> Signed-off-by: Melissa Vagi <[email protected]> * Update _security/access-control/permissions.md Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: Melissa Vagi <[email protected]> * Update _security/access-control/permissions.md Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: Melissa Vagi <[email protected]> * Update _security/access-control/permissions.md Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: Melissa Vagi <[email protected]> * Update _security/access-control/permissions.md Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: Melissa Vagi <[email protected]> * Update _security/access-control/permissions.md Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: Melissa Vagi <[email protected]> * Update _security/access-control/permissions.md Signed-off-by: Melissa Vagi <[email protected]> --------- Signed-off-by: AntonEliatra <[email protected]> Signed-off-by: Melissa Vagi <[email protected]> Co-authored-by: Melissa Vagi <[email protected]> Co-authored-by: Stephen Crawford <[email protected]> Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: Sagar Upadhyaya <[email protected]> * feat: fix overlap rate param (#7045) Signed-off-by: Ian Menendez <[email protected]> Signed-off-by: Sagar Upadhyaya <[email protected]> * adding kibana_server role specification and explanation #4094 (#7066) * adding kibana_user role specification and explanation #4094 Signed-off-by: AntonEliatra <[email protected]> * Apply suggestions from code review Co-authored-by: Melissa Vagi <[email protected]> Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: AntonEliatra <[email protected]> * Update multi-tenancy-config.md Signed-off-by: AntonEliatra <[email protected]> * Apply suggestions from code review Co-authored-by: Melissa Vagi <[email protected]> Signed-off-by: AntonEliatra <[email protected]> * Update multi-tenancy-config.md Signed-off-by: AntonEliatra <[email protected]> --------- Signed-off-by: AntonEliatra <[email protected]> Co-authored-by: Melissa Vagi <[email protected]> Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: Sagar Upadhyaya <[email protected]> * expanding on TrustStore and KeyStore #4578 #4060 (#7015) * expanding on TrustStore and KeyStore #4578 #4060 Signed-off-by: AntonEliatra <[email protected]> * expanding on TrustStore and KeyStore #4578 #4060 Signed-off-by: AntonEliatra <[email protected]> * Update generate-certificates.md Signed-off-by: AntonEliatra <[email protected]> * Update opensearch-keystore.md Signed-off-by: AntonEliatra <[email protected]> * Apply suggestions from code review Co-authored-by: Stephen Crawford <[email protected]> Signed-off-by: AntonEliatra <[email protected]> * Update security-admin.md Signed-off-by: AntonEliatra <[email protected]> * Apply suggestions from code review Co-authored-by: Melissa Vagi <[email protected]> Signed-off-by: AntonEliatra <[email protected]> * Apply suggestions from code review Co-authored-by: Melissa Vagi <[email protected]> Signed-off-by: AntonEliatra <[email protected]> * Apply suggestions from code review Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: AntonEliatra <[email protected]> --------- Signed-off-by: AntonEliatra <[email protected]> Co-authored-by: Stephen Crawford <[email protected]> Co-authored-by: Melissa Vagi <[email protected]> Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: Sagar Upadhyaya <[email protected]> * Add documentation for primary rebalancing (#7059) * Add documentation for primary rebalacing Signed-off-by: Arpit Bandejiya <[email protected]> * Update _install-and-configure/configuring-opensearch/cluster-settings.md Signed-off-by: Naarcha-AWS <[email protected]> * Apply suggestions from code review Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: Naarcha-AWS <[email protected]> --------- Signed-off-by: Arpit Bandejiya <[email protected]> Signed-off-by: Naarcha-AWS <[email protected]> Co-authored-by: Naarcha-AWS <[email protected]> Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: Sagar Upadhyaya <[email protected]> * Update stats.md (#7087) Signed-off-by: Naarcha-AWS <[email protected]> Signed-off-by: Sagar Upadhyaya <[email protected]> * navbar yml update. (#7091) * Omitting the named anchor from header Download link. Signed-off-by: Nathan Boot <[email protected]> * Updates navbar yml. --------- Signed-off-by: Nathan Boot <[email protected]> Co-authored-by: Heather Halter <[email protected]> Signed-off-by: Sagar Upadhyaya <[email protected]> * Missed a few includes that are referred to by the navbar. (#7093) * Omitting the named anchor from header Download link. Signed-off-by: Nathan Boot <[email protected]> * Updates navbar yml. * Navbar sass and html includes required for navbar. --------- Signed-off-by: Nathan Boot <[email protected]> Co-authored-by: Heather Halter <[email protected]> Signed-off-by: Sagar Upadhyaya <[email protected]> * Add missing OPENSEARCH_INITIAL_ADMIN_PASSWORD for both apt/deb and yum/rpm (#7079) * Add missing OPENSEARCH_INITIAL_ADMIN_PASSWORD for apt install on debian.md This page's install command when installing via rep package is missing `OPENSEARCH_INITIAL_ADMIN_PASSWORD` Signed-off-by: Drew Miranda <[email protected]> * More update on deb and rpm installation steps on 2.12 security changes Signed-off-by: Peter Zhu <[email protected]> * Move 2.12 top Signed-off-by: Peter Zhu <[email protected]> * fix formatting Signed-off-by: Peter Zhu <[email protected]> * More tweaks Signed-off-by: Peter Zhu <[email protected]> * More tweaks 2 Signed-off-by: Peter Zhu <[email protected]> * Update _install-and-configure/install-opensearch/debian.md Signed-off-by: Peter Zhu <[email protected]> Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: Peter Zhu <[email protected]> * Update _install-and-configure/install-opensearch/debian.md Signed-off-by: Peter Zhu <[email protected]> Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: Peter Zhu <[email protected]> * Update _install-and-configure/install-opensearch/debian.md Signed-off-by: Peter Zhu <[email protected]> Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: Peter Zhu <[email protected]> * Update _install-and-configure/install-opensearch/debian.md Signed-off-by: Peter Zhu <[email protected]> Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: Peter Zhu <[email protected]> * Update _install-and-configure/install-opensearch/debian.md Signed-off-by: Peter Zhu <[email protected]> Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: Peter Zhu <[email protected]> * Update _install-and-configure/install-opensearch/rpm.md Signed-off-by: Peter Zhu <[email protected]> Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: Peter Zhu <[email protected]> * Update _install-and-configure/install-opensearch/rpm.md Signed-off-by: Peter Zhu <[email protected]> Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: Peter Zhu <[email protected]> * Update _install-and-configure/install-opensearch/rpm.md Signed-off-by: Peter Zhu <[email protected]> Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: Peter Zhu <[email protected]> * Update _install-and-configure/install-opensearch/rpm.md Signed-off-by: Peter Zhu <[email protected]> Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: Peter Zhu <[email protected]> * Update _install-and-configure/install-opensearch/rpm.md Signed-off-by: Peter Zhu <[email protected]> Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: Peter Zhu <[email protected]> * Update _install-and-configure/install-opensearch/rpm.md Signed-off-by: Peter Zhu <[email protected]> Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: Peter Zhu <[email protected]> * Update _install-and-configure/install-opensearch/rpm.md Signed-off-by: Peter Zhu <[email protected]> Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: Peter Zhu <[email protected]> * Add more things Signed-off-by: Peter Zhu <[email protected]> * Add more things Signed-off-by: Peter Zhu <[email protected]> * Update _install-and-configure/install-opensearch/debian.md Signed-off-by: Peter Zhu <[email protected]> Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: Peter Zhu <[email protected]> --------- Signed-off-by: Drew Miranda <[email protected]> Signed-off-by: Peter Zhu <[email protected]> Co-authored-by: Peter Zhu <[email protected]> Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: Sagar Upadhyaya <[email protected]> * Update tiered-cache.md Signed-off-by: Sagar Upadhyaya <[email protected]> * Apply suggestions from code review Signed-off-by: Naarcha-AWS <[email protected]> Signed-off-by: Sagar Upadhyaya <[email protected]> * Apply suggestions from code review Signed-off-by: Naarcha-AWS <[email protected]> Signed-off-by: Sagar Upadhyaya <[email protected]> * Update _search-plugins/caching/index.md Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: Sagar <[email protected]> Signed-off-by: Sagar Upadhyaya <[email protected]> * Update _search-plugins/caching/index.md Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: Sagar <[email protected]> Signed-off-by: Sagar Upadhyaya <[email protected]> * Update _search-plugins/caching/index.md Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: Sagar <[email protected]> Signed-off-by: Sagar Upadhyaya <[email protected]> * Update _search-plugins/caching/index.md Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: Sagar <[email protected]> Signed-off-by: Sagar Upadhyaya <[email protected]> * Update _search-plugins/caching/index.md Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: Sagar <[email protected]> Signed-off-by: Sagar Upadhyaya <[email protected]> * Update _search-plugins/caching/tiered-cache.md Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: Sagar <[email protected]> Signed-off-by: Sagar Upadhyaya <[email protected]> * Update _search-plugins/caching/tiered-cache.md Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: Sagar <[email protected]> Signed-off-by: Sagar Upadhyaya <[email protected]> * Update _search-plugins/caching/tiered-cache.md Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: Sagar <[email protected]> Signed-off-by: Sagar Upadhyaya <[email protected]> * Update _search-plugins/caching/tiered-cache.md Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: Sagar <[email protected]> Signed-off-by: Sagar Upadhyaya <[email protected]> * Update _search-plugins/caching/tiered-cache.md Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: Sagar <[email protected]> Signed-off-by: Sagar Upadhyaya <[email protected]> * Update _search-plugins/caching/tiered-cache.md Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: Sagar <[email protected]> Signed-off-by: Sagar Upadhyaya <[email protected]> * Update _search-plugins/caching/tiered-cache.md Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: Sagar <[email protected]> Signed-off-by: Sagar Upadhyaya <[email protected]> * Update _search-plugins/caching/tiered-cache.md Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: Sagar <[email protected]> Signed-off-by: Sagar Upadhyaya <[email protected]> * Update _search-plugins/caching/tiered-cache.md Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: Sagar <[email protected]> Signed-off-by: Sagar Upadhyaya <[email protected]> * Update _search-plugins/caching/tiered-cache.md Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: Sagar <[email protected]> Signed-off-by: Sagar Upadhyaya <[email protected]> * Addressing comments Signed-off-by: Sagar Upadhyaya <[email protected]> * Apply suggestions from code review Signed-off-by: Naarcha-AWS <[email protected]> --------- Signed-off-by: Sagar Upadhyaya <[email protected]> Signed-off-by: Naarcha-AWS <[email protected]> Signed-off-by: Heather Halter <[email protected]> Signed-off-by: Melissa Vagi <[email protected]> Signed-off-by: Stavros Macrakis <[email protected]> Signed-off-by: Marc Handalian <[email protected]> Signed-off-by: Jay Deng <[email protected]> Signed-off-by: zhichao-aws <[email protected]> Signed-off-by: Andriy Redko <[email protected]> Signed-off-by: Ankit Jain <[email protected]> Signed-off-by: Mulugeta Mammo <[email protected]> Signed-off-by: mulugetam <[email protected]> Signed-off-by: Peter Nied <[email protected]> Signed-off-by: Archer <[email protected]> Signed-off-by: bowenlan-amzn <[email protected]> Signed-off-by: Heather Halter <[email protected]> Signed-off-by: Tianle Huang <[email protected]> Signed-off-by: Tianle Huang <[email protected]> Signed-off-by: AntonEliatra <[email protected]> Signed-off-by: Ian Menendez <[email protected]> Signed-off-by: Arpit Bandejiya <[email protected]> Signed-off-by: Nathan Boot <[email protected]> Signed-off-by: Drew Miranda <[email protected]> Signed-off-by: Peter Zhu <[email protected]> Signed-off-by: Sagar <[email protected]> Co-authored-by: Naarcha-AWS <[email protected]> Co-authored-by: Heather Halter <[email protected]> Co-authored-by: Melissa Vagi <[email protected]> Co-authored-by: Nathan Bower <[email protected]> Co-authored-by: Stavros Macrakis <[email protected]> Co-authored-by: Marc Handalian <[email protected]> Co-authored-by: Jay Deng <[email protected]> Co-authored-by: zhichao-aws <[email protected]> Co-authored-by: Andriy Redko <[email protected]> Co-authored-by: Ankit Jain <[email protected]> Co-authored-by: mulugetam <[email protected]> Co-authored-by: Peter Nied <[email protected]> Co-authored-by: bowenlan-amzn <[email protected]> Co-authored-by: Tianle Huang <[email protected]> Co-authored-by: AntonEliatra <[email protected]> Co-authored-by: Stephen Crawford <[email protected]> Co-authored-by: Ian Menendez <[email protected]> Co-authored-by: Arpit-Bandejiya <[email protected]> Co-authored-by: Nate B <[email protected]> Co-authored-by: Drew Miranda <[email protected]> Co-authored-by: Peter Zhu <[email protected]>
Add understanding results page to the OpenSearch Benchmark user guide
Addresses part of #5815
Checklist
For more information on following Developer Certificate of Origin and signing off your commits, please check here.