Skip to content

tidb-monitoring-framework: add TiDB Dashboard (#20776) #20786

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 @@ -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)
Expand Down Expand Up @@ -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)
Expand Down
2 changes: 1 addition & 1 deletion _index.md
Original file line number Diff line number Diff line change
Expand Up @@ -81,7 +81,7 @@ summary: TiDB is an open-source distributed SQL database that supports Hybrid Tr

<LearningPath label="Monitor" icon="cloud6">

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

Expand Down
4 changes: 1 addition & 3 deletions deploy-monitoring-services.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
8 changes: 6 additions & 2 deletions tidb-monitoring-framework.md
Original file line number Diff line number Diff line change
@@ -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

Expand Down Expand Up @@ -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).