-
Notifications
You must be signed in to change notification settings - Fork 459
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 searchbp metrics to Performance Analyzer #5390
Conversation
Signed-off-by: Heather Halter <hdhalter@amazon.com>
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! |
@kaushalmahi12 and @khushbr - This is a gentle nudge to review this when you can for the 2.12 release. Thanks! |
</td> | ||
</tr> | ||
<tr> | ||
<td>searchbp_shard_stats_resource_cpu_usage_cancellationCount |
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.
@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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@kaushalmahi12 : We follow the
CamelCase
naming 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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
For reference
<td>CPU_Utilization |
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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks, @khushbr ! @Naarcha-AWS will do the doc review and merge.
<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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
"Shard task" or just "shard"?
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 has been recently renamed to shard_task
. opensearch-project/performance-analyzer@81eae43
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.
@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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
<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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
<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. |
Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>
Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>
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 Nice job 😄. Just a few comments/changes. Thanks!
Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>
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.
LGTM!
* added searchbp metrics Signed-off-by: Heather Halter <hdhalter@amazon.com> * Update reference.md Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Update reference.md Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Apply suggestions from code review Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> --------- Signed-off-by: Heather Halter <hdhalter@amazon.com> Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> Co-authored-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Tianjing Li <tianjinglimail@gmail.com>
Signed-off-by: Tianjing Li <tianjinglimail@gmail.com> Clarification of Customer Comment # 20230525 (opensearch-project#6374) * 20230525 clarificaton for customer comment on refernes to kibana Signed-off-by: leanne.laceybyrne@eliatra.com <leanne.laceybyrne@eliatra.com> * 20230525 clarificaton for customer comment on refernes to kibana - scentance clarification Signed-off-by: leanne.laceybyrne@eliatra.com <leanne.laceybyrne@eliatra.com> --------- Signed-off-by: leanne.laceybyrne@eliatra.com <leanne.laceybyrne@eliatra.com> Signed-off-by: Tianjing Li <tianjinglimail@gmail.com> Add searchbp metrics to Performance Analyzer (opensearch-project#5390) * added searchbp metrics Signed-off-by: Heather Halter <hdhalter@amazon.com> * Update reference.md Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Update reference.md Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Apply suggestions from code review Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> --------- Signed-off-by: Heather Halter <hdhalter@amazon.com> Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> Co-authored-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Tianjing Li <tianjinglimail@gmail.com> 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 <hmlindeman@yahoo.com> * Doc review and address comments Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Apply suggestions from code review Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> * Update _search-plugins/search-pipelines/rerank-processor.md Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> * Update _search-plugins/search-pipelines/rerank-processor.md Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> --------- Signed-off-by: HenryL27 <hmlindeman@yahoo.com> Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> Co-authored-by: Fanit Kolchina <kolchfa@amazon.com> Co-authored-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Tianjing Li <tianjinglimail@gmail.com> Add Query Insights documentation (opensearch-project#6261) * Query Insights initial documentation Signed-off-by: Chenyang Ji <cyji@amazon.com> * Doc review Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * update endpoints and remove exporters Signed-off-by: Chenyang Ji <cyji@amazon.com> * Moved query insights to additional plugins section Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Added installation instructions Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Apply suggestions from code review Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> * editorial comments Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Resolve merge conflicts Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * merge conflicts and link fix Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Fix link Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> --------- Signed-off-by: Chenyang Ji <cyji@amazon.com> Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> Co-authored-by: Fanit Kolchina <kolchfa@amazon.com> Co-authored-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Tianjing Li <tianjinglimail@gmail.com> Add Running a Workload (opensearch-project#6287) * Add Running a Workload draft Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Apply suggestions from code review Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Update running-workloads.md Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Update _benchmark/user-guide/running-workloads.md Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Fix link Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Add additional missing link Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Add running workloads Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Apply suggestions from code review Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Apply suggestions from code review Co-authored-by: Melissa Vagi <vagimeli@amazon.com> Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Apply suggestions from code review Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Add numbered steps Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> --------- Signed-off-by: Naarcha-AWS <naarcha@amazon.com> Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> Co-authored-by: Melissa Vagi <vagimeli@amazon.com> Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Tianjing Li <tianjinglimail@gmail.com>
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 <naarcha@amazon.com> Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> Signed-off-by: Tianjing Li <tianjinglimail@gmail.com> Co-authored-by: Melissa Vagi <vagimeli@amazon.com> Co-authored-by: Nathan Bower <nbower@amazon.com> Co-authored-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com>
* added searchbp metrics Signed-off-by: Heather Halter <hdhalter@amazon.com> * Update reference.md Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Update reference.md Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Apply suggestions from code review Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> --------- Signed-off-by: Heather Halter <hdhalter@amazon.com> Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> Co-authored-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> Co-authored-by: Nathan Bower <nbower@amazon.com>
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 <naarcha@amazon.com> Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> Signed-off-by: Tianjing Li <tianjinglimail@gmail.com> Co-authored-by: Melissa Vagi <vagimeli@amazon.com> Co-authored-by: Nathan Bower <nbower@amazon.com> Co-authored-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com>
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.