Error Report
Please answer the following questions before submitting your issue. Thanks!
- What is the URL/path of the document related to this issue?
- How would you like to improve it?
The Resolved-TS section uses row and panel names that do not match the current TiKV dashboard source. The name in the docs is on the left, and the dashboard title is on the right:
Resolved-TS → Resolved TS (row title)Resolved-TS worker CPU → Resolved TS Worker CPUAdvance-TS worker CPU → Advance ts Worker CPUScan lock worker CPU → Scan lock Worker CPUMax gap of safe-ts → Max gap of follower safe-tsMin Safe TS Region → Min Safe TS Follower RegionCheck Leader Duration → Check leader durationMax gap of resolved-ts in Region leaders → Max gap of resolved-ts in region leaders
Source: tikv_details.dashboard.py#L8999-L9255
All eight names should be updated. For six of them, only the label changes. The two safe-ts entries also need their descriptions updated because the underlying panels now measure follower-specific values:
Max gap of follower safe-ts queries tikv_resolved_ts_min_follower_safe_ts_gap_millis and is described in TiKV as the gap between the current time and the minimum non-zero safe-ts for followers. The docs currently describe the safe-ts of all active Regions.Min Safe TS Follower Region queries tikv_resolved_ts_min_follower_safe_ts_region and reports the follower Region with the minimum safe-ts. The docs currently describe the Region with the minimum safe-ts without the follower scope.
The remaining existing labels in this docs section already match the dashboard: Max gap of resolved-ts, Min Resolved TS Region, Min Leader Resolved TS Region, and Lock heap size.
Renaming the section heading from Resolved-TS to Resolved TS does not change the #resolved-ts anchor because both headings produce the same slug.
Related to #23818, which covers the same type of Grafana naming mismatch in other files. grafana-tikv-dashboard.md is not one of the files listed there.
Error Report
Please answer the following questions before submitting your issue. Thanks!
grafana-tikv-dashboard.md, theResolved-TSsectionThe
Resolved-TSsection uses row and panel names that do not match the current TiKV dashboard source. The name in the docs is on the left, and the dashboard title is on the right:Resolved-TS→Resolved TS(row title)Resolved-TS worker CPU→Resolved TS Worker CPUAdvance-TS worker CPU→Advance ts Worker CPUScan lock worker CPU→Scan lock Worker CPUMax gap of safe-ts→Max gap of follower safe-tsMin Safe TS Region→Min Safe TS Follower RegionCheck Leader Duration→Check leader durationMax gap of resolved-ts in Region leaders→Max gap of resolved-ts in region leadersSource: tikv_details.dashboard.py#L8999-L9255
All eight names should be updated. For six of them, only the label changes. The two safe-ts entries also need their descriptions updated because the underlying panels now measure follower-specific values:
Max gap of follower safe-tsqueriestikv_resolved_ts_min_follower_safe_ts_gap_millisand is described in TiKV as the gap between the current time and the minimum non-zero safe-ts for followers. The docs currently describe the safe-ts of all active Regions.Min Safe TS Follower Regionqueriestikv_resolved_ts_min_follower_safe_ts_regionand reports the follower Region with the minimum safe-ts. The docs currently describe the Region with the minimum safe-ts without the follower scope.The remaining existing labels in this docs section already match the dashboard:
Max gap of resolved-ts,Min Resolved TS Region,Min Leader Resolved TS Region, andLock heap size.Renaming the section heading from
Resolved-TStoResolved TSdoes not change the#resolved-tsanchor because both headings produce the same slug.Related to #23818, which covers the same type of Grafana naming mismatch in other files.
grafana-tikv-dashboard.mdis not one of the files listed there.