Add cluster state stats documentation #5662
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: Aman Khare <amkhar@amazon.com>
amkhar
requested review from
hdhalter,
kolchfa-aws,
Naarcha-AWS,
vagimeli,
ananzh,
AMoo-Miki and
natebower
as code owners
Signed-off-by: Aman Khare <amkhar@amazon.com>
linuxpi
approved these changes
Nov 27, 2023
| @@ -1057,6 +1070,16 @@ published_cluster_states | Object | Statistics for the published cluster states | |||
| published_cluster_states.full_states | Integer | The number of published cluster states. | |||
| published_cluster_states.incompatible_diffs | Integer | The number of incompatible differences between published cluster states. | |||
| published_cluster_states.compatible_diffs | Integer | The number of compatible differences between published cluster states. | |||
| cluster_state_stats | Object | Cluster state updates statistics published by active leader. | |||
| cluster_state_stats.overall | Object | Cluster state update statistics including local and all remote state uploads done by the node. | |||
There was a problem hiding this comment.
can we just say -> Overall cluster state updates statistics
There was a problem hiding this comment.
As long as it's easy to understand that overall time includes both local state update as well as remote upload. Because currently cluster_state_stats.overall.total_time_in_millis doesn't signify anything specifically. Is it okay ?
cluster_state_stats.overall.total_time_in_millis | Integer | The total amount of time for all cluster state updates, in milliseconds.
added 3 commits
November 28, 2023 23:31
Signed-off-by: Aman Khare <amkhar@amazon.com>
4 tasks
|
@Naarcha-AWS - what is the status of this? |
|
@hdhalter: I still need to look over this PR. |
hdhalter
added
4 - Doc review
Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>
Naarcha-AWS
approved these changes
Jan 12, 2024
Naarcha-AWS
added
5 - Editorial review
natebower
reviewed
Jan 12, 2024
Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>
Naarcha-AWS
added
6 - Done but waiting to merge
hdhalter
added
3 - Done
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
Cluster state stats were added as part of opensearch-project/OpenSearch#10670 , adding its documentation.
Issues Resolved
Fixes #5400
Checklist
For more information on following Developer Certificate of Origin and signing off your commits, please check here.