tidb-cloud: Top RU user guide needs rewrite — wrong product surface, missing Essential tier, non-user-facing content

オープン

#22,988 2026年6月1日に作成コメント 0 件リアクション 0 件担当者 0 名 GitHub で見る

メンテナーはふだん 1 日以内に返信

まだ誰も着手していません。

評価

難易度: 4/5
見積もり時間: 3〜5日
初心者へのやさしさ: 48/100

issue の種類: ドキュメント
明瞭さ: 明確に書かれている
活発さ: 静か
領域: cloud, documentation

調査の方向性

tidb-cloud/premium/top-ru-in-clinic-premium.md にある既存の PR #22760 の内容、提案されている移行先 tidb-cloud/top-ru.md、および TOC-tidb-cloud.md を確認してください。リンク先の製品仕様を使用して Premium と Essential の機能を検証し、新しいページがユーザー向けであり、記載されている機能と制限を網羅し、Monitor and Alert の下にリンクされていることを確認してください。

索引モデルが issue の本文から書いたものです。

説明

Problem

PR #22760 attempted to add Top RU documentation but has several critical issues that make it unsuitable for merge:

1. Wrong product surface

Top RU is a feature in the TiDB Cloud web console, not in TiDB Cloud Clinic. The PR places the doc under tidb-cloud/premium/top-ru-in-clinic-premium.md (a Clinic-specific directory) and titles it "TopRU views in Top SQL in TiDB Cloud Clinic". The entire doc should be a standalone page in the main TiDB Cloud web console docs.

2. Essential tier completely missing

The product spec explicitly supports both Premium and Essential clusters with different capabilities. The PR doc only covers Dedicated/Premium and notes it is "only available for TiDB Cloud Dedicated clusters".

Capability differences per tier:

Feature	Premium	Essential
Overview tab	✓	✓
Sliced by Users tab	✓	✗
Rank by Users panel	✓	✗
Top N default	10	5
Top N options	20/50/100	10/20
Data retention	30 days	7 days

3. Internal engineering perspective, not user-facing

The doc describes internal implementation details (aggregation keys (user, sql_digest, plan_digest), pipeline reuse, TopN compression mechanics) that belong in internal design docs. User documentation should describe what users can see and do, not how the feature works internally.

4. Key features from spec are missing

Rank by Users panel (added in V1.4, Jan 7 2026) — not documented at all
Top N configuration per tier with specific values
Data retention per tier (Premium 30d / Essential 7d)
Time range presets and custom range with 24-hour max window constraint
Drill-down plan scenarios (4 scenarios based on plan availability)
Quick link from Query Template ID to Slow Query logs

5. Incorrect prerequisite

The doc lists "Resource Control enabled" as a prerequisite. This appears to be an internal implementation detail, not a user-facing requirement for a product-level monitoring feature.

Proposed fix

Create a new doc at tidb-cloud/top-ru.md with:

Correct product surface (web console, not Clinic)
Coverage of both Premium and Essential tiers with a comparison table
User-focused content (what users see and can do)
All key features from the spec documented
TOC entry added to TOC-tidb-cloud.md under "Monitor and Alert"

Spec reference: https://pingcap.feishu.cn/wiki/AQUdwgOFyiIELCkzGj7c0tyonLh

主要言語: Python
スター: 615
フォーク: 724
平均マージ: 1日 4時間
マージ済み PR（30日）: 522

環境構築

Dockerfile・Docker Compose ファイルなし
プルリクエストのテンプレートあり
コントリビューションガイドを読む

はじめの一歩

issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
リポジトリをフォークし、ブランチを切って変更します。
issue 番号を参照したプルリクエストを送ります。

pingcap/docs のほかの issue

Weekly keywords check: mismatches found
オープン
- 何か問題がありますか？
難易度 1/5 1〜3時間初心者へのやさしさ 78/100

pingcap/docs#24430 · 2026年10月12日に作成

