tidb-cloud: Top RU user guide needs rewrite — wrong product surface, missing Essential tier, non-user-facing content
Los mantenedores suelen responder en 1 día
Nadie ha tomado este issue todavía.
Evaluación
- Dificultad
- 4/5
- Tiempo estimado
- 3-5 días
- Aptitud para principiantes
- 48/100
- Tipo de issue
- Documentación
- Claridad
- Bien especificado
- Estado de actividad
- Tranquilo
- Área
- cloud, documentation
Línea de trabajo
Revisa el contenido existente del PR #22760 en tidb-cloud/premium/top-ru-in-clinic-premium.md, el destino propuesto tidb-cloud/top-ru.md y TOC-tidb-cloud.md. Usa la especificación del producto enlazada para verificar las capacidades de Premium y Essential; después, asegúrate de que la nueva página esté orientada a los usuarios, cubra las funciones y los límites indicados y esté enlazada en Monitor and Alert.
Escrito por el modelo de indexación a partir del texto del issue.
Descripción
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.mdunder "Monitor and Alert"
Spec reference: https://pingcap.feishu.cn/wiki/AQUdwgOFyiIELCkzGj7c0tyonLh
- Lenguaje dominante
- Python
- Estrellas
- 615
- Forks
- 724
- Merge medio
- 1 d 4 h
- PR fusionados (30 d)
- 521
Preparar el entorno
- Sin Dockerfile ni archivo de Docker Compose
- Tiene una plantilla de pull request
- Leer la guía de contribución
Primeros pasos
- Lee el issue completo y luego la guía de contribución del proyecto.
- Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
- Haz un fork del repositorio y trabaja en una rama.
- Abre un pull request que haga referencia al número del issue.
Más de pingcap/docs
-
area/docs-efficiency type/bug
Dificultad 2/5 1-3 horas Aptitud para principiantes 78/100
Los mantenedores suelen responder en 1 día
-
Dificultad 1/5 1-3 horas Aptitud para principiantes 78/100
Los mantenedores suelen responder en 1 día
-
Broken Link DetectedAbierto
Dificultad 1/5 Menos de una hora Aptitud para principiantes 62/100
Los mantenedores suelen responder en 1 día
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 84/100
Los mantenedores suelen responder en 1 día
-
Broken Link DetectedAbierto
Dificultad 2/5 1-3 horas Aptitud para principiantes 67/100
Los mantenedores suelen responder en 1 día
Todos los issues de pingcap/docs
Issues similares
-
Agentic
Dificultad 2/5 1-3 horas Aptitud para principiantes 72/100
Los mantenedores suelen responder en 1 día
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 82/100
Imbad0202/academic-research-skills#979 ·
Los mantenedores suelen responder en 1 día
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 72/100
reflex-dev/reflex#7561 · 1 comentario ·
Los mantenedores suelen responder en 1 día
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 72/100
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 62/100
prometheus-community/ansible#906 · 2 comentarios ·