stackabletech / stackabletech/documentation
Product monitoring: Create concepts page
Nobody has claimed this yet.
- Dominant language
- CSS
- Stars
- 13
- Forks
- 14
- Avg merge
- 4d 8h
- Merged PRs (30d)
- 10
Description
We should document that we recommend a Prometheus Servicemonitor and point to the monitoring stack.
Mention that we label all Services accordingly, so users only need to deploy a Servicemonitor and get all metrics instantly.
Provide some nice screenshots from Prometheus
This is mostly done on https://docs.stackable.tech/home/stable/operators/monitoring/
Expand it with
- some screenshots from Prometheus
- link to the
monitoringstack to showcase the setup
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
Start with the existing monitoring page at docs.stackable.tech/home/stable/operators/monitoring/ and review its current guidance. Expand it with Prometheus screenshots, a link to the monitoring stack, and the recommendation to deploy a Prometheus ServiceMonitor; done means the setup and automatic metrics collection are clearly explained.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- prometheus
- Domain
- documentation, observability
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 58/100