Skip to content
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 new Performance Analyzer metrics and fix table formatting #5182

Merged
merged 21 commits into from
Oct 13, 2023

Conversation

hdhalter
Copy link
Contributor

Description

The table had some formatting issues, so I fixed the table formatting and added the new metrics. This takes the place of: #5114

Issues Resolved

n/a
opensearch-project/performance-analyzer#483

Checklist

  • By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license and subject to the Developers Certificate of Origin.
    For more information on following Developer Certificate of Origin and signing off your commits, please check here.

Signed-off-by: Heather Halter <hdhalter@amazon.com>
@hdhalter
Copy link
Contributor Author

@khushbr @ruai0511

@hdhalter hdhalter added 3 - Tech review PR: Tech review in progress v2.11.0 labels Oct 10, 2023
@hdhalter hdhalter self-assigned this Oct 10, 2023
Signed-off-by: Heather Halter <hdhalter@amazon.com>
@ruai0511
Copy link
Contributor

Thank you for re-formatting! This makes sense. I added two rows to the Dimension Reference table in the old pull request which aren't present here.

@hdhalter
Copy link
Contributor Author

Thanks, @ruai0511 ! I added the two items in the Dimensions section. I'm still working out some of the kinks in the formatting, and should have another version up soon. If you have any information about the relationship between the metrics and dimensions, that would be helpful. I tried to provide some context in the opening paragraph, but not sure if I got it right. Thanks, again.

@hdhalter hdhalter marked this pull request as draft October 11, 2023 00:51
Signed-off-by: Heather Halter <hdhalter@amazon.com>
@hdhalter hdhalter marked this pull request as ready for review October 11, 2023 03:19
@hdhalter
Copy link
Contributor Author

hdhalter commented Oct 11, 2023

I have a few questions for dev/PM/ @ruai0511 :

  • Can you please explain the relationship between the metrics and dimensions? I would like to provide some context as the intro to the topic and as the intro to the dimensions table at the bottom.
  • What is WIP? Can we replace it with something meaningful?
  • Why is one of the tables "Dimensions: N/A"? What does that mean?
    Thanks!

Signed-off-by: Heather Halter <HDHALTER@AMAZON.COM>
Signed-off-by: Heather Halter <HDHALTER@AMAZON.COM>
Signed-off-by: Heather Halter <HDHALTER@AMAZON.COM>
_monitoring-your-cluster/pa/reference.md Outdated Show resolved Hide resolved
_monitoring-your-cluster/pa/reference.md Outdated Show resolved Hide resolved
_monitoring-your-cluster/pa/reference.md Outdated Show resolved Hide resolved
_monitoring-your-cluster/pa/reference.md Outdated Show resolved Hide resolved
_monitoring-your-cluster/pa/reference.md Outdated Show resolved Hide resolved
hdhalter and others added 4 commits October 12, 2023 13:22
Co-authored-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>
Signed-off-by: Heather Halter <HDHALTER@AMAZON.COM>
Co-authored-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>
Signed-off-by: Heather Halter <HDHALTER@AMAZON.COM>
Co-authored-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>
Signed-off-by: Heather Halter <HDHALTER@AMAZON.COM>
Co-authored-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>
Signed-off-by: Heather Halter <HDHALTER@AMAZON.COM>
hdhalter and others added 3 commits October 12, 2023 13:23
Co-authored-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>
Signed-off-by: Heather Halter <HDHALTER@AMAZON.COM>
Co-authored-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>
Signed-off-by: Heather Halter <HDHALTER@AMAZON.COM>
Fixed the intro statement

Signed-off-by: Heather Halter <HDHALTER@AMAZON.COM>
@hdhalter hdhalter added 5 - Editorial review PR: Editorial review in progress and removed 3 - Tech review PR: Tech review in progress labels Oct 12, 2023
Copy link
Collaborator

@natebower natebower left a comment

Choose a reason for hiding this comment

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

@hdhalter Please see my comments and changes and let me know if you have any questions. It looks like there are still placeholders/unfinished elements in places, I suspect that some terms should be in code font that are not currently, and I think that some of the phrasing may be inaccurate, so please get a doc review before approval. Thanks!

