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 cluster state stats documentation #5662

Merged
merged 8 commits into from
Feb 1, 2024

Conversation

amkhar
Copy link
Contributor

@amkhar amkhar commented Nov 27, 2023

Description

Cluster state stats were added as part of opensearch-project/OpenSearch#10670 , adding its documentation.

Issues Resolved

Fixes #5400

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: Aman Khare <[email protected]>
@@ -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.
Copy link
Member

Choose a reason for hiding this comment

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

can we just say -> Overall cluster state updates statistics

Copy link
Contributor Author

Choose a reason for hiding this comment

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

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.

_api-reference/nodes-apis/nodes-stats.md Outdated Show resolved Hide resolved
_api-reference/nodes-apis/nodes-stats.md Outdated Show resolved Hide resolved
_api-reference/nodes-apis/nodes-stats.md Outdated Show resolved Hide resolved
@Naarcha-AWS Naarcha-AWS self-assigned this Nov 28, 2023
@hdhalter
Copy link
Contributor

@Naarcha-AWS - what is the status of this?

@Naarcha-AWS Naarcha-AWS added this to the v2.12 milestone Dec 19, 2023
@Naarcha-AWS
Copy link
Collaborator

@hdhalter: I still need to look over this PR.

@hdhalter hdhalter added 4 - Doc review PR: Doc review in progress release-notes PR: Include this PR in the automated release notes labels Dec 20, 2023
Signed-off-by: Naarcha-AWS <[email protected]>
@Naarcha-AWS Naarcha-AWS added 5 - Editorial review PR: Editorial review in progress and removed 4 - Doc review PR: Doc review in progress labels Jan 12, 2024
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.

@Naarcha-AWS Just a few minor changes. Thanks!

_api-reference/nodes-apis/nodes-stats.md Outdated Show resolved Hide resolved
_api-reference/nodes-apis/nodes-stats.md Outdated Show resolved Hide resolved
_api-reference/nodes-apis/nodes-stats.md Outdated Show resolved Hide resolved
_api-reference/nodes-apis/nodes-stats.md Outdated Show resolved Hide resolved
_api-reference/nodes-apis/nodes-stats.md Outdated Show resolved Hide resolved
Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: Naarcha-AWS <[email protected]>
@Naarcha-AWS Naarcha-AWS added 6 - Done but waiting to merge PR: The work is done and ready to merge and removed 5 - Editorial review PR: Editorial review in progress labels Jan 18, 2024
@hdhalter hdhalter merged commit 34faa92 into opensearch-project:main Feb 1, 2024
4 checks passed
@hdhalter hdhalter added 3 - Done Issue is done/complete and removed 6 - Done but waiting to merge PR: The work is done and ready to merge labels Feb 1, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
3 - Done Issue is done/complete release-notes PR: Include this PR in the automated release notes v2.12.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[DOC] Create documentation corresponding to changes in _nodes/stats api in OpenSearch
6 participants