grafana-performance-overview-dashboard.md describes TiDB CPU / TiKV CPU/IO MBps panels that no longer exist
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 617
- Forks
- 724
- Avg merge
- 2d 10h
- Merged PRs (30d)
- 223
Description
Error Report
- What is the URL/path of the document related to this issue?
- https://docs.pingcap.com/tidb/dev/grafana-performance-overview-dashboard (
grafana-performance-overview-dashboard.md) - Also present identically on the
release-8.5branch.
- How would you like to improve it?
The "Performance Overview" section of this page has separate ### TiDB CPU and ### TiKV CPU/IO MBps panel descriptions. These panels no longer exist under these names in the actual Grafana dashboard.
Verified two ways:
- The real dashboard JSON (
performance_overview.jsoninpingcap/monitoring) only hasTiDB CPU/Memory,TiKV CPU/Memory, andPD CPU/Memorypanels — there is no standaloneTiDB CPUorTiKV CPU/IO MBpspanel. - Confirmed live by starting
tiup playground --monitorand opening the actual Grafana "Performance Overview" dashboard: it shows combinedTiDB CPU/Memory,TiKV CPU/Memory, andPD CPU/Memorypanels (CPU and Memory on one panel), not the separate CPU-only / CPU+IO panels the doc describes.
This dashboard is originally authored in pingcap/tidb at pkg/metrics/grafana/performance_overview.json, and the rename was made in pingcap/tidb#54978 ("metrics: add memory info and traffic flow into performance overview", merged 2024-07-30). That PR's diff shows:
- "title": "TiDB CPU",
+ "title": "TiDB CPU/Memory",
...
- "title": "TiKV CPU/IO MBps",
+ "title": "TiKV CPU/Memory",
...
+ "title": "PD CPU/Memory", (newly added panel)
So the doc has been describing panels that stopped existing under those names since this PR merged in mid-2024 (over a year ago).
Could someone update these two sections (and the corresponding PD CPU/Memory panel, which isn't documented as a separate section at all) to match the current panel structure? Happy to help verify the new panel's actual sub-metrics if useful.
(Found while reviewing the Japanese translation of this page.)
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
Update grafana-performance-overview-dashboard.md, focusing on the Performance Overview section. Compare its panel descriptions with performance_overview.json in pingcap/monitoring and, if needed, verify using tiup playground --monitor. Done means the documentation describes TiDB CPU/Memory, TiKV CPU/Memory, and the previously missing PD CPU/Memory panel.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- grafana
- Domain
- documentation, observability
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Active
- Clarity
- Clearly specified
- Newbie friendliness
- 88/100