fix(docs): fix broken Summary API link and add kubelet metrics endpoints#56524
fix(docs): fix broken Summary API link and add kubelet metrics endpoints#56524prathamesh04 wants to merge 1 commit into
Conversation
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: The full list of commands accepted by this bot can be found here. DetailsNeeds approval from an approver in each of these files:Approvers can indicate their approval by writing |
- 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
✅ Pull request preview available for checkingBuilt without sensitive environment variables
To edit notification comments on pull requests, go to your Netlify project configuration. |
77556e8 to
6cf4f1c
Compare
lmktfy
left a comment
There was a problem hiding this comment.
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.
|
@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. |
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
/docs/reference/config-api/kubelet-stats.v1alpha1/(404) tohttps://pkg.go.dev/k8s.io/kubelet/pkg/apis/stats/v1alpha1node-metrics.mdandunderstand-psi-metrics.md2. Add kubelet metrics endpoints documentation
Added a new section documenting kubelet metrics endpoints:
/stats/summary/metrics/resource/metrics/cadvisor/metricsWhy 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 sectioncontent/en/docs/reference/instrumentation/understand-psi-metrics.md- Fixed broken linkVerification