_monitoring-your-cluster/pa/reference.md Outdated Show resolved Hide resolved
_monitoring-your-cluster/pa/reference.md Outdated Show resolved Hide resolved
_monitoring-your-cluster/pa/reference.md Outdated Show resolved Hide resolved
_monitoring-your-cluster/pa/reference.md Outdated Show resolved Hide resolved
_monitoring-your-cluster/pa/reference.md Outdated Show resolved Hide resolved
_monitoring-your-cluster/pa/reference.md Outdated Show resolved Hide resolved
_monitoring-your-cluster/pa/reference.md Outdated Show resolved Hide resolved
_monitoring-your-cluster/pa/reference.md Outdated Show resolved Hide resolved
_monitoring-your-cluster/pa/reference.md Outdated Show resolved Hide resolved
_monitoring-your-cluster/pa/reference.md Outdated Show resolved Hide resolved
Editorial corrections.

Co-authored-by: Nathan Bower <nbower@amazon.com>
Signed-off-by: Heather Halter <HDHALTER@AMAZON.COM>
Added a description under the Dimensions: N/A section and a couple editorial nits.

Signed-off-by: Heather Halter <HDHALTER@AMAZON.COM>
Signed-off-by: Heather Halter <HDHALTER@AMAZON.COM>
Signed-off-by: Heather Halter <HDHALTER@AMAZON.COM>
Signed-off-by: Heather Halter <HDHALTER@AMAZON.COM>
Signed-off-by: Heather Halter <HDHALTER@AMAZON.COM>
Co-authored-by: Nathan Bower <nbower@amazon.com>
Signed-off-by: Heather Halter <HDHALTER@AMAZON.COM>
Copy link
Collaborator

@natebower natebower left a comment

Choose a reason for hiding this comment

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

LGTM

Removed search backpressure info, as requested; removed info marked with TBD.

Signed-off-by: Heather Halter <HDHALTER@AMAZON.COM>
@hdhalter
Copy link
Contributor Author

I removed all the new content. @khushbr , please approve. Thanks!

@hdhalter
Copy link
Contributor Author

@hdhalter I made another commit based on the reviews on my pull request (I don't think I can commit to your PR since I don't have write permission.)

I saw that, but @khushbr said the search backpressure metrics were not going in 2.11 now. I will make sure your input is reflected in the content when it gets delivered.

@ruai0511
Copy link
Contributor

@hdhalter I made another commit based on the reviews on my pull request (I don't think I can commit to your PR since I don't have write permission.)

I saw that, but @khushbr said the search backpressure metrics were not going in 2.11 now. I will make sure your input is reflected in the content when it gets delivered.

Ah Sure. Thanks!

@hdhalter hdhalter removed 5 - Editorial review PR: Editorial review in progress v2.11.0 labels Oct 13, 2023
@hdhalter
Copy link
Contributor Author

Merging this without search backpressure metrics (which is targeting 2.12), since it fixes the formatting problems and has been edited. I've remove the 2.11 label.

@hdhalter hdhalter merged commit 5769c16 into main Oct 13, 2023
4 checks passed
vagimeli pushed a commit that referenced this pull request Oct 13, 2023
* fixed problem with table and added new metrics

Signed-off-by: Heather Halter <hdhalter@amazon.com>

* fix formatting

Signed-off-by: Heather Halter <hdhalter@amazon.com>

* fixed table formatting

Signed-off-by: Heather Halter <hdhalter@amazon.com>

* Update reference.md

Signed-off-by: Heather Halter <HDHALTER@AMAZON.COM>

* Update reference.md

Signed-off-by: Heather Halter <HDHALTER@AMAZON.COM>

* Update reference.md

Signed-off-by: Heather Halter <HDHALTER@AMAZON.COM>

* Update _monitoring-your-cluster/pa/reference.md

Co-authored-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>
Signed-off-by: Heather Halter <HDHALTER@AMAZON.COM>

* Update _monitoring-your-cluster/pa/reference.md

Co-authored-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>
Signed-off-by: Heather Halter <HDHALTER@AMAZON.COM>

* Update _monitoring-your-cluster/pa/reference.md

Co-authored-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>
Signed-off-by: Heather Halter <HDHALTER@AMAZON.COM>

* Update _monitoring-your-cluster/pa/reference.md