メンテナーはふだん 1 日以内に返信
Broken Link Detected
オープン
- 何か問題がありますか？
難易度 1/5 1時間未満初心者へのやさしさ 62/100

pingcap/docs#24428 · 2026年10月12日に作成

メンテナーはふだん 1 日以内に返信
Weekly keywords check: mismatches found
オープン
- 何か問題がありますか？
難易度 2/5 1〜3時間初心者へのやさしさ 84/100

pingcap/docs#24150 · 2026年10月5日に作成

メンテナーはふだん 1 日以内に返信
Broken Link Detected
オープン
- 何か問題がありますか？
難易度 2/5 1〜3時間初心者へのやさしさ 67/100

pingcap/docs#24149 · 2026年10月5日に作成

メンテナーはふだん 1 日以内に返信
Weekly keywords check: mismatches found
オープン
- 何か問題がありますか？
難易度 2/5 1〜3時間初心者へのやさしさ 88/100

pingcap/docs#23974 · 2026年9月28日に作成

メンテナーはふだん 1 日以内に返信

pingcap/docs の issue をすべて見る

似ている issue

GLM family: section 4 says `reasoning_effort` makes GLM reason, but only `high` returns a trace, and the accepted values are not listed
オープン
- 何か問題がありますか？
難易度 2/5 1〜3時間初心者へのやさしさ 78/100

aws-samples/sample-per-model-bedrock#191 · 2026年10月13日に作成

メンテナーはふだん 1 日以内に返信
Docs viewer: inverted grey colormap, Phantom CT window -20 to 35 HU, smoothing up to 40 mm
対応中かもこのイシューにリンクされたプルリクエストがオープン中、またはマージ済みです。オープン
- 何か問題がありますか？
area: docs enhancement

難易度 2/5 1〜3時間初心者へのやさしさ 64/100

PyTomography/PyTomography#331 · 2026年10月13日に作成

メンテナーはふだん 1 日以内に返信
[Task]: Prevent CSRF for `copy_push_notification`
オープン
- 何か問題がありますか？
effort: low prio: low ready

難易度 2/5 1〜3時間初心者へのやさしさ 82/100

digitalfabrik/integreat-cms#4616 · 2026年10月13日に作成

メンテナーはふだん 5 日以内に返信
[md_cg/migrate_aeis] LAYER_MAP 缺 goals 层 ⇒ 迁移时 goals 节点被按 knowledge 静默落盘（数据损坏级）；且 main() 恒返回 0、conformance 的「新增一层要改哪里」登记表漏了迁移器
オープン
- 何か問題がありますか？
難易度 2/5 1〜3時間初心者へのやさしさ 66/100

FuRongJun-1999/dsh-memory#226 · コメント 1 件 · 2026年10月13日に作成

メンテナーはふだん 1 日以内に返信
eval gate: an integer baseline score too large for a float raises OverflowError instead of a usage error (after #1779)
オープン
- 何か問題がありますか？
bug difficulty:2 good first issue help wanted

難易度 2/5 1〜3時間初心者へのやさしさ 88/100

MakazhanAlpamys/Soup#1865 · 2026年10月13日に作成

メンテナーはふだん 1 日以内に返信

Python の issue をもっと見る

tidb-cloud: Top RU user guide needs rewrite — wrong product surface, missing Essential tier, non-user-facing content

何か問題がありますか？

評価

調査の方向性

説明

Problem

1. Wrong product surface

2. Essential tier completely missing

3. Internal engineering perspective, not user-facing

4. Key features from spec are missing

5. Incorrect prerequisite

Proposed fix

環境構築

はじめの一歩

pingcap/docs のほかの issue

何か問題がありますか？

何か問題がありますか？

何か問題がありますか？

何か問題がありますか？

何か問題がありますか？

似ている issue

何か問題がありますか？

何か問題がありますか？

何か問題がありますか？

何か問題がありますか？

何か問題がありますか？

新しい issue をメールで受け取る