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.

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

perf: Add automatic detection of memory limits #2447

Merged
merged 1 commit into from
Jul 16, 2024

Conversation

SuperQ
Copy link
Contributor

@SuperQ SuperQ commented Jul 12, 2024

What this PR does / why we need it:
Add automatic detection of container and system memory limits to control the Go GOMEMLIMIT garbage collector feature. This helps reduced OOMs by triggering GC when the process approaches system limits.

How does this change affect the cardinality of KSM: (increases, decreases or does not change cardinality)
N/A

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 #

@k8s-ci-robot k8s-ci-robot added the cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. label Jul 12, 2024
@k8s-ci-robot
Copy link
Contributor

This issue is currently awaiting triage.

If kube-state-metrics contributors determine this is a relevant issue, they will accept it by applying the triage/accepted label and provide further guidance.

The triage/accepted label can be added by org members by writing /triage accepted in a comment.

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.

@k8s-ci-robot k8s-ci-robot added the needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one. label Jul 12, 2024
@k8s-ci-robot
Copy link
Contributor

Welcome @SuperQ!

It looks like this is your first PR to kubernetes/kube-state-metrics 🎉. Please refer to our pull request process documentation to help your PR have a smooth ride to approval.

You will be prompted by a bot to use commands during the review process. Do not be afraid to follow the prompts! It is okay to experiment. Here is the bot commands documentation.

You can also check if kubernetes/kube-state-metrics has its own contribution guidelines.

You may want to refer to our testing guide if you run into trouble with your tests not passing.

If you are having difficulty getting your pull request seen, please follow the recommended escalation practices. Also, for tips and tricks in the contribution process you may want to read the Kubernetes contributor cheat sheet. We want to make sure your contribution gets all the attention it needs!

Thank you, and welcome to Kubernetes. 😃

@k8s-ci-robot k8s-ci-robot requested review from dgrisonnet and mrueg July 12, 2024 14:26
@k8s-ci-robot k8s-ci-robot added the size/M Denotes a PR that changes 30-99 lines, ignoring generated files. label Jul 12, 2024
@SuperQ SuperQ changed the title Add automatic detection of memory limits perf: Add automatic detection of memory limits Jul 12, 2024
@SuperQ
Copy link
Contributor Author

SuperQ commented Jul 12, 2024

We added this to Prometheus (prometheus/prometheus#13395) and it helps a lot in our production environment.

pkg/options/options.go Outdated Show resolved Hide resolved
pkg/options/options.go Outdated Show resolved Hide resolved
pkg/options/options.go Outdated Show resolved Hide resolved
@mrueg
Copy link
Member

mrueg commented Jul 15, 2024

Thanks, looks interesting!
I would suggest to introduce it as an experimental feature.

@SuperQ SuperQ requested a review from mrueg July 15, 2024 14:27
pkg/options/options.go Outdated Show resolved Hide resolved
@SuperQ SuperQ requested a review from mrueg July 15, 2024 14:42
@mrueg
Copy link
Member

mrueg commented Jul 15, 2024

Ah can you run make generate to fix the docs? Thanks!

@SuperQ
Copy link
Contributor Author

SuperQ commented Jul 15, 2024

Updated docs.

@mrueg
Copy link
Member

mrueg commented Jul 15, 2024

Looks like the lint is still complaining about a the wrong format for the auto gomemlimit ratio

Add automatic detection of container and system memory limits to control
the Go `GOMEMLIMIT` garbage collector feature. This helps reduced OOMs
by triggering GC when the process approaches system limits.

Signed-off-by: SuperQ <[email protected]>
@mrueg
Copy link
Member

mrueg commented Jul 16, 2024

/lgtm

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Jul 16, 2024
@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: mrueg, SuperQ

The full list of commands accepted by this bot can be found here.

The pull request process is described here

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

@k8s-ci-robot k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Jul 16, 2024
@k8s-ci-robot k8s-ci-robot merged commit 5972617 into kubernetes:main Jul 16, 2024
12 checks passed
@SuperQ SuperQ deleted the auto_memlimit branch July 22, 2024 09:41
@CatherineF-dev
Copy link
Contributor

qq: Will cpu increase a lot if GC is triggered frequently?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. lgtm "Looks good to me", indicates that a PR is ready to be merged. needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one. size/M Denotes a PR that changes 30-99 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants