pingcap / pingcap/docs

Self-contradictory TiDB Cloud Grafana note in tidb-resource-control-ru-groups.md

Open Beginner friendly
#23,826 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
617
Forks
724
Avg merge
2d 10h
Merged PRs (30d)
223

Description

Error Report

  1. What is the URL/path of the document related to this issue?
  1. How would you like to improve it?

In the "Monitoring metrics and charts" section, the platform="tidb-cloud" <CustomContent> block contains a self-contradictory note:

<CustomContent platform="tidb-cloud">

> **Note:**
>
> This section describes the Grafana dashboards that are available only for TiDB Self-Managed. For TiDB Cloud Dedicated, you can view the resource control metrics, including **Total RU Consumed** and **RU Consumed by Resource Groups**, in the [Calibrate Resource](/tidb-cloud/calibrate-resource.md) page of the TiDB Cloud console.

TiDB regularly collects runtime information about resource control and provides visual charts of the metrics in Grafana's **TiDB** > **Resource Control** dashboard.

TiKV also records the request QPS from different resource groups in Grafana's **TiKV** dashboard.

</CustomContent>

The note explicitly states that these Grafana dashboards are available only for TiDB Self-Managed and directs TiDB Cloud Dedicated users to the Calibrate Resource page instead. However, the very next two paragraphs — still inside the same platform="tidb-cloud" block — go on to tell the reader to check the same Grafana TiDB > Resource Control and TiKV dashboards, which the note just said TiDB Cloud users don't have access to.

These two paragraphs appear to be an unintended duplicate of the corresponding platform="tidb" block just above it (which legitimately describes the Self-Managed Grafana dashboards), copy-pasted into the tidb-cloud block without removing the Grafana-specific content. Consider removing (or otherwise reconciling) the two Grafana-dashboard paragraphs from the tidb-cloud block so it doesn't contradict its own note.

(Found while reviewing the Japanese translation of this file for i18n-ja-release-8.5; the JA translation faithfully mirrors this same inconsistency from the English source, so this is an English-source content issue, not a translation defect.)

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Open tidb-resource-control-ru-groups.md on the release-8.5 branch and read the “Monitoring metrics and charts” section, comparing the tidb-cloud block with the tidb block above it. Remove or reconcile the contradictory Grafana-dashboard paragraphs in the tidb-cloud block so its content agrees with the note and Calibrate Resource guidance.

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
90/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.