prometheus / prometheus/exporter-toolkit
Make routes for different endpoints configurable (including switching them off)
Nobody has claimed this yet.
- Dominant language
- Go
- Stars
- 311
- Forks
- 109
- Avg merge
- 3d 59m
- Merged PRs (30d)
- 6
Description
The dev-summit decided (almost a year ago, on 2023-11-30) that we want this.
There was some discussion if this should be only about switching on and off certain endpoints (e.g. /pprof) or do more stuff like binding different endpoints to different ports or interfaces.
/cc @SuperQ @bwplotka
One trigger was https://github.com/prometheus/pushgateway/discussions/520 , which has some relevant discussion. But there are regular concerns reported about certain endpoints exposed to the public internet (in particular /pprof and /metrics, but also certain APIs depending on the binary in question). While we do not plan to lockdown binaries by default (cf. dev-summit on 2024-10-24), it would be good to give users an easy way to configure what to expose where.
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
No files, tests, or entry points are named. Start with the issue discussion and the referenced Pushgateway discussion, then clarify whether the work covers enabling or disabling endpoints only or also binding them to different ports or interfaces; done means users can configure which endpoints are exposed and where.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- go
- Domain
- api, backend, security
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100