Optimize docs for monitoring metrics
Open
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 1.8k
- Forks
- 1.2k
- Avg merge
- 1d 16h
- Merged PRs (30d)
- 31
Description
Change Request
- Describe what you find is inappropriate or missing in the existing docs.
Monitoring docs are incomplete and lack key information.
- Describe your suggestion or addition.
- 监控面板使用的最佳实践
- 涉及的各模块的监控指标详细解释说明（包括正常区间）
- Overview 面板监控指标详细解释说明
- Performance Overview 面板监控指标详细解释说明
- TiDB 监控指标详细解释说明
- TiKV 监控指标详细解释说明
- PD 监控指标详细解释说明
- TiFlash 监控指标详细解释说明
- TiCDC 监控指标详细解释说明
- Resource Control 监控指标详细解释说明
- Provide some reference materials (documents, websites, etc) if you could.
requested by user: https://asktug.com/t/topic/1016357/45
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 reviewing the existing monitoring documentation and the referenced AskTUG discussion. Define the scope for dashboard best practices and metric explanations across Overview, Performance Overview, TiDB, TiKV, PD, TiFlash, TiCDC, and Resource Control. Done means each listed area documents its metrics and normal ranges.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation, observability-sre
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 20/100