Skip to content

tidb-monitoring-framework: add TiDB Dashboard (#20207) #20219

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
63 changes: 31 additions & 32 deletions TOC.md
Original file line number Diff line number Diff line change
Expand Up @@ -210,6 +210,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)
Expand Down Expand Up @@ -955,38 +986,6 @@
- [`VIEWS`](/information-schema/information-schema-views.md)
- [`METRICS_SCHEMA`](/metrics-schema.md)
- [元数据锁](/metadata-lock.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)
Expand Down
2 changes: 1 addition & 1 deletion _index.md
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@ hide_commit: true

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

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

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

Expand Down
2 changes: 1 addition & 1 deletion deploy-monitoring-services.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ title: 集群监控部署

# TiDB 集群监控部署

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

## 部署 Prometheus 和 Grafana

Expand Down
10 changes: 7 additions & 3 deletions tidb-monitoring-framework.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,11 @@ title: TiDB 监控框架概述

# 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-报警规则),请以文档内容为准。

<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>

## Prometheus 在 TiDB 中的应用

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

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

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

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