Add searchbp metrics to Performance Analyzer #5390
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Signed-off-by: Heather Halter <[email protected]>
hdhalter
requested review from
kolchfa-aws,
Naarcha-AWS,
vagimeli,
ananzh,
seanneumann,
AMoo-Miki and
natebower
as code owners
|
For @khushbr to review when we get closer to the 2.12 release. |
|
Hey @kaushalmahi12 , do you want to take a look at this PR to make sure it is still accurate? We worked on it just before 2.11 so I want to see if anything has changed. Thanks! |
hdhalter
added
the
release-notes
|
@kaushalmahi12 and @khushbr - This is a gentle nudge to review this when you can for the 2.12 release. Thanks! |
khushbr
reviewed
Jan 29, 2024
| </td> | ||
| </tr> | ||
| <tr> | ||
| <td>searchbp_shard_stats_resource_cpu_usage_cancellationCount |
There was a problem hiding this comment.
@kaushalmahi12 : We follow the CamelCase naming convention for metric naming. Can you provide the same for these metrics.
There was a problem hiding this comment.
@kaushalmahi12 : We follow the
CamelCasenaming convention for metric naming. Can you provide the same for these metrics.
These look right to me. Can you please indicate which ones are incorrect?
There was a problem hiding this comment.
For reference
CPU_Utilization - The Metric name begins with Uppercase letter, and uses _ . Following on same line, searchbp_shard_stats_resource_cpu_usage_cancellationCount will be SearchBP_Shard_Stats_Resource_CPU_Usage_CancellationCount.
There was a problem hiding this comment.
Thanks, @khushbr ! @Naarcha-AWS will do the doc review and merge.
hdhalter
added
4 - Doc review
Naarcha-AWS
reviewed
Feb 1, 2024
| <tr> | ||
| <td>searchbp_shard_stats_cancellationCount | ||
| </td> | ||
| <td>The number of tasks marked for cancellation on the shard task. |
There was a problem hiding this comment.
"Shard task" or just "shard"?
There was a problem hiding this comment.
This has been recently renamed to shard_task. opensearch-project/performance-analyzer@81eae43
Naarcha-AWS
reviewed
Feb 1, 2024
There was a problem hiding this comment.
@khushbr: Can you confirm that my change retain the correct technical meaning?
| <tr> | ||
| <td>searchbp_shard_stats_resource_cpu_usage_cancellationCount | ||
| </td> | ||
| <td>The number of tasks marked for cancellation because of excessive CPU usage since the node last restarted on the shard task. |
There was a problem hiding this comment.
Suggested change
| <td>The number of tasks marked for cancellation because of excessive CPU usage since the node last restarted on the shard task. | |
| <td>The number of tasks marked for cancellation because of excessive CPU usage since the last restart of the node containing the shard task. |
| <tr> | ||
| <td>searchbp_task_stats_resource_elaspedtime_usage_cancellationCount | ||
| </td> | ||
| <td>The number of tasks marked for cancellation because of excessive elapsed time since the node last restarted on the search task level. |
There was a problem hiding this comment.
Suggested change
| <td>The number of tasks marked for cancellation because of excessive elapsed time since the node last restarted on the search task level. | |
| <td>The number of tasks marked for cancellation because of excessive elapsed time since the last restart of the node containing the search task level. |
Naarcha-AWS
reviewed
Feb 2, 2024
Naarcha-AWS
reviewed
Feb 2, 2024
Signed-off-by: Naarcha-AWS <[email protected]>
Signed-off-by: Naarcha-AWS <[email protected]>
Naarcha-AWS
approved these changes
Feb 5, 2024
natebower
reviewed
Feb 6, 2024
There was a problem hiding this comment.
@Naarcha-AWS Nice job 😄. Just a few comments/changes. Thanks!
Naarcha-AWS
reviewed
Feb 6, 2024
Naarcha-AWS
reviewed
Feb 6, 2024
Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: Naarcha-AWS <[email protected]>
Naarcha-AWS
added
6 - Done but waiting to merge
hdhalter
added
3 - Done
tianjing-li
pushed a commit
to tianjing-li/documentation-website
that referenced
this pull request
Feb 14, 2024
* added searchbp metrics Signed-off-by: Heather Halter <[email protected]> * Update reference.md Signed-off-by: Naarcha-AWS <[email protected]> * Update reference.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: Heather Halter <[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: Tianjing Li <[email protected]>
tianjing-li
added a commit
to tianjing-li/documentation-website
that referenced
this pull request
Feb 14, 2024
Signed-off-by: Tianjing Li <[email protected]> Clarification of Customer Comment # 20230525 (opensearch-project#6374) * 20230525 clarificaton for customer comment on refernes to kibana Signed-off-by: [email protected] <[email protected]> * 20230525 clarificaton for customer comment on refernes to kibana - scentance clarification Signed-off-by: [email protected] <[email protected]> --------- Signed-off-by: [email protected] <[email protected]> Signed-off-by: Tianjing Li <[email protected]> Add searchbp metrics to Performance Analyzer (opensearch-project#5390) * added searchbp metrics Signed-off-by: Heather Halter <[email protected]> * Update reference.md Signed-off-by: Naarcha-AWS <[email protected]> * Update reference.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: Heather Halter <[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: Tianjing Li <[email protected]> Add documentation for new reranking feature in 2.12 (opensearch-project#6368) * Create reranking.md document new reranking feature in 2.12 Signed-off-by: HenryL27 <[email protected]> * Doc review and address comments Signed-off-by: Fanit Kolchina <[email protected]> * Apply suggestions from code review Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: kolchfa-aws <[email protected]> * Update _search-plugins/search-pipelines/rerank-processor.md Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: kolchfa-aws <[email protected]> * Update _search-plugins/search-pipelines/rerank-processor.md Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: kolchfa-aws <[email protected]> --------- Signed-off-by: HenryL27 <[email protected]> Signed-off-by: Fanit Kolchina <[email protected]> Signed-off-by: kolchfa-aws <[email protected]> Co-authored-by: Fanit Kolchina <[email protected]> Co-authored-by: kolchfa-aws <[email protected]> Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: Tianjing Li <[email protected]> Add Query Insights documentation (opensearch-project#6261) * Query Insights initial documentation Signed-off-by: Chenyang Ji <[email protected]> * Doc review Signed-off-by: Fanit Kolchina <[email protected]> * update endpoints and remove exporters Signed-off-by: Chenyang Ji <[email protected]> * Moved query insights to additional plugins section Signed-off-by: Fanit Kolchina <[email protected]> * Added installation instructions Signed-off-by: Fanit Kolchina <[email protected]> * Apply suggestions from code review Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: kolchfa-aws <[email protected]> * editorial comments Signed-off-by: Fanit Kolchina <[email protected]> * Resolve merge conflicts Signed-off-by: Fanit Kolchina <[email protected]> * merge conflicts and link fix Signed-off-by: Fanit Kolchina <[email protected]> * Fix link Signed-off-by: Fanit Kolchina <[email protected]> --------- Signed-off-by: Chenyang Ji <[email protected]> Signed-off-by: Fanit Kolchina <[email protected]> Signed-off-by: kolchfa-aws <[email protected]> Co-authored-by: Fanit Kolchina <[email protected]> Co-authored-by: kolchfa-aws <[email protected]> Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: Tianjing Li <[email protected]> Add Running a Workload (opensearch-project#6287) * Add Running a Workload draft Signed-off-by: Naarcha-AWS <[email protected]> * Apply suggestions from code review Signed-off-by: Naarcha-AWS <[email protected]> * Update running-workloads.md Signed-off-by: Naarcha-AWS <[email protected]> * Update _benchmark/user-guide/running-workloads.md Signed-off-by: Naarcha-AWS <[email protected]> * Fix link Signed-off-by: Naarcha-AWS <[email protected]> * Add additional missing link Signed-off-by: Naarcha-AWS <[email protected]> * Add running workloads 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: Melissa Vagi <[email protected]> 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]> * Add numbered steps Signed-off-by: Naarcha-AWS <[email protected]> --------- Signed-off-by: Naarcha-AWS <[email protected]> Signed-off-by: Naarcha-AWS <[email protected]> Co-authored-by: Melissa Vagi <[email protected]> Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: Tianjing Li <[email protected]>
kolchfa-aws
added a commit
that referenced
this pull request
Feb 14, 2024
Clarification of Customer Comment # 20230525 (#6374) * 20230525 clarificaton for customer comment on refernes to kibana * 20230525 clarificaton for customer comment on refernes to kibana - scentance clarification --------- Add searchbp metrics to Performance Analyzer (#5390) * added searchbp metrics * Update reference.md * Update reference.md * Apply suggestions from code review --------- Add documentation for new reranking feature in 2.12 (#6368) * Create reranking.md document new reranking feature in 2.12 * Doc review and address comments * Apply suggestions from code review * Update _search-plugins/search-pipelines/rerank-processor.md * Update _search-plugins/search-pipelines/rerank-processor.md --------- Add Query Insights documentation (#6261) * Query Insights initial documentation * Doc review * update endpoints and remove exporters * Moved query insights to additional plugins section * Added installation instructions * Apply suggestions from code review * editorial comments * Resolve merge conflicts * merge conflicts and link fix * Fix link --------- Add Running a Workload (#6287) * Add Running a Workload draft * Apply suggestions from code review * Update running-workloads.md * Update _benchmark/user-guide/running-workloads.md * Fix link * Add additional missing link * Add running workloads * Apply suggestions from code review * Apply suggestions from code review * Apply suggestions from code review * Add numbered steps --------- Signed-off-by: Naarcha-AWS <[email protected]> Signed-off-by: Naarcha-AWS <[email protected]> Signed-off-by: Tianjing Li <[email protected]> Co-authored-by: Melissa Vagi <[email protected]> Co-authored-by: Nathan Bower <[email protected]> Co-authored-by: kolchfa-aws <[email protected]>
oeyh
pushed a commit
to oeyh/documentation-website
that referenced
this pull request
Mar 14, 2024
* added searchbp metrics Signed-off-by: Heather Halter <[email protected]> * Update reference.md Signed-off-by: Naarcha-AWS <[email protected]> * Update reference.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: Heather Halter <[email protected]> Signed-off-by: Naarcha-AWS <[email protected]> Co-authored-by: Naarcha-AWS <[email protected]> Co-authored-by: Nathan Bower <[email protected]>
oeyh
pushed a commit
to oeyh/documentation-website
that referenced
this pull request
Mar 14, 2024
Clarification of Customer Comment # 20230525 (opensearch-project#6374) * 20230525 clarificaton for customer comment on refernes to kibana * 20230525 clarificaton for customer comment on refernes to kibana - scentance clarification --------- Add searchbp metrics to Performance Analyzer (opensearch-project#5390) * added searchbp metrics * Update reference.md * Update reference.md * Apply suggestions from code review --------- Add documentation for new reranking feature in 2.12 (opensearch-project#6368) * Create reranking.md document new reranking feature in 2.12 * Doc review and address comments * Apply suggestions from code review * Update _search-plugins/search-pipelines/rerank-processor.md * Update _search-plugins/search-pipelines/rerank-processor.md --------- Add Query Insights documentation (opensearch-project#6261) * Query Insights initial documentation * Doc review * update endpoints and remove exporters * Moved query insights to additional plugins section * Added installation instructions * Apply suggestions from code review * editorial comments * Resolve merge conflicts * merge conflicts and link fix * Fix link --------- Add Running a Workload (opensearch-project#6287) * Add Running a Workload draft * Apply suggestions from code review * Update running-workloads.md * Update _benchmark/user-guide/running-workloads.md * Fix link * Add additional missing link * Add running workloads * Apply suggestions from code review * Apply suggestions from code review * Apply suggestions from code review * Add numbered steps --------- Signed-off-by: Naarcha-AWS <[email protected]> Signed-off-by: Naarcha-AWS <[email protected]> Signed-off-by: Tianjing Li <[email protected]> Co-authored-by: Melissa Vagi <[email protected]> Co-authored-by: Nathan Bower <[email protected]> Co-authored-by: kolchfa-aws <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Changes for performance analyzer for search backpressure.
Issues Resolved
Takes the place of this PR: #5114
Closes opensearch-project/performance-analyzer#587
Dev issue: opensearch-project/performance-analyzer#587
Checklist
For more information on following Developer Certificate of Origin and signing off your commits, please check here.