Skip to content

Commit 181e6b2

Browse files
authored
tidb-monitoring-framework: add TiDB Dashboard (#20207) (#20222)
1 parent df27d88 commit 181e6b2

File tree

4 files changed

+41
-38
lines changed

4 files changed

+41
-38
lines changed

TOC.md

+31-32
Original file line numberDiff line numberDiff line change
@@ -213,6 +213,37 @@
213213
- [监控 API](/tidb-monitoring-api.md)
214214
- [手动部署监控](/deploy-monitoring-services.md)
215215
- [升级监控组件](/upgrade-monitoring-services.md)
216+
- TiDB Dashboard
217+
- [简介](/dashboard/dashboard-intro.md)
218+
- 运维
219+
- [部署](/dashboard/dashboard-ops-deploy.md)
220+
- [反向代理](/dashboard/dashboard-ops-reverse-proxy.md)
221+
- [用户管理](/dashboard/dashboard-user.md)
222+
- [安全](/dashboard/dashboard-ops-security.md)
223+
- [访问](/dashboard/dashboard-access.md)
224+
- [概况页面](/dashboard/dashboard-overview.md)
225+
- [集群信息页面](/dashboard/dashboard-cluster-info.md)
226+
- [Top SQL 页面](/dashboard/top-sql.md)
227+
- [流量可视化页面](/dashboard/dashboard-key-visualizer.md)
228+
- [监控关系图](/dashboard/dashboard-metrics-relation.md)
229+
- SQL 语句分析
230+
- [列表页面](/dashboard/dashboard-statement-list.md)
231+
- [执行详情页面](/dashboard/dashboard-statement-details.md)
232+
- [慢查询页面](/dashboard/dashboard-slow-query.md)
233+
- 集群诊断页面
234+
- [访问](/dashboard/dashboard-diagnostics-access.md)
235+
- [查看报告](/dashboard/dashboard-diagnostics-report.md)
236+
- [使用示例](/dashboard/dashboard-diagnostics-usage.md)
237+
- [监控指标页面](/dashboard/dashboard-monitoring.md)
238+
- [日志搜索页面](/dashboard/dashboard-log-search.md)
239+
- [资源管控页面](/dashboard/dashboard-resource-manager.md)
240+
- 实例性能分析
241+
- [手动分析页面](/dashboard/dashboard-profiling.md)
242+
- [持续分析页面](/dashboard/continuous-profiling.md)
243+
- 会话管理与配置
244+
- [分享会话](/dashboard/dashboard-session-share.md)
245+
- [配置 SSO 登录](/dashboard/dashboard-session-sso.md)
246+
- [常见问题](/dashboard/dashboard-faq.md)
216247
- [将 Grafana 监控数据导出成快照](/exporting-grafana-snapshots.md)
217248
- [TiDB 集群报警规则与处理方法](/alert-rules.md)
218249
- [TiFlash 报警规则与处理方法](/tiflash/tiflash-alert-rules.md)
@@ -1027,38 +1058,6 @@
10271058
- [`schema_unused_indexes`](/sys-schema/sys-schema-unused-indexes.md)
10281059
- [元数据锁](/metadata-lock.md)
10291060
- [TiDB 加速建表](/accelerated-table-creation.md)
1030-
- UI
1031-
- TiDB Dashboard
1032-
- [简介](/dashboard/dashboard-intro.md)
1033-
- 运维
1034-
- [部署](/dashboard/dashboard-ops-deploy.md)
1035-
- [反向代理](/dashboard/dashboard-ops-reverse-proxy.md)
1036-
- [用户管理](/dashboard/dashboard-user.md)
1037-
- [安全](/dashboard/dashboard-ops-security.md)
1038-
- [访问](/dashboard/dashboard-access.md)
1039-
- [概况页面](/dashboard/dashboard-overview.md)
1040-
- [集群信息页面](/dashboard/dashboard-cluster-info.md)
1041-
- [Top SQL 页面](/dashboard/top-sql.md)
1042-
- [流量可视化页面](/dashboard/dashboard-key-visualizer.md)
1043-
- [监控关系图](/dashboard/dashboard-metrics-relation.md)
1044-
- SQL 语句分析
1045-
- [列表页面](/dashboard/dashboard-statement-list.md)
1046-
- [执行详情页面](/dashboard/dashboard-statement-details.md)
1047-
- [慢查询页面](/dashboard/dashboard-slow-query.md)
1048-
- 集群诊断页面
1049-
- [访问](/dashboard/dashboard-diagnostics-access.md)
1050-
- [查看报告](/dashboard/dashboard-diagnostics-report.md)
1051-
- [使用示例](/dashboard/dashboard-diagnostics-usage.md)
1052-
- [监控指标页面](/dashboard/dashboard-monitoring.md)
1053-
- [日志搜索页面](/dashboard/dashboard-log-search.md)
1054-
- [资源管控页面](/dashboard/dashboard-resource-manager.md)
1055-
- 实例性能分析
1056-
- [手动分析页面](/dashboard/dashboard-profiling.md)
1057-
- [持续分析页面](/dashboard/continuous-profiling.md)
1058-
- 会话管理与配置
1059-
- [分享会话](/dashboard/dashboard-session-share.md)
1060-
- [配置 SSO 登录](/dashboard/dashboard-session-sso.md)
1061-
- [常见问题](/dashboard/dashboard-faq.md)
10621061
- [遥测](/telemetry.md)
10631062
- [错误码](/error-codes.md)
10641063
- [通过拓扑 label 进行副本调度](/schedule-replicas-by-topology-labels.md)

_index.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -73,7 +73,7 @@ summary: TiDB 是 PingCAP 公司自主设计、研发的开源分布式关系型
7373

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

76-
[使用 Prometheus 和 Grafana](https://docs.pingcap.com/zh/tidb/v8.3/tidb-monitoring-framework)
76+
[使用 Prometheus、GrafanaTiDB Dashboard](https://docs.pingcap.com/zh/tidb/v8.3/tidb-monitoring-framework)
7777

7878
[监控 API](https://docs.pingcap.com/zh/tidb/v8.3/tidb-monitoring-api)
7979

deploy-monitoring-services.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ summary: 本文适用于手动部署 TiDB 监控报警系统的用户。假设 T
55

66
# TiDB 集群监控部署
77

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

1010
## 部署 Prometheus 和 Grafana
1111

tidb-monitoring-framework.md

+8-4
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,15 @@
11
---
22
title: TiDB 监控框架概述
3-
summary: TiDB 使用 Prometheus 作为监控和性能指标存储,Grafana 用于可视化展示。Prometheus 提供多个组件,包括 Prometheus Server、Client 代码库和 Alertmanager。Grafana 展示 TiDB 集群各组件的相关监控,分组包括备份恢复、Binlog、网络探活、磁盘性能、Kafka、TiDB Lightning 等。每个分组包含多个监控项页签,以及详细的监控指标看板。观看培训视频可快速了解监控与报警系统的体系、数据流转方式、系统管理方法和常用监控指标。
3+
summary: TiDB 使用 Prometheus 作为监控和性能指标存储,Grafana 用于可视化展示,以及 TiDB Dashboard 图形化界面用于监控及诊断 TiDB 集群。Prometheus 提供多个组件,包括 Prometheus Server、Client 代码库和 Alertmanager。Grafana 展示 TiDB 集群各组件的相关监控,分组包括备份恢复、Binlog、网络探活、磁盘性能、Kafka、TiDB Lightning 等。每个分组包含多个监控项页签,以及详细的监控指标看板。观看培训视频可快速了解监控与报警系统的体系、数据流转方式、系统管理方法和常用监控指标。
44
---
55

66
# TiDB 监控框架概述
77

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

1014
## Prometheus 在 TiDB 中的应用
1115

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

5357
![Grafana Overview](/media/grafana_monitor_overview.png)
5458

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

57-
<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>
61+
TiDB Dashboard 是 TiDB 自 4.0 版本起提供的图形化界面,可用于监控及诊断 TiDB 集群。TiDB Dashboard 内置于 TiDB 的 PD 组件中,无需独立部署。更多信息,请参考 [TiDB Dashboard 介绍](/dashboard/dashboard-intro.md)

0 commit comments

Comments
 (0)