Altinity / Altinity/clickhouse-operator
Feature request: register pprof endpoint for profiling usage
Nobody has claimed this yet.
- Dominant language
- Go
- Stars
- 2.6k
- Forks
- 574
- Avg merge
- 8d 6h
- Merged PRs (30d)
- 6
Description
Hi team, we've deployed clickhouse with this clickhouse operator in production.
Sometime we suffered OOM for CH metrics collector sidecar container, so I'm wondering if we could register pprof HTTP endpoint, so we could easily profile the process when needed?
pprofis the standard package golang provides: https://pkg.go.dev/net/http/pprof- There's no runtime performance or resource impact when no profiling request, in other words, it's request-based
- It provides a few useful information to inspect the process, including but not confined to memory, CPU, mutex, etc
I found others also met OOM issue in the past, which I believe also benefits from pprof endpoint: https://github.com/Altinity/clickhouse-operator/issues/176
Thank you!
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 the Go HTTP server or metrics endpoint used by the operator and its ClickHouse metrics collector sidecar. Read the net/http/pprof documentation and inspect existing endpoint exposure and access controls; done means a pprof endpoint is available for profiling without affecting normal operation when unused.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- go, kubernetes
- Domain
- devops, observability
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 48/100