troubleshoot-stale-read.md names a Grafana panel that doesn't exist ("Max Resolved TS gap")
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/troubleshoot-stale-read (
troubleshoot-stale-read.md)
- How would you like to improve it?
The document tells readers to check a panel called Max Resolved TS gap in the TiKV-Details > Resolved-TS Grafana dashboard:
You can first check the Max Resolved TS gap and Min Resolved TS Region metrics in the TiKV-Details > Resolved-TS dashboard:
However, checking the actual dashboard JSON (tikv_details.json in pingcap/monitoring), there is no panel titled "Max Resolved TS gap". The real panel title is "Max gap of resolved-ts" — which matches the name already used correctly elsewhere in the docs, e.g. grafana-tikv-dashboard.md's own panel list:
- Max gap of resolved-ts: The maximum time difference between the resolved-ts of all active Regions in this TiKV and the current time
Could someone confirm and fix the panel name in troubleshoot-stale-read.md (and the image alt text right below it) to say "Max gap of resolved-ts" instead of "Max Resolved TS gap"? A reader following the doc as written would not be able to find the panel by that name in Grafana.
(Found while reviewing the Japanese translation of this page — the JA translation has already been updated to say "Max gap of resolved-ts" to match the real panel, ahead of this EN fix.)
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
Open troubleshoot-stale-read.md and compare the referenced panel name with the Resolved-TS section in grafana-tikv-dashboard.md or the dashboard JSON mentioned in the issue. Update the panel name and the image alt text, then verify the rendered documentation uses “Max gap of resolved-ts” consistently.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- grafana
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Active
- Clarity
- Clearly specified
- Newbie friendliness
- 94/100
