From f4aa43fb368435c72b6a94e3f1633e999d610d62 Mon Sep 17 00:00:00 2001 From: Aolin Date: Thu, 17 Apr 2025 12:59:13 +0800 Subject: [PATCH] tidb-monitoring-framework: add TiDB Dashboard (#20776) --- TOC.md | 63 +++++++++++++++++------------------ _index.md | 2 +- deploy-monitoring-services.md | 4 +-- tidb-monitoring-framework.md | 8 +++-- 4 files changed, 39 insertions(+), 38 deletions(-) diff --git a/TOC.md b/TOC.md index 8863506dd7d60..c87ed75de3c49 100644 --- a/TOC.md +++ b/TOC.md @@ -216,6 +216,37 @@ - [Monitoring API](/tidb-monitoring-api.md) - [Deploy Monitoring Services](/deploy-monitoring-services.md) - [Upgrade Monitoring Services](/upgrade-monitoring-services.md) + - TiDB Dashboard + - [Overview](/dashboard/dashboard-intro.md) + - Maintain + - [Deploy](/dashboard/dashboard-ops-deploy.md) + - [Reverse Proxy](/dashboard/dashboard-ops-reverse-proxy.md) + - [User Management](/dashboard/dashboard-user.md) + - [Secure](/dashboard/dashboard-ops-security.md) + - [Access](/dashboard/dashboard-access.md) + - [Overview Page](/dashboard/dashboard-overview.md) + - [Cluster Info Page](/dashboard/dashboard-cluster-info.md) + - [Top SQL Page](/dashboard/top-sql.md) + - [Key Visualizer Page](/dashboard/dashboard-key-visualizer.md) + - [Metrics Relation Graph](/dashboard/dashboard-metrics-relation.md) + - SQL Statements Analysis + - [SQL Statements Page](/dashboard/dashboard-statement-list.md) + - [SQL Details Page](/dashboard/dashboard-statement-details.md) + - [Slow Queries Page](/dashboard/dashboard-slow-query.md) + - Cluster Diagnostics + - [Access Cluster Diagnostics Page](/dashboard/dashboard-diagnostics-access.md) + - [View Diagnostics Report](/dashboard/dashboard-diagnostics-report.md) + - [Use Diagnostics](/dashboard/dashboard-diagnostics-usage.md) + - [Monitoring Page](/dashboard/dashboard-monitoring.md) + - [Search Logs Page](/dashboard/dashboard-log-search.md) + - [Resource Manager Page](/dashboard/dashboard-resource-manager.md) + - Instance Profiling + - [Manual Profiling](/dashboard/dashboard-profiling.md) + - [Continuous Profiling](/dashboard/continuous-profiling.md) + - Session Management and Configuration + - [Share Session](/dashboard/dashboard-session-share.md) + - [Configure SSO](/dashboard/dashboard-session-sso.md) + - [FAQ](/dashboard/dashboard-faq.md) - [Export Grafana Snapshots](/exporting-grafana-snapshots.md) - [TiDB Cluster Alert Rules](/alert-rules.md) - [TiFlash Alert Rules](/tiflash/tiflash-alert-rules.md) @@ -978,38 +1009,6 @@ - [Overview](/performance-schema/performance-schema.md) - [`SESSION_CONNECT_ATTRS`](/performance-schema/performance-schema-session-connect-attrs.md) - [Metadata Lock](/metadata-lock.md) - - UI - - TiDB Dashboard - - [Overview](/dashboard/dashboard-intro.md) - - Maintain - - [Deploy](/dashboard/dashboard-ops-deploy.md) - - [Reverse Proxy](/dashboard/dashboard-ops-reverse-proxy.md) - - [User Management](/dashboard/dashboard-user.md) - - [Secure](/dashboard/dashboard-ops-security.md) - - [Access](/dashboard/dashboard-access.md) - - [Overview Page](/dashboard/dashboard-overview.md) - - [Cluster Info Page](/dashboard/dashboard-cluster-info.md) - - [Top SQL Page](/dashboard/top-sql.md) - - [Key Visualizer Page](/dashboard/dashboard-key-visualizer.md) - - [Metrics Relation Graph](/dashboard/dashboard-metrics-relation.md) - - SQL Statements Analysis - - [SQL Statements Page](/dashboard/dashboard-statement-list.md) - - [SQL Details Page](/dashboard/dashboard-statement-details.md) - - [Slow Queries Page](/dashboard/dashboard-slow-query.md) - - Cluster Diagnostics - - [Access Cluster Diagnostics Page](/dashboard/dashboard-diagnostics-access.md) - - [View Diagnostics Report](/dashboard/dashboard-diagnostics-report.md) - - [Use Diagnostics](/dashboard/dashboard-diagnostics-usage.md) - - [Monitoring Page](/dashboard/dashboard-monitoring.md) - - [Search Logs Page](/dashboard/dashboard-log-search.md) - - [Resource Manager Page](/dashboard/dashboard-resource-manager.md) - - Instance Profiling - - [Manual Profiling](/dashboard/dashboard-profiling.md) - - [Continuous Profiling](/dashboard/continuous-profiling.md) - - Session Management and Configuration - - [Share Session](/dashboard/dashboard-session-share.md) - - [Configure SSO](/dashboard/dashboard-session-sso.md) - - [FAQ](/dashboard/dashboard-faq.md) - [Telemetry](/telemetry.md) - [Error Codes](/error-codes.md) - [Table Filter](/table-filter.md) diff --git a/_index.md b/_index.md index b26669f42b75b..35cb2e22f77ba 100644 --- a/_index.md +++ b/_index.md @@ -81,7 +81,7 @@ summary: TiDB is an open-source distributed SQL database that supports Hybrid Tr -[Use Prometheus and Grafana](https://docs.pingcap.com/tidb/v7.5/tidb-monitoring-framework) +[Use Prometheus, Grafana, and TiDB Dashboard](https://docs.pingcap.com/tidb/v7.5/tidb-monitoring-framework) [Monitoring API](https://docs.pingcap.com/tidb/v7.5/tidb-monitoring-api) diff --git a/deploy-monitoring-services.md b/deploy-monitoring-services.md index 77df791f00da0..95acc4d2424cd 100644 --- a/deploy-monitoring-services.md +++ b/deploy-monitoring-services.md @@ -5,9 +5,7 @@ summary: Learn how to deploy monitoring services for the TiDB cluster. # Deploy Monitoring Services for the TiDB Cluster -This document is intended for users who want to manually deploy TiDB monitoring and alert services. - -If you deploy the TiDB cluster using TiUP, the monitoring and alert services are automatically deployed, and no manual deployment is needed. +This document is intended for users who want to manually deploy TiDB monitoring and alert services. If you deploy the TiDB cluster using TiUP, the monitoring and alert services are automatically deployed, and no manual deployment is needed. [TiDB Dashboard](/dashboard/dashboard-intro.md) is built into the PD component and does not require an independent deployment. ## Deploy Prometheus and Grafana diff --git a/tidb-monitoring-framework.md b/tidb-monitoring-framework.md index 5f55c2f19a354..e10d7faa4e17b 100644 --- a/tidb-monitoring-framework.md +++ b/tidb-monitoring-framework.md @@ -1,11 +1,11 @@ --- title: TiDB Monitoring Framework Overview -summary: Use Prometheus and Grafana to build the TiDB monitoring framework. +summary: Use Prometheus, Grafana, and TiDB Dashboard to build the TiDB monitoring framework. --- # TiDB Monitoring Framework Overview -The TiDB monitoring framework adopts two open source projects: Prometheus and Grafana. TiDB uses [Prometheus](https://prometheus.io) to store the monitoring and performance metrics and [Grafana](https://grafana.com/grafana) to visualize these metrics. +The TiDB monitoring framework adopts two open source projects: Prometheus and Grafana. TiDB uses [Prometheus](https://prometheus.io) to store the monitoring and performance metrics and [Grafana](https://grafana.com/grafana) to visualize these metrics. TiDB also provides a built-in [TiDB Dashboard](/dashboard/dashboard-intro.md) for monitoring and diagnosing TiDB clusters. ## About Prometheus in TiDB @@ -50,3 +50,7 @@ Grafana is an open source project for analyzing and visualizing metrics. TiDB us Each group has multiple panel labels of monitoring metrics, and each panel contains detailed information of multiple monitoring metrics. For example, the **Overview** monitoring group has five panel labels, and each labels corresponds to a monitoring panel. See the following UI: ![Grafana Overview](/media/grafana-monitor-overview.png) + +## TiDB Dashboard + +TiDB Dashboard is a web UI for monitoring, diagnosing, and managing the TiDB cluster, which is introduced in v4.0. It is built into the PD component and does not require an independent deployment. For more information, see [TiDB Dashboard introduction](/dashboard/dashboard-intro.md).