Observability updates
Open
Nobody has claimed this yet.
area/tutorial
docs
priority/P1
- Dominant language
- JavaScript
- Stars
- 60
- Forks
- 221
- Avg merge
- 4h 32m
- Merged PRs (30d)
- 1
Description
- High level description of components.
- Discuss the queries that stat and grafana make to prometheus (see https://github.com/linkerd/linkerd2/issues/1453#issuecomment-443041625).
- Explain why you want to keep LD2 Prometheus and how to integrate into larger/existing systems. Include resource usage stats.
- Document the implications of getting rid of Grafana.
- Document how to use LD2 dashboards on another Grafana instance.
- Prometheus scrape configuration.
- How to configure prometheus (alert manager).
- Update proxy metrics to current state.
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 with the unchecked checklist items and the linked Linkerd issue comment, then review the existing Prometheus scrape configuration and high-level component description. Document the Prometheus queries, resource usage, Alertmanager configuration, Grafana migration and dashboard use, and update proxy metrics; done means each remaining checklist item is addressed.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- grafana, javascript, prometheus
- Domain
- documentation, observability
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100