Skip to content

Doc: Kubelet PSI metrics feature graduates to GA#54328

Open
mariafromano-25 wants to merge 8 commits intokubernetes:dev-1.36from
mariafromano-25:dev-1.36
Open

Doc: Kubelet PSI metrics feature graduates to GA#54328
mariafromano-25 wants to merge 8 commits intokubernetes:dev-1.36from
mariafromano-25:dev-1.36

Conversation

@mariafromano-25
Copy link
Copy Markdown

Description

Update feature status and wording as the feature goes stable.

Issue

Ref: kubernetes/enhancements#4205

Closes: #

@k8s-ci-robot k8s-ci-robot added this to the 1.36 milestone Feb 7, 2026
@k8s-ci-robot k8s-ci-robot added do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. labels Feb 7, 2026
@k8s-ci-robot
Copy link
Copy Markdown
Contributor

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by:
Once this PR has been reviewed and has the lgtm label, please assign divya-mohan0209 for approval. For more information see the Code Review Process.

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

Details 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 added language/en Issues or PRs related to English language size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. labels Feb 7, 2026
@netlify
Copy link
Copy Markdown

netlify bot commented Feb 7, 2026

Pull request preview available for checking

Built without sensitive environment variables

Name Link
🔨 Latest commit b9366bc
🔍 Latest deploy log https://app.netlify.com/projects/kubernetes-io-main-staging/deploys/69cc272001c87e0008e36778
😎 Deploy Preview https://deploy-preview-54328--kubernetes-io-main-staging.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@lmktfy
Copy link
Copy Markdown
Member

lmktfy commented Feb 8, 2026

/sig node

@k8s-ci-robot k8s-ci-robot added the sig/node Categorizes an issue or PR as relevant to SIG Node. label Feb 8, 2026
Copy link
Copy Markdown
Member

@lmktfy lmktfy left a comment

Choose a reason for hiding this comment

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

I know this PR is draft, but even so I hope the advice helps.

### kubelet Pressure Stall Information (PSI) metrics

{{< feature-state for_k8s_version="v1.34" state="beta" >}}
{{< feature-state for_k8s_version="v1.36" state="stable" >}}
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Early feedback: try this

Suggested change
{{< feature-state for_k8s_version="v1.36" state="stable" >}}
{{< feature-state feature_gate_name="KubeletPSI" >}}

and then look for instances of KubeletPSI anywhere in the English docs that might need an update.

For other localizations, each localization team - usually 100% volunteers - picks its own way of working.

@lmktfy
Copy link
Copy Markdown
Member

lmktfy commented Feb 8, 2026

/sig instrumentation

@k8s-ci-robot k8s-ci-robot added the sig/instrumentation Categorizes an issue or PR as relevant to SIG Instrumentation. label Feb 8, 2026
@bart0sh bart0sh moved this from Triage to Work in progress in SIG Node: code and documentation PRs Feb 18, 2026
@k8s-ci-robot k8s-ci-robot added size/S Denotes a PR that changes 10-29 lines, ignoring generated files. and removed size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. labels Feb 21, 2026
@mariafromano-25
Copy link
Copy Markdown
Author

@mariafromano-25
Copy link
Copy Markdown
Author

cc @roycaihw @ndixita

@mariafromano-25 mariafromano-25 marked this pull request as ready for review March 27, 2026 22:27
@k8s-ci-robot k8s-ci-robot requested a review from salaxander March 27, 2026 22:27
@mariafromano-25 mariafromano-25 changed the title [WIP] Doc: Kubelet PSI metrics feature graduates to GA Doc: Kubelet PSI metrics feature graduates to GA Mar 27, 2026
@k8s-ci-robot k8s-ci-robot added size/M Denotes a PR that changes 30-99 lines, ignoring generated files. and removed do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. size/S Denotes a PR that changes 10-29 lines, ignoring generated files. labels Mar 27, 2026
container_pressure_io_waiting_seconds_total
```
*Summary API*: Exposed at the `/stats/summary` endpoint, providing both the cumulative `totals` and the moving averages (`avg10`, `avg60`, `avg300`). These averages represent the percentage of time that tasks were stalled on a resource over the respective 10-second, 60-second, and 5-minute intervals. This endpoint reports the metrics in the following format:
```
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

most markdown linters like the empty line before the ```


This feature is enabled by default, by setting the `KubeletPSI` [feature gate](/docs/reference/command-line-tools-reference/feature-gates/). The information is also exposed in the
This feature is enabled by default. Starting with Kubernetes v.1.36, the `KubeletPSI` [feature gate](/docs/reference/command-line-tools-reference/feature-gates/) is locked to true and cannot be disabled. The information is also exposed in the
[Summary API](/docs/reference/instrumentation/node-metrics#psi).
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

the paragraph above already said about summary API

```

This feature is enabled by default, by setting the `KubeletPSI` [feature gate](/docs/reference/command-line-tools-reference/feature-gates/). The information is also exposed in the
This feature is enabled by default. Starting with Kubernetes v.1.36, the `KubeletPSI` [feature gate](/docs/reference/command-line-tools-reference/feature-gates/) is locked to true and cannot be disabled. The information is also exposed in the
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

I do not know if we need to continue saying about these versions. We have the feature gate tag above already

container_pressure_io_stalled_seconds_total
container_pressure_io_waiting_seconds_total
```
*Summary API*: Exposed at the `/stats/summary` endpoint, providing both the cumulative `totals` and the moving averages (`avg10`, `avg60`, `avg300`). These averages represent the percentage of time that tasks were stalled on a resource over the respective 10-second, 60-second, and 5-minute intervals. This endpoint reports the metrics in the following format:
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

I like the explanation. My suggestion is maybe add an example (with non-zero PSI data) to further explain how to interpret the data. An example can be more comprehensive than the plain documentation.

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

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

I created an example below, let me know what you think!

[Pressure Stall Information](https://docs.kernel.org/accounting/psi.html)
(PSI) for CPU, memory, and I/O usage. The information is collected at node, pod and container level.
This feature is enabled by default by setting the `KubeletPSI` [feature gate](/docs/reference/command-line-tools-reference/feature-gates/).
Starting with Kubernetes v.1.36, the `KubeletPSI` [feature gate](/docs/reference/command-line-tools-reference/feature-gates/) is locked to true and cannot be disabled.
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Similar to my comment above. I think we can add an example with non-zero PSI data here to help users understand how to interpret the PSI data.

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

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

Should I reuse the same example as the system-metrics.md page or make a new one?

@mariafromano-25
Copy link
Copy Markdown
Author

Screenshot 2026-03-31 at 12 55 32 PM Updated view of the website when ran locally:

@AnshumanTripathi
Copy link
Copy Markdown
Contributor

Hello @mariafromano-25 👋!
I'm reaching out from the Docs team. Just checking in as we approach Docs Freeze on Wednesday 8th April 2026 (AoE) / Thursday 9th April 2026, 12:00 UTC.
This documentation appears to still be under review. To meet the Docs Freeze, this PR must have a technical review as well as lgtm and approve labels applied, without any unaddressed comments or concerns from SIG Docs.
Thank you!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. language/en Issues or PRs related to English language sig/instrumentation Categorizes an issue or PR as relevant to SIG Instrumentation. sig/node Categorizes an issue or PR as relevant to SIG Node. size/M Denotes a PR that changes 30-99 lines, ignoring generated files.

Projects

Development

Successfully merging this pull request may close these issues.

7 participants