Skip to content
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

docs: Add guide on how to debug CustomStateMetrics feature quickly #2299

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

docs: Add guide on how to debug CustomStateMetrics feature quickly #2299

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
0f6aa0a
Add guide on how to debug CustomStateMetrics feature quickly
CatherineF-dev Jan 11, 2024
9d9f872
Update README.md
CatherineF-dev Jan 11, 2024
0cb952a
Update README.md
CatherineF-dev Jan 11, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Copy link
Member

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.


```bash
minikube start
...
go run main.go --custom-resource-state-only --custom-resource-state-config-file ksm-2223/custom-resource-config-file.yaml --kubeconfig ~/.kube/config
```

See more details [here](https://github.com/kubernetes/kube-state-metrics/issues/2223#issuecomment-1792850276)

#### Developer Contributions

When developing, there are certain code patterns to follow to better your contributing experience and likelihood of e2e and other ci tests to pass. To learn more about them, see the documentation in [docs/developer/guide.md](./docs/developer/guide.md).