TiDBTiDB Docs Dash 2024

Jan 9 - Jan 12 (UTC)
Join us to improve docs and win a prize!
Sign InTry Free

Monitor a TiDB Cluster

This document describes how to monitor a TiDB cluster on TiDB Cloud.

Cluster status and node status

You can see the current status of each running cluster on the cluster page.

Cluster status

Cluster statusDescription
AvailableThe cluster is healthy and available.
CreatingThe cluster is being created. The cluster is inaccessible while it is being created.
ImportingImporting data into the cluster.
MaintainingThe cluster is in maintenance.
ModifyingThe cluster is being modified.
UnavailableThe cluster has failed and TiDB cannot recover it.
PausingThe cluster is being paused.
PausedThe cluster is paused.
ResumingThe cluster is being resumed from a pause.
RestoringThe cluster is currently being restored from a backup.

TiDB node status

TiDB node statusDescription
AvailableThe TiDB node is healthy and available.
CreatingThe TiDB node is being created.
UnavailableThe TiDB node is not available.
DeletingThe TiDB node is being deleted.

TiKV node status

TiKV node statusDescription
AvailableThe TiKV node is healthy and available.
CreatingThe TiKV node is being created.
UnavailableThe TiKV node is not available.
DeletingThe TiKV node is being deleted.

Monitoring metrics

In TiDB Cloud, you can view the commonly used metrics of a cluster from the following pages:

  • Cluster overview page
  • Cluster monitoring page

Metrics on the cluster overview page

The cluster overview page provides general metrics of a cluster, including total QPS, query duration, active connections, TiDB CPU, TiKV CPU, TiFlash CPU, TiDB memory, TiKV memory, TiFlash memory, TiKV used storage size, and TiFlash used storage size.

To view metrics on the cluster overview page, take the following steps:

  1. Navigate to the Clusters page.

  2. Choose the target project and click the name of a cluster to go to its cluster overview page.

Metrics on the cluster monitoring page

The cluster monitoring page provides a full set of standard metrics of a cluster. By viewing these metrics, you can easily identify performance issues and determine whether your current database deployment meets your requirements.

To view metrics on the cluster monitoring page, take the following steps:

  1. On the Clusters page of the target project, click the name of the target cluster. The cluster overview page is displayed.
  2. Click Monitoring in the left navigation pane.

For more information, see Built-in Monitoring.

Was this page helpful?

Download PDFRequest docs changesAsk questions on Discord
Playground
New
One-stop & interactive experience of TiDB's capabilities WITHOUT registration.
Products
TiDB
TiDB Dedicated
TiDB Serverless
Pricing
Get Demo
Get Started
© 2024 PingCAP. All Rights Reserved.
Privacy Policy.