kubernetes-sigs / kubernetes-sigs/controller-runtime
Add a new metrics to expose local cached items size
Nobody has claimed this yet.
- Dominant language
- Go
- Stars
- 3k
- Forks
- 1.3k
- Avg merge
- 2d 5h
- Merged PRs (30d)
- 14
Description
Backgroud
In controller-runtime, the default behaviour is to cache all data using client.Get unless using a read-only client or custom cache policies, e.g., ClientDisableCacheFor, NewCache. Therefore, using client.Get on a specific pod in a large cluster with many pods may lead to high memory usage.
Proposal
Add a new metric to expose the local cached items' size. Then we can analyze the high memory usage caused by the misuse cache policy.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by locating controller-runtime's cache implementation and existing metrics, then trace how client.Get uses the local cache. Define the metric's scope and labels from the issue's cached-items-size requirement, and add tests showing that the reported size reflects cached items and helps identify excessive cache usage.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- go
- Domain
- backend, observability
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Quiet
- Clarity
- Needs clarification
- Newbie friendliness
- 45/100