Co-authored-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>
Signed-off-by: Heather Halter <HDHALTER@AMAZON.COM>

* Update _monitoring-your-cluster/pa/reference.md

Co-authored-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>
Signed-off-by: Heather Halter <HDHALTER@AMAZON.COM>

* Update _monitoring-your-cluster/pa/reference.md

Co-authored-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>
Signed-off-by: Heather Halter <HDHALTER@AMAZON.COM>

* Update reference.md

Fixed the intro statement

Signed-off-by: Heather Halter <HDHALTER@AMAZON.COM>

* Apply suggestions from code review

Editorial corrections.

Co-authored-by: Nathan Bower <nbower@amazon.com>
Signed-off-by: Heather Halter <HDHALTER@AMAZON.COM>

* Update reference.md

Added a description under the Dimensions: N/A section and a couple editorial nits.

Signed-off-by: Heather Halter <HDHALTER@AMAZON.COM>

* Update reference.md

Signed-off-by: Heather Halter <HDHALTER@AMAZON.COM>

* Update reference.md

Signed-off-by: Heather Halter <HDHALTER@AMAZON.COM>

* Update reference.md

Signed-off-by: Heather Halter <HDHALTER@AMAZON.COM>

* Update reference.md

Signed-off-by: Heather Halter <HDHALTER@AMAZON.COM>

* Update _monitoring-your-cluster/pa/reference.md

Co-authored-by: Nathan Bower <nbower@amazon.com>
Signed-off-by: Heather Halter <HDHALTER@AMAZON.COM>

* Update reference.md

Removed search backpressure info, as requested; removed info marked with TBD.

Signed-off-by: Heather Halter <HDHALTER@AMAZON.COM>

---------

Signed-off-by: Heather Halter <hdhalter@amazon.com>
Signed-off-by: Heather Halter <HDHALTER@AMAZON.COM>
Co-authored-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>
Co-authored-by: Nathan Bower <nbower@amazon.com>
Signed-off-by: Melissa Vagi <vagimeli@amazon.com>
harshavamsi pushed a commit to harshavamsi/documentation-website that referenced this pull request Oct 31, 2023
…arch-project#5182)

* fixed problem with table and added new metrics

Signed-off-by: Heather Halter <hdhalter@amazon.com>

* fix formatting

Signed-off-by: Heather Halter <hdhalter@amazon.com>

* fixed table formatting

Signed-off-by: Heather Halter <hdhalter@amazon.com>

* Update reference.md

Signed-off-by: Heather Halter <HDHALTER@AMAZON.COM>

* Update reference.md

Signed-off-by: Heather Halter <HDHALTER@AMAZON.COM>

* Update reference.md

Signed-off-by: Heather Halter <HDHALTER@AMAZON.COM>

* Update _monitoring-your-cluster/pa/reference.md

Co-authored-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>
Signed-off-by: Heather Halter <HDHALTER@AMAZON.COM>

* Update _monitoring-your-cluster/pa/reference.md

Co-authored-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>
Signed-off-by: Heather Halter <HDHALTER@AMAZON.COM>

* Update _monitoring-your-cluster/pa/reference.md

Co-authored-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>
Signed-off-by: Heather Halter <HDHALTER@AMAZON.COM>

* Update _monitoring-your-cluster/pa/reference.md

Co-authored-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>
Signed-off-by: Heather Halter <HDHALTER@AMAZON.COM>

* Update _monitoring-your-cluster/pa/reference.md

Co-authored-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>
Signed-off-by: Heather Halter <HDHALTER@AMAZON.COM>

* Update _monitoring-your-cluster/pa/reference.md

Co-authored-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>
Signed-off-by: Heather Halter <HDHALTER@AMAZON.COM>

* Update reference.md

Fixed the intro statement

Signed-off-by: Heather Halter <HDHALTER@AMAZON.COM>

* Apply suggestions from code review

Editorial corrections.

Co-authored-by: Nathan Bower <nbower@amazon.com>
Signed-off-by: Heather Halter <HDHALTER@AMAZON.COM>

* Update reference.md

Added a description under the Dimensions: N/A section and a couple editorial nits.

Signed-off-by: Heather Halter <HDHALTER@AMAZON.COM>

* Update reference.md

