Skip to content

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

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?

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

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