Skip to content

fix(docs): fix broken Summary API link and add kubelet metrics endpoints#56524

Open
prathamesh04 wants to merge 1 commit into
kubernetes:mainfrom
prathamesh04:fix/broken-link-kubelet-stats
Open

fix(docs): fix broken Summary API link and add kubelet metrics endpoints#56524
prathamesh04 wants to merge 1 commit into
kubernetes:mainfrom
prathamesh04:fix/broken-link-kubelet-stats

Conversation

@prathamesh04

Copy link
Copy Markdown

What this PR does

Fixes #56087 - Fixes broken Summary API link and adds kubelet metrics endpoints documentation.

Changes made

1. Fix broken Summary API link

  • Updated link from /docs/reference/config-api/kubelet-stats.v1alpha1/ (404) to https://pkg.go.dev/k8s.io/kubelet/pkg/apis/stats/v1alpha1
  • Fixed in both node-metrics.md and understand-psi-metrics.md

2. Add kubelet metrics endpoints documentation

Added a new section documenting kubelet metrics endpoints:

Endpoint Description Format
/stats/summary Summary API with node, pod, and container stats JSON
/metrics/resource Resource metrics (CPU, memory) for pods and containers Prometheus
/metrics/cadvisor Detailed container metrics from cAdvisor Prometheus
/metrics Kubelet's own operational metrics Prometheus

Why this change

The issue reported a broken link on the node-metrics page where the Summary API link returned a 404. Additionally, the page lacked clear documentation about available kubelet metrics endpoints, making it difficult for users to understand how to access node metrics.

Files changed

  • content/en/docs/reference/instrumentation/node-metrics.md - Fixed broken link, added metrics endpoints section
  • content/en/docs/reference/instrumentation/understand-psi-metrics.md - Fixed broken link

Verification

  • All Summary API links now point to valid Go package documentation
  • New metrics endpoints section follows Kubernetes documentation style guide
  • No remaining broken links to kubelet-stats.v1alpha1

@kubernetes-prow kubernetes-prow Bot added the do-not-merge/invalid-commit-message Indicates that a PR should not merge because it has an invalid commit message. label Jul 18, 2026
@kubernetes-prow

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 dipesh-rawat 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

@kubernetes-prow kubernetes-prow Bot added the language/en Issues or PRs related to English language label Jul 18, 2026
@kubernetes-prow kubernetes-prow Bot added cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. size/S Denotes a PR that changes 10-29 lines, ignoring generated files. labels Jul 18, 2026
- Fix broken Summary API link by updating to Go package documentation URL
- Add kubelet metrics endpoints table for better discoverability
- Update PSI metrics documentation with correct link

The Summary API link was pointing to a non-existent config-api page.
Updated to point to the official Go package documentation at
pkg.go.dev/k8s.io/kubelet/pkg/apis/stats/v1alpha1

Added a new section documenting kubelet metrics endpoints:
- /stats/summary for Summary API
- /metrics/resource for resource metrics
- /metrics/cadvisor for cAdvisor metrics
- /metrics for kubelet operational metrics
@netlify

netlify Bot commented Jul 18, 2026

Copy link
Copy Markdown

Pull request preview available for checking

Built without sensitive environment variables

Name Link
🔨 Latest commit 6cf4f1c
🔍 Latest deploy log https://app.netlify.com/projects/kubernetes-io-main-staging/deploys/6a5b2d6b19a31600080f7bae
😎 Deploy Preview https://deploy-preview-56524--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.

@prathamesh04
prathamesh04 force-pushed the fix/broken-link-kubelet-stats branch from 77556e8 to 6cf4f1c Compare July 18, 2026 07:38
@kubernetes-prow kubernetes-prow Bot removed the do-not-merge/invalid-commit-message Indicates that a PR should not merge because it has an invalid commit message. label Jul 18, 2026

@lmktfy lmktfy left a comment

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 am not sure we should link to the Go API reference.

Maybe there's no better option but (I believe that) actually the wire format is what we expect for conformance etc, not the Golang API.

@lmktfy

lmktfy commented Jul 20, 2026

Copy link
Copy Markdown
Member

@prathamesh04 did you generate this PR using AI?

If you did, we (Kubernetes project) ask and expect you to disclose this in the PR description.

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 size/S Denotes a PR that changes 10-29 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Kubelet metrics definitions?

2 participants