Skip to content

troubleshoot-stale-read.md names a Grafana panel that doesn't exist ("Max Resolved TS gap") #23817

Description

@yahonda

Error Report

  1. What is the URL/path of the document related to this issue?
  1. 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:

Example: Max Resolved TS gap

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.)

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions