---
title: Monitor a TiDB Cluster
summary: Learn how to monitor your TiDB cluster.
---

# 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 status | Description |
|:--|:--|
| **Normal** | Normal running (including data migration) |
| **Creating** | Creating the cluster |
| **Importing** | The cluster is importing data |
| **Scaling** | Scaling the TiDB, TiKV, or TiFlash<sup>beta</sup> nodes |
| **Upgrading** | Upgrading the TiDB version |
| **Unavailable** | The TiDB Cloud service is not available |
| **Unhealthy** | Part of nodes are unavailable, not enough replicas, and so on |
| **Recovering** | Backup recovery |

### TiDB node status

| TiDB node status | Description |
|:--|:--|
| **Normal** | Normal running |
| **Creating** | Creating the node |
| **Unavailable** | The TiDB node is not available |
| **Terminating** | The TiDB node is terminating |

### TiKV node status

| TiKV node status | Description |
|:--|:--|
| **Normal** | Normal running |
| **Creating** | Creating the node |
| **Unavailable** | The TiKV node is not available |
| **Terminating** | The TiKV node is terminating |
| **Leaving** | Migrating the current node data before termination |

## Monitoring metrics

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

1. Navigate to the **TiDB Cluster** list page.

2. Click the name of the selected cluster, and go to the **Overview** page of the cluster.

    Currently, the metrics include Total QPS, Latency, Connections, TiFlash<sup>beta</sup> Request QPS, TiFlash<sup>beta</sup> Request Duration, TiFlash<sup>beta</sup> 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](/monitor-built-in-alerting.md).

## 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, click the account name in the upper-right corner of the window.
2. Click **Preferences**. The project preferences page is displayed.
3. Click the integration icon of a project that you want to view or modify.

### Available integrations

| Third-party service  | Configuration details                                        |
| :------------------- | :----------------------------------------------------------- |
| **Datadog integration** | Configures TiDB Cloud to send metric data about your TiDB clusters to [Datadog](https://www.datadoghq.com/). You can view these metrics in your Datadog dashboards. To get a detailed list of all metrics that Datadog tracks, refer to [Datadog Integration](/monitor-datadog-integration.md). |
| **Prometheus and Grafana integration** | Get 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](/monitor-prometheus-and-grafana-integration.md). |