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
NormalNormal running (including data migration)
CreatingCreating the cluster
ImportingThe cluster is importing data
ScalingScaling the TiDB, TiKV, or TiFlashbeta nodes
UpgradingUpgrading the TiDB version
UnavailableThe TiDB Cloud service is not available
UnhealthyPart of nodes are unavailable, not enough replicas, and so on
RecoveringBackup recovery

TiDB node status

TiDB node statusDescription
NormalNormal running
CreatingCreating the node
UnavailableThe TiDB node is not available
TerminatingThe TiDB node is terminating

TiKV node status

TiKV node statusDescription
NormalNormal running
CreatingCreating the node
UnavailableThe TiKV node is not available
TerminatingThe TiKV node is terminating
LeavingMigrating the current node data before termination

Monitoring metrics

On the cluster overview page, you can view the commonly used metrics of the cluster.

  1. Navigate to the Active Clusters page.

  2. Click the name of a cluster to go to the cluster overview page.

    Currently, the metrics include Total QPS, Latency, Connections, TiFlashbeta Request QPS, TiFlashbeta Request Duration, TiFlashbeta Storage Size, TiKV Storage Size, TiDB CPU, TiKV CPU, TiKV IO Read, and TiKV IO Write.

Built-in alerting

TiDB Cloud has some built-in alerting conditions. You can configure TiDB Cloud to receive an email notification whenever a TiDB Cloud cluster in your project triggers a TiDB Cloud built-in alert condition.

For more information, see Built-in Alerting.

Third-party integrations

Required access

To edit third-party integration settings, you must have the Organization Owner access to your organization or Project Member access to the target project.

View or modify third-party integrations

  1. On the TiDB Cloud console, choose a target project that you want to view or modify, and then click the Project Settings tab.
  2. In the left pane, click Integrations. The available third-party integrations are displayed.

Available integrations

Third-party serviceConfiguration details
Datadog integrationConfigures TiDB Cloud to send metric data about your TiDB clusters to Datadog. You can view these metrics in your Datadog dashboards. To get a detailed list of all metrics that Datadog tracks, refer to Datadog Integration.
Prometheus and Grafana integrationGet a scrape_config file for Prometheus from TiDB Cloud and use the content from the file to configure Prometheus. You can view these metrics in your Grafana dashboards. To get a detailed list of all metrics that Prometheus tracks, refer to Prometheus and Grafana Integration.
Was this page helpful?