From 01eb2a5be74a0dcd78c756f233c6c99a0a52b2ab Mon Sep 17 00:00:00 2001 From: Aolin Date: Wed, 16 Apr 2025 16:34:36 +0800 Subject: [PATCH] tidb-monitoring-framework: add TiDB Dashboard --- TOC.md | 63 +++++++++++++++++------------------ _index.md | 2 +- deploy-monitoring-services.md | 2 +- tidb-monitoring-framework.md | 12 ++++--- 4 files changed, 41 insertions(+), 38 deletions(-) diff --git a/TOC.md b/TOC.md index d858494376d0..1a1e76f45162 100644 --- a/TOC.md +++ b/TOC.md @@ -275,6 +275,37 @@ - [监控 API](/tidb-monitoring-api.md) - [手动部署监控](/deploy-monitoring-services.md) - [升级监控组件](/upgrade-monitoring-services.md) + - TiDB Dashboard + - [简介](/dashboard/dashboard-intro.md) + - 运维 + - [部署](/dashboard/dashboard-ops-deploy.md) + - [反向代理](/dashboard/dashboard-ops-reverse-proxy.md) + - [用户管理](/dashboard/dashboard-user.md) + - [安全](/dashboard/dashboard-ops-security.md) + - [访问](/dashboard/dashboard-access.md) + - [概况页面](/dashboard/dashboard-overview.md) + - [集群信息页面](/dashboard/dashboard-cluster-info.md) + - [Top SQL 页面](/dashboard/top-sql.md) + - [流量可视化页面](/dashboard/dashboard-key-visualizer.md) + - [监控关系图](/dashboard/dashboard-metrics-relation.md) + - SQL 语句分析 + - [列表页面](/dashboard/dashboard-statement-list.md) + - [执行详情页面](/dashboard/dashboard-statement-details.md) + - [慢查询页面](/dashboard/dashboard-slow-query.md) + - 集群诊断页面 + - [访问](/dashboard/dashboard-diagnostics-access.md) + - [查看报告](/dashboard/dashboard-diagnostics-report.md) + - [使用示例](/dashboard/dashboard-diagnostics-usage.md) + - [监控指标页面](/dashboard/dashboard-monitoring.md) + - [日志搜索页面](/dashboard/dashboard-log-search.md) + - [资源管控页面](/dashboard/dashboard-resource-manager.md) + - 实例性能分析 + - [手动分析页面](/dashboard/dashboard-profiling.md) + - [持续分析页面](/dashboard/continuous-profiling.md) + - 会话管理与配置 + - [分享会话](/dashboard/dashboard-session-share.md) + - [配置 SSO 登录](/dashboard/dashboard-session-sso.md) + - [常见问题](/dashboard/dashboard-faq.md) - [将 Grafana 监控数据导出成快照](/exporting-grafana-snapshots.md) - [TiDB 集群报警规则与处理方法](/alert-rules.md) - [TiFlash 报警规则与处理方法](/tiflash/tiflash-alert-rules.md) @@ -1040,38 +1071,6 @@ - [元数据锁](/metadata-lock.md) - [TiDB 加速建表](/accelerated-table-creation.md) - [Schema 缓存](/schema-cache.md) - - UI - - TiDB Dashboard - - [简介](/dashboard/dashboard-intro.md) - - 运维 - - [部署](/dashboard/dashboard-ops-deploy.md) - - [反向代理](/dashboard/dashboard-ops-reverse-proxy.md) - - [用户管理](/dashboard/dashboard-user.md) - - [安全](/dashboard/dashboard-ops-security.md) - - [访问](/dashboard/dashboard-access.md) - - [概况页面](/dashboard/dashboard-overview.md) - - [集群信息页面](/dashboard/dashboard-cluster-info.md) - - [Top SQL 页面](/dashboard/top-sql.md) - - [流量可视化页面](/dashboard/dashboard-key-visualizer.md) - - [监控关系图](/dashboard/dashboard-metrics-relation.md) - - SQL 语句分析 - - [列表页面](/dashboard/dashboard-statement-list.md) - - [执行详情页面](/dashboard/dashboard-statement-details.md) - - [慢查询页面](/dashboard/dashboard-slow-query.md) - - 集群诊断页面 - - [访问](/dashboard/dashboard-diagnostics-access.md) - - [查看报告](/dashboard/dashboard-diagnostics-report.md) - - [使用示例](/dashboard/dashboard-diagnostics-usage.md) - - [监控指标页面](/dashboard/dashboard-monitoring.md) - - [日志搜索页面](/dashboard/dashboard-log-search.md) - - [资源管控页面](/dashboard/dashboard-resource-manager.md) - - 实例性能分析 - - [手动分析页面](/dashboard/dashboard-profiling.md) - - [持续分析页面](/dashboard/continuous-profiling.md) - - 会话管理与配置 - - [分享会话](/dashboard/dashboard-session-share.md) - - [配置 SSO 登录](/dashboard/dashboard-session-sso.md) - - [常见问题](/dashboard/dashboard-faq.md) - [遥测](/telemetry.md) - [错误码](/error-codes.md) - [通过拓扑 label 进行副本调度](/schedule-replicas-by-topology-labels.md) diff --git a/_index.md b/_index.md index 7995570d1084..7a41e353af30 100644 --- a/_index.md +++ b/_index.md @@ -74,7 +74,7 @@ summary: TiDB 是 PingCAP 公司自主设计、研发的开源分布式关系型 -[使用 Prometheus 和 Grafana](https://docs.pingcap.com/zh/tidb/dev/tidb-monitoring-framework) +[使用 Prometheus、Grafana 和 TiDB Dashboard](https://docs.pingcap.com/zh/tidb/dev/tidb-monitoring-framework) [监控 API](https://docs.pingcap.com/zh/tidb/dev/tidb-monitoring-api) diff --git a/deploy-monitoring-services.md b/deploy-monitoring-services.md index ee5505148b98..86b592df1358 100644 --- a/deploy-monitoring-services.md +++ b/deploy-monitoring-services.md @@ -6,7 +6,7 @@ summary: 本文适用于手动部署 TiDB 监控报警系统的用户。假设 T # TiDB 集群监控部署 -本文档适用于希望手动部署 TiDB 监控报警系统的用户。TiUP 部署方式，会同时自动部署监控报警系统，无需手动部署。 +本文档适用于希望手动部署 TiDB 监控报警系统的用户。TiUP 部署方式，会同时自动部署监控报警系统，无需手动部署。[TiDB Dashboard](/dashboard/dashboard-intro.md) 内置于 TiDB 的 PD 组件中，无需独立部署。 ## 部署 Prometheus 和 Grafana diff --git a/tidb-monitoring-framework.md b/tidb-monitoring-framework.md index 8e92e88a70db..9200a46a73d8 100644 --- a/tidb-monitoring-framework.md +++ b/tidb-monitoring-framework.md @@ -1,12 +1,16 @@ --- title: TiDB 监控框架概述 aliases: ['/docs-cn/dev/tidb-monitoring-framework/','/docs-cn/dev/how-to/monitor/overview/'] -summary: TiDB 使用 Prometheus 作为监控和性能指标存储，Grafana 用于可视化展示。Prometheus 提供多个组件，包括 Prometheus Server、Client 代码库和 Alertmanager。Grafana 展示 TiDB 集群各组件的相关监控，分组包括备份恢复、Binlog、网络探活、磁盘性能、Kafka、TiDB Lightning 等。每个分组包含多个监控项页签，以及详细的监控指标看板。观看培训视频可快速了解监控与报警系统的体系、数据流转方式、系统管理方法和常用监控指标。 +summary: TiDB 使用 Prometheus 作为监控和性能指标存储，Grafana 用于可视化展示，以及 TiDB Dashboard 图形化界面用于监控及诊断 TiDB 集群。Prometheus 提供多个组件，包括 Prometheus Server、Client 代码库和 Alertmanager。Grafana 展示 TiDB 集群各组件的相关监控，分组包括备份恢复、Binlog、网络探活、磁盘性能、Kafka、TiDB Lightning 等。每个分组包含多个监控项页签，以及详细的监控指标看板。观看培训视频可快速了解监控与报警系统的体系、数据流转方式、系统管理方法和常用监控指标。 --- # TiDB 监控框架概述 -TiDB 使用开源时序数据库 [Prometheus](https://prometheus.io) 作为监控和性能指标信息存储方案，使用 [Grafana](https://grafana.com/grafana) 作为可视化组件进行展示。 +TiDB 使用开源时序数据库 [Prometheus](https://prometheus.io) 作为监控和性能指标信息存储方案，使用 [Grafana](https://grafana.com/grafana) 作为可视化组件进行展示，并提供内置的 [TiDB Dashboard](/dashboard/dashboard-intro.md) 图形化界面，用于监控及诊断 TiDB 集群。 + +要快速了解 TiDB 监控与报警系统的体系、该系统背后的数据流转方式、系统管理方法、系统使用方法和常用监控指标，建议观看下面的培训视频（时长 29 分钟）。注意本视频只作为学习参考，具体的[监控指标与相关报警规则](/alert-rules.md#tidb-报警规则)，请以文档内容为准。 + + ## Prometheus 在 TiDB 中的应用 @@ -52,6 +56,6 @@ Grafana 是一个开源的 metric 分析及可视化系统。TiDB 使用 Grafana ![Grafana Overview](/media/grafana_monitor_overview.png) -要快速了解 TiDB 监控与报警系统的体系、该系统背后的数据流转方式、系统管理方法、系统使用方法和常用监控指标，建议观看下面的培训视频（时长 29 分钟）。注意本视频只作为学习参考，具体的[监控指标与相关报警规则](/alert-rules.md#tidb-报警规则)，请以文档内容为准。 +## TiDB Dashboard - +TiDB Dashboard 是 TiDB 自 4.0 版本起提供的图形化界面，可用于监控及诊断 TiDB 集群。TiDB Dashboard 内置于 TiDB 的 PD 组件中，无需独立部署。更多信息，请参考 [TiDB Dashboard 介绍](/dashboard/dashboard-intro.md)。