Skip to content

feat: promote StatefulSet metrics to STABLE and enhance docs #2783

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.

Sign up for GitHub

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

Jump to bottom
Merged
k8s-ci-robot merged 14 commits into from
Dec 2, 2025
Merged

feat: promote StatefulSet metrics to STABLE and enhance docs #2783

k8s-ci-robot merged 14 commits into from
Dec 2, 2025
+19 −19

Conversation

@yasicar
Copy link
Contributor

@yasicar yasicar commented Sep 28, 2025 •
edited
Loading

What this PR does / why we need it:

This PR promotes four StatefulSet metrics from EXPERIMENTAL to STABLE status and enhances StatefulSet monitoring documentation with practical examples.
Metrics Promoted to STABLE:
kube_statefulset_status_replicas_available
kube_statefulset_annotations
kube_statefulset_persistentvolumeclaim_retention_policy
kube_statefulset_deletion_timestamp

Why we need it:

  1. Consistency with Kubernetes API Stability: All promoted metrics are based on stable Kubernetes v1 APIs:

Metrics Promoted to STABLE:

  1. kube_statefulset_status_replicas_available

  2. kube_statefulset_annotations

  3. kube_statefulset_persistentvolumeclaim_retention_policy

  4. kube_statefulset_deletion_timestamp

, but the kube-state-metrics metric remained EXPERIMENTAL, This creates inconsistency where identical stable Kubernetes API fields have different stability levels across workload resources in kube-state-metrics.

  1. Better monitoring: The documentation enhancements provide practical PromQL queries and alerting rules that address real-world StatefulSet monitoring needs, including detection of complete outages, rollout issues, and availability problems.

  2. User experience: Removes confusion around metric stability and provides actionable examples for StatefulSet observability.

The promotion is justified because:

  • Same API field as STABLE metrics in Deployments (kube_deployment_status_replicas_available)
  • No changes to the metric since introduction in July 2021
  • Addresses actual monitoring gaps with practical alerting rules

How does this change affect the cardinality of KSM: (increases, decreases or does not change cardinality)

Which issue(s) this PR fixes:
Fixes #2794

@yasicar
promote-statefulset-available-replicas-and-docs
deb8273 
 - Updating kube_statefulset_status_replicas_available from ALPHA to STABLE
- Add comprehensive PromQL examples and troubleshooting queries
- Add major alerting rules for StatefulSet monitoring
- Update tests to reflect STABLE status
@yasicar
Update statefulset-metrics.md
fd61b08
@linux-foundation-easycla
Copy link

linux-foundation-easycla bot commented Sep 28, 2025 •
edited
Loading

CLA Signed

The committers listed above are authorized under a signed CLA.

@k8s-ci-robot k8s-ci-robot added needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one. cncf-cla: no Indicates the PR's author has not signed the CNCF CLA. labels Sep 28, 2025
@k8s-ci-robot
Copy link
Contributor

k8s-ci-robot commented Sep 28, 2025

Welcome @yasicar!

It looks like this is your first PR to kubernetes/kube-state-metrics 🎉. Please refer to our pull request process documentation to help your PR have a smooth ride to approval.

You will be prompted by a bot to use commands during the review process. Do not be afraid to follow the prompts! It is okay to experiment. Here is the bot commands documentation.

You can also check if kubernetes/kube-state-metrics has its own contribution guidelines.

You may want to refer to our testing guide if you run into trouble with your tests not passing.

If you are having difficulty getting your pull request seen, please follow the recommended escalation practices. Also, for tips and tricks in the contribution process you may want to read the Kubernetes contributor cheat sheet. We want to make sure your contribution gets all the attention it needs!

Thank you, and welcome to Kubernetes. 😃

@github-project-automation github-project-automation bot moved this to Needs Triage in SIG Instrumentation Sep 28, 2025
@k8s-ci-robot k8s-ci-robot added size/L Denotes a PR that changes 100-499 lines, ignoring generated files. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. and removed cncf-cla: no Indicates the PR's author has not signed the CNCF CLA. labels Sep 28, 2025
@yasicar yasicar changed the title Promote statefulset available replicas and docs feat: promote StatefulSet availableReplicas to STABLE and enhance docs Sep 28, 2025
@yasicar
fix: correct markdown table formatting in statefulset metrics
2b0139d 
- Fix malformed description column spacing in availableReplicas row
- Align with consistent table formatting used by other metrics
- Resolves markdownlint CI failure

Signed-off-by: yasicar <yasica.rajesh@freshworks.com>
@yasicar
Update statefulset-metrics.md
bf43a47
@yasicar
Copy link
Contributor Author

yasicar commented Sep 30, 2025

@CatherineF-dev @mrueg Can you please help me with the review