Signed-off-by: Heather Halter <HDHALTER@AMAZON.COM>

* Update reference.md

Signed-off-by: Heather Halter <HDHALTER@AMAZON.COM>

* Update reference.md

Signed-off-by: Heather Halter <HDHALTER@AMAZON.COM>

* Update reference.md

Signed-off-by: Heather Halter <HDHALTER@AMAZON.COM>

* Update _monitoring-your-cluster/pa/reference.md

Co-authored-by: Nathan Bower <nbower@amazon.com>
Signed-off-by: Heather Halter <HDHALTER@AMAZON.COM>

* Update reference.md

Removed search backpressure info, as requested; removed info marked with TBD.

Signed-off-by: Heather Halter <HDHALTER@AMAZON.COM>

---------

Signed-off-by: Heather Halter <hdhalter@amazon.com>
Signed-off-by: Heather Halter <HDHALTER@AMAZON.COM>
Co-authored-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>
Co-authored-by: Nathan Bower <nbower@amazon.com>
vagimeli pushed a commit that referenced this pull request Dec 21, 2023
* fixed problem with table and added new metrics

Signed-off-by: Heather Halter <hdhalter@amazon.com>

* fix formatting

Signed-off-by: Heather Halter <hdhalter@amazon.com>

* fixed table formatting

Signed-off-by: Heather Halter <hdhalter@amazon.com>

* Update reference.md

Signed-off-by: Heather Halter <HDHALTER@AMAZON.COM>

* Update reference.md

Signed-off-by: Heather Halter <HDHALTER@AMAZON.COM>

* Update reference.md

Signed-off-by: Heather Halter <HDHALTER@AMAZON.COM>

* Update _monitoring-your-cluster/pa/reference.md

Co-authored-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>
Signed-off-by: Heather Halter <HDHALTER@AMAZON.COM>

* Update _monitoring-your-cluster/pa/reference.md

Co-authored-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>
Signed-off-by: Heather Halter <HDHALTER@AMAZON.COM>

* Update _monitoring-your-cluster/pa/reference.md

Co-authored-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>
Signed-off-by: Heather Halter <HDHALTER@AMAZON.COM>

* Update _monitoring-your-cluster/pa/reference.md

Co-authored-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>
Signed-off-by: Heather Halter <HDHALTER@AMAZON.COM>

* Update _monitoring-your-cluster/pa/reference.md

Co-authored-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>
Signed-off-by: Heather Halter <HDHALTER@AMAZON.COM>

* Update _monitoring-your-cluster/pa/reference.md

Co-authored-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>
Signed-off-by: Heather Halter <HDHALTER@AMAZON.COM>

* Update reference.md

Fixed the intro statement

Signed-off-by: Heather Halter <HDHALTER@AMAZON.COM>

* Apply suggestions from code review

Editorial corrections.

Co-authored-by: Nathan Bower <nbower@amazon.com>
Signed-off-by: Heather Halter <HDHALTER@AMAZON.COM>

* Update reference.md

Added a description under the Dimensions: N/A section and a couple editorial nits.

Signed-off-by: Heather Halter <HDHALTER@AMAZON.COM>

* Update reference.md

Signed-off-by: Heather Halter <HDHALTER@AMAZON.COM>

* Update reference.md

Signed-off-by: Heather Halter <HDHALTER@AMAZON.COM>

* Update reference.md

Signed-off-by: Heather Halter <HDHALTER@AMAZON.COM>

* Update reference.md

Signed-off-by: Heather Halter <HDHALTER@AMAZON.COM>

* Update _monitoring-your-cluster/pa/reference.md

Co-authored-by: Nathan Bower <nbower@amazon.com>
Signed-off-by: Heather Halter <HDHALTER@AMAZON.COM>

* Update reference.md

Removed search backpressure info, as requested; removed info marked with TBD.

Signed-off-by: Heather Halter <HDHALTER@AMAZON.COM>

---------

Signed-off-by: Heather Halter <hdhalter@amazon.com>
Signed-off-by: Heather Halter <HDHALTER@AMAZON.COM>
Co-authored-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>
Co-authored-by: Nathan Bower <nbower@amazon.com>
@hdhalter hdhalter deleted the pa-metrics-211 branch March 28, 2024 21:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants