Proposal: support prometheus metric export
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 734
- Forks
- 109
- Avg merge
- 2d 10h
- Merged PRs (30d)
- 6
Description
For now, in some circumstances, the cnpmcore has been one of the core dependencies in a company.
So it's too important to make this server more reliable. There would be great to export metrics to help the team to monitor the server status.
For now, Prometheus is the most popular monitoring platform in the world, and the node has supported the Prometheus SDK. FYI https://github.com/siimon/prom-client
So I think we can support the metric export in Prometheus and support some official grafana monitor dashboards.
This is just an idea, I will update more design detail when the maintainer think this idea is reasonable and workable.
Contributor guide
No contributing guide indexed for this repository
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 by reviewing the cnpmcore server architecture and the prom-client SDK referenced in the issue, then clarify which metrics and Grafana dashboards are required. Done should include an agreed design for Prometheus export and the official dashboards.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- prometheus, typescript
- Domain
- backend, observability
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 20/100