nmn3m
nmn3m reviewed Oct 3, 2025
View reviewed changes
@yasicar
feat: promote StatefulSet experimental metrics to STABLE
6e306c4 
- Promote kube_statefulset_annotations to STABLE
- Promote kube_statefulset_persistentvolumeclaim_retention_policy to STABLE
- Promote kube_statefulset_deletion_timestamp to STABLE

All metrics are based on stable Kubernetes v1 APIs:
- metadata.annotations (v1 stable)
- spec.persistentVolumeClaimRetentionPolicy (v1 stable)
- metadata.deletionTimestamp (v1 stable)

Addresses consistency gap between kube-state-metrics stability
labels and underlying Kubernetes API stability."
@yasicar yasicar changed the title feat: promote StatefulSet availableReplicas to STABLE and enhance docs feat: promote StatefulSet metrics to STABLE and enhance docs Oct 4, 2025
nmn3m
nmn3m reviewed Oct 5, 2025
View reviewed changes
CatherineF-dev
CatherineF-dev reviewed Oct 8, 2025
View reviewed changes
@yasicar yasicar requested a review from nmn3m October 10, 2025 14:03
@nmn3m
Copy link
Member

nmn3m commented Oct 10, 2025

/ok-to-test

@k8s-ci-robot k8s-ci-robot added the ok-to-test Indicates a non-member PR verified by an org member that is safe to test. label Oct 10, 2025
@nmn3m
Copy link
Member

nmn3m commented Oct 10, 2025

@yasicar, can you modify this part in PR body?, mention the issue that you are fixing,

Which issue(s) this PR fixes: (optional, in fixes #<issue number>(, fixes #<issue_number>, ...) format, will close the issue(s) when PR gets merged)
Fixes #

@yasicar
Copy link
Contributor Author

yasicar commented Oct 10, 2025

@nmn3m There isn’t a tracked issue—this was self-identified—so I updated the PR body to note Fixes N/A (self-identified issue)

@nmn3m
Copy link
Member

nmn3m commented Oct 10, 2025

@yasicar, can you please create an issue?, describe what you are trying to do in that PR and attach that PR to it.

@yasicar
Copy link
Contributor Author

yasicar commented Oct 10, 2025 •
edited
Loading

@nmn3m Addressed your comments and created the issue

@nmn3m
Copy link
Member

nmn3m commented Oct 10, 2025

/triage accepted

@k8s-ci-robot k8s-ci-robot added triage/accepted Indicates an issue or PR is ready to be actively worked on. and removed needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one. labels Oct 10, 2025
@CatherineF-dev
Copy link
Contributor

CatherineF-dev commented Nov 27, 2025

Could you split queries and non-queries into two pull requests?

I can approve the non-queries one. I need to discuss with other maintainers around the one containing queries.

@k8s-ci-robot k8s-ci-robot added size/M Denotes a PR that changes 30-99 lines, ignoring generated files. and removed size/L Denotes a PR that changes 100-499 lines, ignoring generated files. labels Nov 30, 2025
@yasicar
Copy link
Contributor Author

yasicar commented Nov 30, 2025 •
edited
Loading

Hi @CatherineF-dev addressed your comments
#2783

PR for queries changes : #2821

@CatherineF-dev
Copy link
Contributor

CatherineF-dev commented Nov 30, 2025

/lgtm

@k8s-ci-robot k8s-ci-robot added lgtm "Looks good to me", indicates that a PR is ready to be merged. approved Indicates a PR has been approved by an approver from all required OWNERS files. labels Nov 30, 2025
@k8s-ci-robot k8s-ci-robot removed the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Nov 30, 2025
@CatherineF-dev
Copy link
Contributor

CatherineF-dev commented Dec 2, 2025

/lgtm

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Dec 2, 2025
@k8s-ci-robot
Copy link
Contributor

k8s-ci-robot commented Dec 2, 2025

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: CatherineF-dev, nmn3m, yasicar

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@k8s-ci-robot k8s-ci-robot merged commit 3c25265 into kubernetes:main Dec 2, 2025
13 checks passed
@github-project-automation github-project-automation bot moved this from Needs Triage to Done in SIG Instrumentation Dec 2, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@mrueg mrueg Awaiting requested review from mrueg

@dgrisonnet dgrisonnet Awaiting requested review from dgrisonnet

@CatherineF-dev CatherineF-dev Awaiting requested review from CatherineF-dev

1 more reviewer

@nmn3m nmn3m nmn3m approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

@CatherineF-dev CatherineF-dev

Labels

approved Indicates a PR has been approved by an approver from all required OWNERS files. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. lgtm "Looks good to me", indicates that a PR is ready to be merged. ok-to-test Indicates a non-member PR verified by an org member that is safe to test. size/M Denotes a PR that changes 30-99 lines, ignoring generated files. triage/accepted Indicates an issue or PR is ready to be actively worked on.

Projects

SIG Instrumentation
Status: Done

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Document and promote missing StatefulSet metrics to STABLE

4 participants

@yasicar @k8s-ci-robot @nmn3m @CatherineF-dev