-
Notifications
You must be signed in to change notification settings - Fork 2k
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
docs: Add guide on how to debug CustomStateMetrics feature quickly #2299
Conversation
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: CatherineF-dev The full list of commands accepted by this bot can be found here.
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
/assign @rexagod |
The change seems fairly straight-forward. I'd suggest adding a section demonstrating the usage of https://github.com/go-delve/delve to catch contexts at breakpoints set by the user. |
Could you add how to use some debugging tools in another PR? I don't use delve recently Not everyone knows minikube. Could we merge this? |
@@ -406,6 +406,16 @@ Then curl the metrics endpoint | |||
|
|||
To run the e2e tests locally see the documentation in [tests/README.md](./tests/README.md). | |||
|
|||
##### Debug CustomStateMetrics feature |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Instead of adding it to the README, I think it would be better to put it in its own doc under https://github.com/kubernetes/kube-state-metrics/tree/main/docs, or maybe in a new directory there.
I suggested reworking the structure of our doc directory in the past, we might want to revive that effort.
The Kubernetes project currently lacks enough contributors to adequately respond to all PRs. This bot triages PRs according to the following rules:
You can:
Please send feedback to sig-contributor-experience at kubernetes/community. /lifecycle stale |
/remove-lifecycle stale |
The Kubernetes project currently lacks enough contributors to adequately respond to all PRs. This bot triages PRs according to the following rules:
You can:
Please send feedback to sig-contributor-experience at kubernetes/community. /lifecycle stale |
The Kubernetes project currently lacks enough active contributors to adequately respond to all PRs. This bot triages PRs according to the following rules:
You can:
Please send feedback to sig-contributor-experience at kubernetes/community. /lifecycle rotten |
The Kubernetes project currently lacks enough active contributors to adequately respond to all issues and PRs. This bot triages PRs according to the following rules:
You can:
Please send feedback to sig-contributor-experience at kubernetes/community. /close |
@k8s-triage-robot: Closed this PR. In response to this:
Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository. |
What this PR does / why we need it:
More and more bugs are opened for CustomStateMetrics feature. This will help users to debug CustomStateMetrics by themselves quicker.
How does this change affect the cardinality of KSM: (increases, decreases or does not change cardinality)
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 #