Skip to content

✨ Enable pprof to allow memory profiling #1855

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

Closed
wants to merge 1 commit into from
Closed

✨ Enable pprof to allow memory profiling #1855

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
1 change: 1 addition & 0 deletions config/base/catalogd/manager/manager.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,7 @@ spec:
args:
- --leader-elect
- --metrics-bind-address=:7443
- --pprof-bind-address=:6060
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This feature is handy for testing and debugging, but I’m wondering if it should be enabled by default. I have concerns about performance impact and security risks. That’s why we added a warning in Kubebuilder’s docs.

I think it's fine to enable pprof in production when needed, do the profiling, and then disable it. My concern is leaving it enabled indefinitely. That seems to be the general approach others take as well (enable/disable), see: Google Groups discussion.

⚠️ Some references highlight security risks:

Also, I found this issue: golang/go#65208

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

But let's also see what the other thinks @tmshort @joelanford, what are your thoughts?
Are you OK with?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That's super helpful information @camilamacedo86. We'd already discussed this on slack and I decided to close the PR, but this detailed information is really helpful, so thank you!

- --external-address=catalogd-service.olmv1-system.svc
image: controller:latest
name: manager
Expand Down
1 change: 1 addition & 0 deletions config/base/operator-controller/manager/manager.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,7 @@ spec:
args:
- "--health-probe-bind-address=:8081"
- "--metrics-bind-address=:8443"
- --pprof-bind-address=:6060
- "--leader-elect"
image: controller:latest
imagePullPolicy: IfNotPresent
Expand Down
Loading