Skip to content

Commit 66721f8

Browse files
authored
tidb-monitoring-framework: add TiDB Dashboard (#20207) (#20219)
1 parent 19c51c2 commit 66721f8

File tree

4 files changed

+40
-37
lines changed

4 files changed

+40
-37
lines changed

TOC.md

+31-32
Original file line numberDiff line numberDiff line change
@@ -210,6 +210,37 @@
210210
- [监控 API](/tidb-monitoring-api.md)
211211
- [手动部署监控](/deploy-monitoring-services.md)
212212
- [升级监控组件](/upgrade-monitoring-services.md)
213+
- TiDB Dashboard
214+
- [简介](/dashboard/dashboard-intro.md)
215+
- 运维
216+
- [部署](/dashboard/dashboard-ops-deploy.md)
217+
- [反向代理](/dashboard/dashboard-ops-reverse-proxy.md)
218+
- [用户管理](/dashboard/dashboard-user.md)
219+
- [安全](/dashboard/dashboard-ops-security.md)
220+
- [访问](/dashboard/dashboard-access.md)
221+
- [概况页面](/dashboard/dashboard-overview.md)
222+
- [集群信息页面](/dashboard/dashboard-cluster-info.md)
223+
- [Top SQL 页面](/dashboard/top-sql.md)
224+
- [流量可视化页面](/dashboard/dashboard-key-visualizer.md)
225+
- [监控关系图](/dashboard/dashboard-metrics-relation.md)
226+
- SQL 语句分析
227+
- [列表页面](/dashboard/dashboard-statement-list.md)
228+
- [执行详情页面](/dashboard/dashboard-statement-details.md)
229+
- [慢查询页面](/dashboard/dashboard-slow-query.md)
230+
- 集群诊断页面
231+
- [访问](/dashboard/dashboard-diagnostics-access.md)
232+
- [查看报告](/dashboard/dashboard-diagnostics-report.md)
233+
- [使用示例](/dashboard/dashboard-diagnostics-usage.md)
234+
- [监控指标页面](/dashboard/dashboard-monitoring.md)
235+
- [日志搜索页面](/dashboard/dashboard-log-search.md)
236+
- [资源管控页面](/dashboard/dashboard-resource-manager.md)
237+
- 实例性能分析
238+
- [手动分析页面](/dashboard/dashboard-profiling.md)
239+
- [持续分析页面](/dashboard/continuous-profiling.md)
240+
- 会话管理与配置
241+
- [分享会话](/dashboard/dashboard-session-share.md)
242+
- [配置 SSO 登录](/dashboard/dashboard-session-sso.md)
243+
- [常见问题](/dashboard/dashboard-faq.md)
213244
- [将 Grafana 监控数据导出成快照](/exporting-grafana-snapshots.md)
214245
- [TiDB 集群报警规则与处理方法](/alert-rules.md)
215246
- [TiFlash 报警规则与处理方法](/tiflash/tiflash-alert-rules.md)
@@ -955,38 +986,6 @@
955986
- [`VIEWS`](/information-schema/information-schema-views.md)
956987
- [`METRICS_SCHEMA`](/metrics-schema.md)
957988
- [元数据锁](/metadata-lock.md)
958-
- UI
959-
- TiDB Dashboard
960-
- [简介](/dashboard/dashboard-intro.md)
961-
- 运维
962-
- [部署](/dashboard/dashboard-ops-deploy.md)
963-
- [反向代理](/dashboard/dashboard-ops-reverse-proxy.md)
964-
- [用户管理](/dashboard/dashboard-user.md)
965-
- [安全](/dashboard/dashboard-ops-security.md)
966-
- [访问](/dashboard/dashboard-access.md)
967-
- [概况页面](/dashboard/dashboard-overview.md)
968-
- [集群信息页面](/dashboard/dashboard-cluster-info.md)
969-
- [Top SQL 页面](/dashboard/top-sql.md)
970-
- [流量可视化页面](/dashboard/dashboard-key-visualizer.md)
971-
- [监控关系图](/dashboard/dashboard-metrics-relation.md)
972-
- SQL 语句分析
973-
- [列表页面](/dashboard/dashboard-statement-list.md)
974-
- [执行详情页面](/dashboard/dashboard-statement-details.md)
975-
- [慢查询页面](/dashboard/dashboard-slow-query.md)
976-
- 集群诊断页面
977-
- [访问](/dashboard/dashboard-diagnostics-access.md)
978-
- [查看报告](/dashboard/dashboard-diagnostics-report.md)
979-
- [使用示例](/dashboard/dashboard-diagnostics-usage.md)
980-
- [监控指标页面](/dashboard/dashboard-monitoring.md)
981-
- [日志搜索页面](/dashboard/dashboard-log-search.md)
982-
- [资源管控页面](/dashboard/dashboard-resource-manager.md)
983-
- 实例性能分析
984-
- [手动分析页面](/dashboard/dashboard-profiling.md)
985-
- [持续分析页面](/dashboard/continuous-profiling.md)
986-
- 会话管理与配置
987-
- [分享会话](/dashboard/dashboard-session-share.md)
988-
- [配置 SSO 登录](/dashboard/dashboard-session-sso.md)
989-
- [常见问题](/dashboard/dashboard-faq.md)
990989
- [遥测](/telemetry.md)
991990
- [错误码](/error-codes.md)
992991
- [通过拓扑 label 进行副本调度](/schedule-replicas-by-topology-labels.md)

_index.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,7 @@ hide_commit: true
7272

7373
<LearningPath label="监控" icon="cloud6">
7474

75-
[使用 Prometheus 和 Grafana](https://docs.pingcap.com/zh/tidb/v7.1/tidb-monitoring-framework)
75+
[使用 Prometheus、GrafanaTiDB Dashboard](https://docs.pingcap.com/zh/tidb/v7.1/tidb-monitoring-framework)
7676

7777
[监控 API](https://docs.pingcap.com/zh/tidb/v7.1/tidb-monitoring-api)
7878

deploy-monitoring-services.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ title: 集群监控部署
44

55
# TiDB 集群监控部署
66

7-
本文档适用于希望手动部署 TiDB 监控报警系统的用户。TiUP 部署方式,会同时自动部署监控报警系统,无需手动部署。
7+
本文档适用于希望手动部署 TiDB 监控报警系统的用户。TiUP 部署方式,会同时自动部署监控报警系统,无需手动部署。[TiDB Dashboard](/dashboard/dashboard-intro.md) 内置于 TiDB 的 PD 组件中,无需独立部署。
88

99
## 部署 Prometheus 和 Grafana
1010

tidb-monitoring-framework.md

+7-3
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,11 @@ title: TiDB 监控框架概述
44

55
# TiDB 监控框架概述
66

7-
TiDB 使用开源时序数据库 [Prometheus](https://prometheus.io) 作为监控和性能指标信息存储方案,使用 [Grafana](https://grafana.com/grafana) 作为可视化组件进行展示。
7+
TiDB 使用开源时序数据库 [Prometheus](https://prometheus.io) 作为监控和性能指标信息存储方案,使用 [Grafana](https://grafana.com/grafana) 作为可视化组件进行展示,并提供内置的 [TiDB Dashboard](/dashboard/dashboard-intro.md) 图形化界面,用于监控及诊断 TiDB 集群。
8+
9+
要快速了解 TiDB 监控与报警系统的体系、该系统背后的数据流转方式、系统管理方法、系统使用方法和常用监控指标,建议观看下面的培训视频(时长 29 分钟)。注意本视频只作为学习参考,具体的[监控指标与相关报警规则](/alert-rules.md#tidb-报警规则),请以文档内容为准。
10+
11+
<video src="https://docs-download.pingcap.com/media/videos/docs-cn%2FLesson13_monitor.mp4" width="100%" height="100%" controls="controls" poster="https://docs-download.pingcap.com/media/videos/docs-cn/poster_lesson13.png"></video>
812

913
## Prometheus 在 TiDB 中的应用
1014

@@ -50,6 +54,6 @@ Grafana 是一个开源的 metric 分析及可视化系统。TiDB 使用 Grafana
5054

5155
![Grafana Overview](/media/grafana_monitor_overview.png)
5256

53-
要快速了解 TiDB 监控与报警系统的体系、该系统背后的数据流转方式、系统管理方法、系统使用方法和常用监控指标,建议观看下面的培训视频(时长 29 分钟)。注意本视频只作为学习参考,具体的[监控指标与相关报警规则](/alert-rules.md#tidb-报警规则),请以文档内容为准。
57+
## TiDB Dashboard
5458

55-
<video src="https://docs-download.pingcap.com/media/videos/docs-cn%2FLesson13_monitor.mp4" width="100%" height="100%" controls="controls" poster="https://docs-download.pingcap.com/media/videos/docs-cn/poster_lesson13.png"></video>
59+
TiDB Dashboard 是 TiDB 自 4.0 版本起提供的图形化界面,可用于监控及诊断 TiDB 集群。TiDB Dashboard 内置于 TiDB 的 PD 组件中,无需独立部署。更多信息,请参考 [TiDB Dashboard 介绍](/dashboard/dashboard-intro.md)

0 commit comments

Comments
 (0)