From d9ef1ec2002e16dd65934cad8d9bd2eec4b90834 Mon Sep 17 00:00:00 2001
From: huoyao1125 <90880576+huoyao1125@users.noreply.github.com>
Date: Thu, 25 Jun 2026 17:07:34 +0800
Subject: [PATCH 1/8] Create monitor-datadog-integration-for-tidb-x.md
---
tidb-cloud/monitor-datadog-integration-for-tidb-x.md | 1 +
1 file changed, 1 insertion(+)
create mode 100644 tidb-cloud/monitor-datadog-integration-for-tidb-x.md
diff --git a/tidb-cloud/monitor-datadog-integration-for-tidb-x.md b/tidb-cloud/monitor-datadog-integration-for-tidb-x.md
new file mode 100644
index 0000000000000..8b137891791fe
--- /dev/null
+++ b/tidb-cloud/monitor-datadog-integration-for-tidb-x.md
@@ -0,0 +1 @@
+
From 3d13bbcc6c3a721408878bdbeaa5ee1b893c256b Mon Sep 17 00:00:00 2001
From: huoyao1125 <90880576+huoyao1125@users.noreply.github.com>
Date: Thu, 25 Jun 2026 17:23:12 +0800
Subject: [PATCH 2/8] Add Datadog integration doc for TiDB Cloud Premium and
Essential
---
.../monitor-datadog-integration-for-tidb-x.md | 150 ++++++++++++++++++
1 file changed, 150 insertions(+)
diff --git a/tidb-cloud/monitor-datadog-integration-for-tidb-x.md b/tidb-cloud/monitor-datadog-integration-for-tidb-x.md
index 8b137891791fe..ae7dde6d575a3 100644
--- a/tidb-cloud/monitor-datadog-integration-for-tidb-x.md
+++ b/tidb-cloud/monitor-datadog-integration-for-tidb-x.md
@@ -1 +1,151 @@
+---
+title: Integrate TiDB Cloud with Datadog (Preview)
+summary: Learn how to monitor your TiDB Cloud instances with the Datadog integration.
+---
+# Integrate TiDB Cloud with Datadog (Preview)
+
+TiDB Cloud supports Datadog integration. You can configure TiDB Cloud to send metrics about your {{{ .essential }}}{{{ .premium }}} instances to [Datadog](https://www.datadoghq.com/). After that, you can view these metrics in your Datadog dashboards directly.
+
+## Prerequisites
+
+- To integrate TiDB Cloud with Datadog, you must have a Datadog account and a [Datadog API key](https://app.datadoghq.com/organization-settings/api-keys). Datadog grants you an API key when you first create a Datadog account.
+
+ If you do not have a Datadog account, sign up at [https://app.datadoghq.com/signup](https://app.datadoghq.com/signup).
+
+- To set up third-party metrics integration for TiDB Cloud, you must have the `Organization Owner` or `Instance Manager` access in TiDB Cloud. To view the integration page, you need at least the `Project Viewer` or `Instance Viewer` role to access the target {{{ .essential }}}{{{ .premium }}} instance under your Organization in TiDB Cloud.
+
+## Limitation
+
+- Datadog integration is not available for [TiDB Cloud Starter](/tidb-cloud/select-cluster-tier.md#starter) instances.
+- Datadog integration is not available when the status of your {{{ .essential }}}{{{ .premium }}} instance is **CREATING**, **RESTORING**, **PAUSED**, or **RESUMING**.
+
+## Steps
+
+### Step 1. Integrate with your Datadog API Key
+
+
+
+1. In the [TiDB Cloud console](https://tidbcloud.com/), navigate to the [**My TiDB**](https://tidbcloud.com/tidbs) page, and then click the name of your target {{{ .essential }}} instance to go to its overview page.
+2. In the left navigation pane, click **Integrations** > **Integration to Datadog(Preview)**.
+3. Enter your Datadog API key and choose your Datadog site.
+4. Click **Test Integration**.
+
+ - If the test succeeds, the **Confirm** button is displayed.
+ - If the test fails, an error message is displayed. Follow the message for troubleshooting and retry the integration.
+
+5. Click **Confirm** to complete the integration.
+
+
+
+
+
+1. In the [TiDB Cloud console](https://tidbcloud.com/), navigate to the [**My TiDB**](https://tidbcloud.com/tidbs) page, and then click the name of your target {{{ .premium }}} instance to go to its overview page.
+2. In the left navigation pane, click **Settings** > **Integrations** > **Integration to Datadog(Preview)**.
+3. Enter your Datadog API key and choose your Datadog site.
+4. Click **Test Integration**.
+
+ - If the test succeeds, the **Confirm** button is displayed.
+ - If the test fails, an error message is displayed. Follow the message for troubleshooting and retry the integration.
+
+5. Click **Confirm** to complete the integration.
+
+
+
+### Step 2. Import the pre-built Datadog dashboard
+
+The TiDB Cloud dashboard for {{{ .essential }}}{{{ .premium }}} is not yet available directly from the Datadog integration marketplace. You need to manually download and import the dashboard JSON file into Datadog.
+
+1. Download the Datadog dashboard JSON file for your instance type:
+
+
+
+
+
+
+
+
+
+
+
+
+
+2. Log in to [Datadog](https://app.datadoghq.com) and go to **Dashboards** > **Dashboard List**.
+
+3. Click **+ New Dashboard** in the upper-right corner. Enter a dashboard name, then select **Start from blank dashboard**.
+
+4. Once inside the new dashboard, click the gear icon (**Configure**) in the upper-right corner, and then select **Import dashboard JSON...**.
+
+5. In the dialog that appears, paste the JSON content or drag and drop the JSON file.
+
+6. Click **Yes, Replace** to confirm the import.
+
+## View the pre-built dashboard
+
+After the Datadog integration is set up, you can access the dashboard from the TiDB Cloud console:
+
+
+
+1. In the [TiDB Cloud console](https://tidbcloud.com/), navigate to the [**My TiDB**](https://tidbcloud.com/tidbs) page, and then click the name of your target {{{ .essential }}} instance to go to its overview page.
+2. In the left navigation pane, click **Integrations** > **Integration to Datadog(Preview)**.
+3. Click the **Dashboard** link to open the dashboard in Datadog.
+
+
+
+
+
+1. In the [TiDB Cloud console](https://tidbcloud.com/), navigate to the [**My TiDB**](https://tidbcloud.com/tidbs) page, and then click the name of your target {{{ .premium }}} instance to go to its overview page.
+2. In the left navigation pane, click **Settings** > **Integrations** > **Integration to Datadog(Preview)**.
+3. Click the **Dashboard** link to open the dashboard in Datadog.
+
+
+
+## Metrics available to Datadog
+
+Datadog tracks the following metrics for your {{{ .essential }}}{{{ .premium }}} instance.
+
+
+
+> **Note:**
+>
+> {{{ .essential }}} does not support TiCDC components, so the `tidb_cloud.changefeed_*` metrics are currently not available.
+
+| Metric name | Metric type | Labels | Description |
+|:--- |:--- |:--- |:--- |
+| `tidb_cloud.db_total_connection` | gauge | `instance_id: `
`instance_name: ` | The number of current connections in your TiDB server |
+| `tidb_cloud.db_active_connections` | gauge | `instance_id: `
`instance_name: ` | The number of active connections |
+| `tidb_cloud.db_disconnections` | gauge | `result: Error\|...`
`instance_id: `
`instance_name: ` | The number of clients disconnected by connection result |
+| `tidb_cloud.db_database_time` | gauge | `sql_type: Select\|Insert\|...`
`instance_id: `
`instance_name: ` | The total time consumed by all SQL statements running in TiDB per second, including the CPU time of all processes and the non-idle waiting time |
+| `tidb_cloud.db_query_per_second` | gauge | `type: Select\|Insert\|...`
`instance_id: `
`instance_name: ` | The number of SQL statements executed per second, counted according to statement types |
+| `tidb_cloud.db_failed_queries` | gauge | `type: planner:xxx\|executor:2345\|...`
`instance_id: `
`instance_name: ` | The statistics of error types (for example, syntax errors, primary key conflicts) occurred when executing SQL statements per second |
+| `tidb_cloud.db_command_per_second` | gauge | `type: Query\|Ping\|...`
`instance_id: `
`instance_name: ` | The number of commands processed by TiDB per second |
+| `tidb_cloud.db_queries_using_plan_cache_ops` | gauge | `instance_id: `
`instance_name: ` | The statistics of queries hitting the Execution Plan Cache per second |
+| `tidb_cloud.db_average_query_duration` | gauge | `sql_type: Select\|Insert\|...`
`instance_id: `
`instance_name: ` | The duration between the time a network request is sent to TiDB and returned to the client |
+| `tidb_cloud.db_transaction_per_second` | gauge | `type: Commit\|Rollback\|...`
`txn_mode: optimistic\|pessimistic`
`instance_id: `
`instance_name: ` | The number of transactions executed per second |
+| `tidb_cloud.db_row_storage_used_bytes` | gauge | `instance_id: `
`instance_name: ` | The row-based storage size of the {{{ .essential }}} instance in bytes |
+| `tidb_cloud.db_columnar_storage_used_bytes` | gauge | `instance_id: `
`instance_name: ` | The columnar storage size of the {{{ .essential }}} instance in bytes. Returns 0 if TiFlash is not enabled. |
+| `tidb_cloud.resource_manager_resource_request_unit_total` | gauge | `instance_id: `
`instance_name: ` | The total Request Units (RU) consumed |
+
+
+
+
+
+| Metric name | Metric type | Labels | Description |
+|:--- |:--- |:--- |:--- |
+| `tidb_cloud.db_total_connection` | gauge | `instance_id: `
`instance_name: ` | The number of current connections in your TiDB server |
+| `tidb_cloud.db_active_connections` | gauge | `instance_id: `
`instance_name: ` | The number of active connections |
+| `tidb_cloud.db_disconnections` | gauge | `result: Error\|...`
`instance_id: `
`instance_name: ` | The number of clients disconnected by connection result |
+| `tidb_cloud.db_database_time` | gauge | `sql_type: Select\|Insert\|...`
`instance_id: `
`instance_name: ` | The total time consumed by all SQL statements running in TiDB per second, including the CPU time of all processes and the non-idle waiting time |
+| `tidb_cloud.db_query_per_second` | gauge | `type: Select\|Insert\|...`
`instance_id: `
`instance_name: ` | The number of SQL statements executed per second, counted according to statement types |
+| `tidb_cloud.db_failed_queries` | gauge | `type: planner:xxx\|executor:2345\|...`
`instance_id: `
`instance_name: ` | The statistics of error types (for example, syntax errors, primary key conflicts) occurred when executing SQL statements per second |
+| `tidb_cloud.db_command_per_second` | gauge | `type: Query\|Ping\|...`
`instance_id: `
`instance_name: ` | The number of commands processed by TiDB per second |
+| `tidb_cloud.db_queries_using_plan_cache_ops` | gauge | `instance_id: `
`instance_name: ` | The statistics of queries hitting the Execution Plan Cache per second |
+| `tidb_cloud.db_average_query_duration` | gauge | `sql_type: Select\|Insert\|...`
`instance_id: `
`instance_name: ` | The duration between the time a network request is sent to TiDB and returned to the client |
+| `tidb_cloud.db_transaction_per_second` | gauge | `type: Commit\|Rollback\|...`
`txn_mode: optimistic\|pessimistic`
`instance_id: `
`instance_name: ` | The number of transactions executed per second |
+| `tidb_cloud.db_row_storage_used_bytes` | gauge | `instance_id: `
`instance_name: ` | The row-based storage size of the {{{ .premium }}} instance in bytes |
+| `tidb_cloud.db_columnar_storage_used_bytes` | gauge | `instance_id: `
`instance_name: ` | The columnar storage size of the {{{ .premium }}} instance in bytes |
+| `tidb_cloud.resource_manager_resource_request_unit_total` | gauge | `instance_id: `
`instance_name: ` | The total Request Units (RU) consumed |
+| `tidb_cloud.changefeed_latency` | gauge | `changefeed: `
`instance_id: `
`instance_name: ` | The data replication latency between the upstream and the downstream of a changefeed |
+| `tidb_cloud.changefeed_status` | gauge | `changefeed: `
`instance_id: `
`instance_name: ` | Changefeed status:
`-1`: Unknown
`0`: Normal
`1`: Warning
`2`: Failed
`3`: Stopped
`4`: Finished
`6`: Warning
`7`: Other |
+
+
From c6a45b4929b8a39b16d622a010698c1666c38aa5 Mon Sep 17 00:00:00 2001
From: huoyao1125 <90880576+huoyao1125@users.noreply.github.com>
Date: Mon, 29 Jun 2026 15:39:57 +0800
Subject: [PATCH 3/8] Update monitor-datadog-integration-for-tidb-x.md
---
.../monitor-datadog-integration-for-tidb-x.md | 66 ++++++++-----------
1 file changed, 26 insertions(+), 40 deletions(-)
diff --git a/tidb-cloud/monitor-datadog-integration-for-tidb-x.md b/tidb-cloud/monitor-datadog-integration-for-tidb-x.md
index ae7dde6d575a3..b34fda1ed9dbe 100644
--- a/tidb-cloud/monitor-datadog-integration-for-tidb-x.md
+++ b/tidb-cloud/monitor-datadog-integration-for-tidb-x.md
@@ -13,7 +13,7 @@ TiDB Cloud supports Datadog integration. You can configure TiDB Cloud to send me
If you do not have a Datadog account, sign up at [https://app.datadoghq.com/signup](https://app.datadoghq.com/signup).
-- To set up third-party metrics integration for TiDB Cloud, you must have the `Organization Owner` or `Instance Manager` access in TiDB Cloud. To view the integration page, you need at least the `Project Viewer` or `Instance Viewer` role to access the target {{{ .essential }}}{{{ .premium }}} instance under your Organization in TiDB Cloud.
+- To set up third-party metrics integration for TiDB Cloud, you must have the `Organization Owner`, `Project Owner` or `Instance Manager` access in TiDB Cloud. To view the integration page, you need at least the `Project Viewer` or `Instance Viewer` role to access the target {{{ .essential }}}{{{ .premium }}} instance under your Organization in TiDB Cloud.
## Limitation
@@ -22,37 +22,7 @@ TiDB Cloud supports Datadog integration. You can configure TiDB Cloud to send me
## Steps
-### Step 1. Integrate with your Datadog API Key
-
-
-
-1. In the [TiDB Cloud console](https://tidbcloud.com/), navigate to the [**My TiDB**](https://tidbcloud.com/tidbs) page, and then click the name of your target {{{ .essential }}} instance to go to its overview page.
-2. In the left navigation pane, click **Integrations** > **Integration to Datadog(Preview)**.
-3. Enter your Datadog API key and choose your Datadog site.
-4. Click **Test Integration**.
-
- - If the test succeeds, the **Confirm** button is displayed.
- - If the test fails, an error message is displayed. Follow the message for troubleshooting and retry the integration.
-
-5. Click **Confirm** to complete the integration.
-
-
-
-
-
-1. In the [TiDB Cloud console](https://tidbcloud.com/), navigate to the [**My TiDB**](https://tidbcloud.com/tidbs) page, and then click the name of your target {{{ .premium }}} instance to go to its overview page.
-2. In the left navigation pane, click **Settings** > **Integrations** > **Integration to Datadog(Preview)**.
-3. Enter your Datadog API key and choose your Datadog site.
-4. Click **Test Integration**.
-
- - If the test succeeds, the **Confirm** button is displayed.
- - If the test fails, an error message is displayed. Follow the message for troubleshooting and retry the integration.
-
-5. Click **Confirm** to complete the integration.
-
-
-
-### Step 2. Import the pre-built Datadog dashboard
+### Step 1. Import the pre-built Datadog dashboard
The TiDB Cloud dashboard for {{{ .essential }}}{{{ .premium }}} is not yet available directly from the Datadog integration marketplace. You need to manually download and import the dashboard JSON file into Datadog.
@@ -80,15 +50,19 @@ The TiDB Cloud dashboard for {{{ .essential }}}<
6. Click **Yes, Replace** to confirm the import.
-## View the pre-built dashboard
-
-After the Datadog integration is set up, you can access the dashboard from the TiDB Cloud console:
+### Step 2. Integrate with your Datadog API Key
1. In the [TiDB Cloud console](https://tidbcloud.com/), navigate to the [**My TiDB**](https://tidbcloud.com/tidbs) page, and then click the name of your target {{{ .essential }}} instance to go to its overview page.
2. In the left navigation pane, click **Integrations** > **Integration to Datadog(Preview)**.
-3. Click the **Dashboard** link to open the dashboard in Datadog.
+3. Enter your Datadog API key and choose your Datadog Region.
+4. Click **Test Integration**.
+
+ - If the test succeeds, the **Confirm** button is displayed.
+ - If the test fails, an error message is displayed. Follow the message for troubleshooting and retry the integration.
+
+5. Click **Confirm** to complete the integration.
@@ -96,10 +70,22 @@ After the Datadog integration is set up, you can access the dashboard from the T
1. In the [TiDB Cloud console](https://tidbcloud.com/), navigate to the [**My TiDB**](https://tidbcloud.com/tidbs) page, and then click the name of your target {{{ .premium }}} instance to go to its overview page.
2. In the left navigation pane, click **Settings** > **Integrations** > **Integration to Datadog(Preview)**.
-3. Click the **Dashboard** link to open the dashboard in Datadog.
+3. Enter your Datadog API key and choose your Datadog Region.
+4. Click **Test Integration**.
+
+ - If the test succeeds, the **Confirm** button is displayed.
+ - If the test fails, an error message is displayed. Follow the message for troubleshooting and retry the integration.
+
+5. Click **Confirm** to complete the integration.
+## View the pre-built dashboard
+
+Option 1: In the [TiDB Cloud console](https://tidbcloud.com/), go to **Integrations**, click the **Datadog(Preview)** card to view the integration details, then click **Dashboard** button, you will be redirected to the Datadog Dashboard List page. On the Datadog website, select the dashboard imported in Step 1 and filter by your target instance name.
+
+Option 2: Go directly to Datadog → Dashboard List. Select the dashboard imported in Step 1, filter by your target instance name, and view the metrics.
+
## Metrics available to Datadog
Datadog tracks the following metrics for your {{{ .essential }}}{{{ .premium }}} instance.
@@ -108,7 +94,7 @@ Datadog tracks the following metrics for your {{
> **Note:**
>
-> {{{ .essential }}} does not support TiCDC components, so the `tidb_cloud.changefeed_*` metrics are currently not available.
+> {{{ .essential }}} currently does not support TiCDC feature, so the `tidb_cloud.changefeed_*` metrics are currently not available.
| Metric name | Metric type | Labels | Description |
|:--- |:--- |:--- |:--- |
@@ -124,7 +110,7 @@ Datadog tracks the following metrics for your {{
| `tidb_cloud.db_transaction_per_second` | gauge | `type: Commit\|Rollback\|...`
`txn_mode: optimistic\|pessimistic`
`instance_id: `
`instance_name: ` | The number of transactions executed per second |
| `tidb_cloud.db_row_storage_used_bytes` | gauge | `instance_id: `
`instance_name: ` | The row-based storage size of the {{{ .essential }}} instance in bytes |
| `tidb_cloud.db_columnar_storage_used_bytes` | gauge | `instance_id: `
`instance_name: ` | The columnar storage size of the {{{ .essential }}} instance in bytes. Returns 0 if TiFlash is not enabled. |
-| `tidb_cloud.resource_manager_resource_request_unit_total` | gauge | `instance_id: `
`instance_name: ` | The total Request Units (RU) consumed |
+| `tidb_cloud.resource_manager_resource_request_unit_total` | gauge | `instance_id: `
`instance_name: ` | The total Request Units/s (RU/s) consumed |
@@ -144,7 +130,7 @@ Datadog tracks the following metrics for your {{
| `tidb_cloud.db_transaction_per_second` | gauge | `type: Commit\|Rollback\|...`
`txn_mode: optimistic\|pessimistic`
`instance_id: `
`instance_name: ` | The number of transactions executed per second |
| `tidb_cloud.db_row_storage_used_bytes` | gauge | `instance_id: `
`instance_name: ` | The row-based storage size of the {{{ .premium }}} instance in bytes |
| `tidb_cloud.db_columnar_storage_used_bytes` | gauge | `instance_id: `
`instance_name: ` | The columnar storage size of the {{{ .premium }}} instance in bytes |
-| `tidb_cloud.resource_manager_resource_request_unit_total` | gauge | `instance_id: `
`instance_name: ` | The total Request Units (RU) consumed |
+| `tidb_cloud.resource_manager_resource_request_unit_total` | gauge | `instance_id: `
`instance_name: ` | The total Request Units/s (RU/s) consumed |
| `tidb_cloud.changefeed_latency` | gauge | `changefeed: `
`instance_id: `
`instance_name: ` | The data replication latency between the upstream and the downstream of a changefeed |
| `tidb_cloud.changefeed_status` | gauge | `changefeed: `
`instance_id: `
`instance_name: ` | Changefeed status:
`-1`: Unknown
`0`: Normal
`1`: Warning
`2`: Failed
`3`: Stopped
`4`: Finished
`6`: Warning
`7`: Other |
From 8b523278ab873aa1c1a5455de2c0c0cea2d4757a Mon Sep 17 00:00:00 2001
From: Grace Cai
Date: Tue, 7 Jul 2026 17:42:47 +0800
Subject: [PATCH 4/8] Apply suggestions from Yujie-Xie
---
tidb-cloud/monitor-datadog-integration-for-tidb-x.md | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)
diff --git a/tidb-cloud/monitor-datadog-integration-for-tidb-x.md b/tidb-cloud/monitor-datadog-integration-for-tidb-x.md
index b34fda1ed9dbe..36c030cae2c24 100644
--- a/tidb-cloud/monitor-datadog-integration-for-tidb-x.md
+++ b/tidb-cloud/monitor-datadog-integration-for-tidb-x.md
@@ -30,13 +30,13 @@ The TiDB Cloud dashboard for {{{ .essential }}}<
-
+
-
+
From 4e4d518116b836491541aab81a610f9b10d11e1f Mon Sep 17 00:00:00 2001
From: qiancai
Date: Tue, 7 Jul 2026 19:06:43 +0800
Subject: [PATCH 5/8] revise descriptions
---
.../monitor-datadog-integration-for-tidb-x.md | 16 ++++++++--------
tidb-cloud/monitor-datadog-integration.md | 10 +++++++++-
2 files changed, 17 insertions(+), 9 deletions(-)
diff --git a/tidb-cloud/monitor-datadog-integration-for-tidb-x.md b/tidb-cloud/monitor-datadog-integration-for-tidb-x.md
index 36c030cae2c24..9e38aca678be9 100644
--- a/tidb-cloud/monitor-datadog-integration-for-tidb-x.md
+++ b/tidb-cloud/monitor-datadog-integration-for-tidb-x.md
@@ -24,7 +24,7 @@ TiDB Cloud supports Datadog integration. You can configure TiDB Cloud to send me
### Step 1. Import the pre-built Datadog dashboard
-The TiDB Cloud dashboard for {{{ .essential }}}{{{ .premium }}} is not yet available directly from the Datadog integration marketplace. You need to manually download and import the dashboard JSON file into Datadog.
+Currently, the TiDB Cloud dashboard for {{{ .essential }}}{{{ .premium }}} is not yet available in the Datadog integration marketplace. You need to manually download and import the dashboard JSON file into Datadog.
1. Download the Datadog dashboard JSON file for your instance type:
@@ -40,13 +40,13 @@ The TiDB Cloud dashboard for {{{ .essential }}}<
-2. Log in to [Datadog](https://app.datadoghq.com) and go to **Dashboards** > **Dashboard List**.
+2. Log in to [Datadog](https://app.datadoghq.com), and then go to **Dashboards** > **Dashboard List**.
-3. Click **+ New Dashboard** in the upper-right corner. Enter a dashboard name, then select **Start from blank dashboard**.
+3. Click **+ New Dashboard** in the upper-right corner. Enter a dashboard name, and then select **Start from blank dashboard**.
-4. Once inside the new dashboard, click the gear icon (**Configure**) in the upper-right corner, and then select **Import dashboard JSON...**.
+4. In the new dashboard, click the gear icon (**Configure**) in the upper-right corner, and then select **Import dashboard JSON...**.
-5. In the dialog that appears, paste the JSON content or drag and drop the JSON file.
+5. In the dialog that appears, paste the JSON content, or drag and drop the JSON file.
6. Click **Yes, Replace** to confirm the import.
@@ -82,9 +82,9 @@ The TiDB Cloud dashboard for {{{ .essential }}}<
## View the pre-built dashboard
-Option 1: In the [TiDB Cloud console](https://tidbcloud.com/), go to **Integrations**, click the **Datadog(Preview)** card to view the integration details, then click **Dashboard** button, you will be redirected to the Datadog Dashboard List page. On the Datadog website, select the dashboard imported in Step 1 and filter by your target instance name.
+To view the pre-built dashboard after the integration, go to **Dashboards** > **Dashboard List** in [Datadog](https://app.datadoghq.com), and then select the dashboard imported in [Step 1](#step-1-import-the-pre-built-datadog-dashboard). On the dashboard page, you can filter by your target instance name, and view the metrics.
-Option 2: Go directly to Datadog → Dashboard List. Select the dashboard imported in Step 1, filter by your target instance name, and view the metrics.
+You can also access the **Dashboard List** page of Datadog from the [TiDB Cloud console](https://tidbcloud.com/): go to the **Integrations** page of your target instance, click **Datadog(Preview)**, and then click **Dashboard**.
## Metrics available to Datadog
@@ -94,7 +94,7 @@ Datadog tracks the following metrics for your {{
> **Note:**
>
-> {{{ .essential }}} currently does not support TiCDC feature, so the `tidb_cloud.changefeed_*` metrics are currently not available.
+> Currently, the changefeed feature for {{{ .premium }}} is only available upon request, and the `tidb_cloud.changefeed_*` metrics are currently not available.
| Metric name | Metric type | Labels | Description |
|:--- |:--- |:--- |:--- |
diff --git a/tidb-cloud/monitor-datadog-integration.md b/tidb-cloud/monitor-datadog-integration.md
index 8c2a16f30a16e..7db54f693e894 100644
--- a/tidb-cloud/monitor-datadog-integration.md
+++ b/tidb-cloud/monitor-datadog-integration.md
@@ -7,6 +7,14 @@ summary: Learn how to monitor your TiDB cluster with the Datadog integration.
TiDB Cloud supports Datadog integration. You can configure TiDB Cloud to send metrics about your TiDB clusters to [Datadog](https://www.datadoghq.com/). After that, you can view these metrics in your Datadog dashboards directly.
+> **Note:**
+>
+> This document only applies to TiDB Cloud Dedicated.
+>
+> For TiDB Cloud Starter, the Datadog integration is not available.
+> For TiDB Cloud Essential, see [Integrate TiDB Cloud Essential with Datadog](https://docs.pingcap.com/tidbcloud/monitor-datadog-integration-for-tidb-x/?plan=essential).
+> For TiDB Cloud Premium, see [Integrate TiDB Cloud Premium with Datadog](https://docs.pingcap.com/tidbcloud/monitor-datadog-integration-for-tidb-x/?plan=premium).
+
## Datadog integration version
TiDB Cloud has supported the project-level Datadog integration (Beta) since March 4, 2022. Starting from July 31, 2025, TiDB Cloud introduces the cluster-level Datadog integration (Preview). Starting from September 30, 2025, the cluster-level Datadog integration becomes generally available (GA).
@@ -24,7 +32,7 @@ TiDB Cloud has supported the project-level Datadog integration (Beta) since Marc
## Limitation
-- Datadog integrations are now only available for [TiDB Cloud Dedicated](/tidb-cloud/select-cluster-tier.md#tidb-cloud-dedicated) clusters.
+- Datadog integration is not available for [TiDB Cloud Starter](/tidb-cloud/select-cluster-tier.md#starter) instances.
- Datadog integrations are not available when the cluster status is **CREATING**, **RESTORING**, **PAUSED**, or **RESUMING**.
From 4b7c834aad641afedaf5cd997833eda2b9c9b7a9 Mon Sep 17 00:00:00 2001
From: qiancai
Date: Tue, 7 Jul 2026 19:08:25 +0800
Subject: [PATCH 6/8] Update features.md
---
tidb-cloud/features.md | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)
diff --git a/tidb-cloud/features.md b/tidb-cloud/features.md
index 2b95e395d09c8..f5d09348aff28 100644
--- a/tidb-cloud/features.md
+++ b/tidb-cloud/features.md
@@ -238,8 +238,8 @@ This document lists the feature support status for different TiDB Cloud plans, i
| Datadog integration |
❌ |
- ❌ |
- ❌ |
+ ✅
(Public preview) |
+ ✅
(Public preview) |
✅ |
From 26d0510a133f3a850b3fb919f257d19409252089 Mon Sep 17 00:00:00 2001
From: qiancai
Date: Tue, 7 Jul 2026 19:22:11 +0800
Subject: [PATCH 7/8] add toc changes
---
TOC-tidb-cloud-essential.md | 2 ++
TOC-tidb-cloud-premium.md | 2 ++
tidb-cloud/monitoring-concepts.md | 12 ++++++++++++
3 files changed, 16 insertions(+)
diff --git a/TOC-tidb-cloud-essential.md b/TOC-tidb-cloud-essential.md
index 3e4d56f6abba5..9ef655fadd5b9 100644
--- a/TOC-tidb-cloud-essential.md
+++ b/TOC-tidb-cloud-essential.md
@@ -65,6 +65,7 @@
- [Subscribe via Slack](/tidb-cloud/monitor-alert-slack.md)
- [Subscribe via Zoom](/tidb-cloud/monitor-alert-zoom.md)
- [Events](/tidb-cloud/tidb-cloud-events.md)
+ - [Integrate TiDB Cloud with Datadog](/tidb-cloud/monitor-datadog-integration-for-tidb-x.md)
- Tune Performance
- [Overview](/tidb-cloud/tidb-cloud-tune-performance-overview.md)
- [Analyze Performance](/tidb-cloud/tune-performance.md)
@@ -180,6 +181,7 @@
- Integrations
- [Airbyte](/tidb-cloud/integrate-tidbcloud-with-airbyte.md)
- [Cloudflare](/tidb-cloud/integrate-tidbcloud-with-cloudflare.md)
+ - [Datadog](/tidb-cloud/monitor-datadog-integration-for-tidb-x.md)
- [dbt](/tidb-cloud/integrate-tidbcloud-with-dbt.md)
- [Gitpod](/develop/dev-guide-playground-gitpod.md)
- [n8n](/tidb-cloud/integrate-tidbcloud-with-n8n.md)
diff --git a/TOC-tidb-cloud-premium.md b/TOC-tidb-cloud-premium.md
index b5663e5c9a62d..99403f6f0d0a9 100644
--- a/TOC-tidb-cloud-premium.md
+++ b/TOC-tidb-cloud-premium.md
@@ -59,6 +59,7 @@
- [Subscribe via Email](/tidb-cloud/monitor-alert-email.md)
- [Subscribe via Slack](/tidb-cloud/monitor-alert-slack.md)
- [Subscribe via Zoom](/tidb-cloud/monitor-alert-zoom.md)
+ - [Integrate TiDB Cloud with Datadog](/tidb-cloud/monitor-datadog-integration-for-tidb-x.md)
- Tune Performance
- [Overview](/tidb-cloud/tidb-cloud-tune-performance-overview.md)
- [Analyze Performance](/tidb-cloud/tune-performance.md)
@@ -169,6 +170,7 @@
- Integrations
- [Airbyte](/tidb-cloud/integrate-tidbcloud-with-airbyte.md)
- [Cloudflare](/tidb-cloud/integrate-tidbcloud-with-cloudflare.md)
+ - [Datadog](/tidb-cloud/monitor-datadog-integration-for-tidb-x.md)
- [dbt](/tidb-cloud/integrate-tidbcloud-with-dbt.md)
- [Gitpod](/develop/dev-guide-playground-gitpod.md)
- [n8n](/tidb-cloud/integrate-tidbcloud-with-n8n.md)
diff --git a/tidb-cloud/monitoring-concepts.md b/tidb-cloud/monitoring-concepts.md
index 0851e15a2be71..0fea775382650 100644
--- a/tidb-cloud/monitoring-concepts.md
+++ b/tidb-cloud/monitoring-concepts.md
@@ -47,6 +47,8 @@ You can view the logged events on the **Events** page, including the event type,
For more information, see [Events](/tidb-cloud/tidb-cloud-events.md).
+
+
## Third-party metrics integrations
TiDB Cloud lets you integrate any of the following third-party metrics services to receive TiDB Cloud alerts and view the performance metrics of your TiDB Cloud Dedicated cluster.
@@ -56,3 +58,13 @@ TiDB Cloud lets you integrate any of the following third-party metrics services
- [Prometheus and Grafana integration](/tidb-cloud/monitor-prometheus-and-grafana-integration.md)
- [New Relic integration](/tidb-cloud/monitor-new-relic-integration.md)
+
+
+
+
+
+## Datadog integration
+
+TiDB Cloud lets you integrate Datadog to receive TiDB Cloud alerts and view the performance metrics of your target instance. For more information, see [Integrate TiDB Cloud with Datadog](/tidb-cloud/monitor-datadog-integration-for-tidb-x.md).
+
+
From a37af4c9f4d0c4ba0420e5ca48f40fa636d98efe Mon Sep 17 00:00:00 2001
From: qiancai
Date: Tue, 7 Jul 2026 19:38:39 +0800
Subject: [PATCH 8/8] minor wording updates
---
.../monitor-datadog-integration-for-tidb-x.md | 30 +++++++++----------
tidb-cloud/monitor-datadog-integration.md | 6 ++--
2 files changed, 18 insertions(+), 18 deletions(-)
diff --git a/tidb-cloud/monitor-datadog-integration-for-tidb-x.md b/tidb-cloud/monitor-datadog-integration-for-tidb-x.md
index 9e38aca678be9..32d1f9b9cfad0 100644
--- a/tidb-cloud/monitor-datadog-integration-for-tidb-x.md
+++ b/tidb-cloud/monitor-datadog-integration-for-tidb-x.md
@@ -5,7 +5,7 @@ summary: Learn how to monitor your TiDB Cloud instances with the Datadog integra
# Integrate TiDB Cloud with Datadog (Preview)
-TiDB Cloud supports Datadog integration. You can configure TiDB Cloud to send metrics about your {{{ .essential }}}{{{ .premium }}} instances to [Datadog](https://www.datadoghq.com/). After that, you can view these metrics in your Datadog dashboards directly.
+TiDB Cloud supports integration with Datadog. You can configure TiDB Cloud to send metrics for your {{{ .essential }}}{{{ .premium }}} instances to [Datadog](https://www.datadoghq.com/). After that, you can view these metrics in your Datadog dashboards directly.
## Prerequisites
@@ -13,9 +13,9 @@ TiDB Cloud supports Datadog integration. You can configure TiDB Cloud to send me
If you do not have a Datadog account, sign up at [https://app.datadoghq.com/signup](https://app.datadoghq.com/signup).
-- To set up third-party metrics integration for TiDB Cloud, you must have the `Organization Owner`, `Project Owner` or `Instance Manager` access in TiDB Cloud. To view the integration page, you need at least the `Project Viewer` or `Instance Viewer` role to access the target {{{ .essential }}}{{{ .premium }}} instance under your Organization in TiDB Cloud.
+- To set up third-party metrics integration for TiDB Cloud, you must have the `Organization Owner`, `Project Owner`, or `Instance Manager` access in TiDB Cloud. To view the integration page, you need at least the `Project Viewer` or `Instance Viewer` role to access the target {{{ .essential }}}{{{ .premium }}} instance under your organization in TiDB Cloud.
-## Limitation
+## Limitations
- Datadog integration is not available for [TiDB Cloud Starter](/tidb-cloud/select-cluster-tier.md#starter) instances.
- Datadog integration is not available when the status of your {{{ .essential }}}{{{ .premium }}} instance is **CREATING**, **RESTORING**, **PAUSED**, or **RESUMING**.
@@ -50,12 +50,12 @@ Currently, the TiDB Cloud dashboard for {{{ .ess
6. Click **Yes, Replace** to confirm the import.
-### Step 2. Integrate with your Datadog API Key
+### Step 2. Integrate with your Datadog API key
1. In the [TiDB Cloud console](https://tidbcloud.com/), navigate to the [**My TiDB**](https://tidbcloud.com/tidbs) page, and then click the name of your target {{{ .essential }}} instance to go to its overview page.
-2. In the left navigation pane, click **Integrations** > **Integration to Datadog(Preview)**.
+2. In the left navigation pane, click **Integrations** > **Integration to Datadog (Preview)**.
3. Enter your Datadog API key and choose your Datadog Region.
4. Click **Test Integration**.
@@ -69,7 +69,7 @@ Currently, the TiDB Cloud dashboard for {{{ .ess
1. In the [TiDB Cloud console](https://tidbcloud.com/), navigate to the [**My TiDB**](https://tidbcloud.com/tidbs) page, and then click the name of your target {{{ .premium }}} instance to go to its overview page.
-2. In the left navigation pane, click **Settings** > **Integrations** > **Integration to Datadog(Preview)**.
+2. In the left navigation pane, click **Settings** > **Integrations** > **Integration to Datadog (Preview)**.
3. Enter your Datadog API key and choose your Datadog Region.
4. Click **Test Integration**.
@@ -82,9 +82,9 @@ Currently, the TiDB Cloud dashboard for {{{ .ess
## View the pre-built dashboard
-To view the pre-built dashboard after the integration, go to **Dashboards** > **Dashboard List** in [Datadog](https://app.datadoghq.com), and then select the dashboard imported in [Step 1](#step-1-import-the-pre-built-datadog-dashboard). On the dashboard page, you can filter by your target instance name, and view the metrics.
+To view the pre-built dashboard after the integration, go to **Dashboards** > **Dashboard List** in [Datadog](https://app.datadoghq.com), and then select the dashboard imported in [Step 1](#step-1-import-the-pre-built-datadog-dashboard). On the dashboard page, you can filter by your target instance name and view the metrics.
-You can also access the **Dashboard List** page of Datadog from the [TiDB Cloud console](https://tidbcloud.com/): go to the **Integrations** page of your target instance, click **Datadog(Preview)**, and then click **Dashboard**.
+You can also access the **Dashboard List** page in Datadog from the [TiDB Cloud console](https://tidbcloud.com/): go to the **Integrations** page of your target instance, click **Datadog (Preview)**, and then click **Dashboard**.
## Metrics available to Datadog
@@ -94,7 +94,7 @@ Datadog tracks the following metrics for your {{
> **Note:**
>
-> Currently, the changefeed feature for {{{ .premium }}} is only available upon request, and the `tidb_cloud.changefeed_*` metrics are currently not available.
+> Currently, the changefeed feature for {{{ .essential }}} is only available upon request, and the `tidb_cloud.changefeed_*` metrics are not available.
| Metric name | Metric type | Labels | Description |
|:--- |:--- |:--- |:--- |
@@ -103,10 +103,10 @@ Datadog tracks the following metrics for your {{
| `tidb_cloud.db_disconnections` | gauge | `result: Error\|...`
`instance_id: `
`instance_name: ` | The number of clients disconnected by connection result |
| `tidb_cloud.db_database_time` | gauge | `sql_type: Select\|Insert\|...`
`instance_id: `
`instance_name: ` | The total time consumed by all SQL statements running in TiDB per second, including the CPU time of all processes and the non-idle waiting time |
| `tidb_cloud.db_query_per_second` | gauge | `type: Select\|Insert\|...`
`instance_id: `
`instance_name: ` | The number of SQL statements executed per second, counted according to statement types |
-| `tidb_cloud.db_failed_queries` | gauge | `type: planner:xxx\|executor:2345\|...`
`instance_id: `
`instance_name: ` | The statistics of error types (for example, syntax errors, primary key conflicts) occurred when executing SQL statements per second |
+| `tidb_cloud.db_failed_queries` | gauge | `type: planner:xxx\|executor:2345\|...`
`instance_id: `
`instance_name: ` | The statistics of error types (such as syntax errors and primary key conflicts) that occur per second when executing SQL statements |
| `tidb_cloud.db_command_per_second` | gauge | `type: Query\|Ping\|...`
`instance_id: `
`instance_name: ` | The number of commands processed by TiDB per second |
-| `tidb_cloud.db_queries_using_plan_cache_ops` | gauge | `instance_id: `
`instance_name: ` | The statistics of queries hitting the Execution Plan Cache per second |
-| `tidb_cloud.db_average_query_duration` | gauge | `sql_type: Select\|Insert\|...`
`instance_id: `
`instance_name: ` | The duration between the time a network request is sent to TiDB and returned to the client |
+| `tidb_cloud.db_queries_using_plan_cache_ops` | gauge | `instance_id: `
`instance_name: ` | The number of queries that hit the execution plan cache per second |
+| `tidb_cloud.db_average_query_duration` | gauge | `sql_type: Select\|Insert\|...`
`instance_id: `
`instance_name: ` | The duration between the time a network request is sent to TiDB and the time a response is returned to the client |
| `tidb_cloud.db_transaction_per_second` | gauge | `type: Commit\|Rollback\|...`
`txn_mode: optimistic\|pessimistic`
`instance_id: `
`instance_name: ` | The number of transactions executed per second |
| `tidb_cloud.db_row_storage_used_bytes` | gauge | `instance_id: `
`instance_name: ` | The row-based storage size of the {{{ .essential }}} instance in bytes |
| `tidb_cloud.db_columnar_storage_used_bytes` | gauge | `instance_id: `
`instance_name: ` | The columnar storage size of the {{{ .essential }}} instance in bytes. Returns 0 if TiFlash is not enabled. |
@@ -123,10 +123,10 @@ Datadog tracks the following metrics for your {{
| `tidb_cloud.db_disconnections` | gauge | `result: Error\|...`
`instance_id: `
`instance_name: ` | The number of clients disconnected by connection result |
| `tidb_cloud.db_database_time` | gauge | `sql_type: Select\|Insert\|...`
`instance_id: `
`instance_name: ` | The total time consumed by all SQL statements running in TiDB per second, including the CPU time of all processes and the non-idle waiting time |
| `tidb_cloud.db_query_per_second` | gauge | `type: Select\|Insert\|...`
`instance_id: `
`instance_name: ` | The number of SQL statements executed per second, counted according to statement types |
-| `tidb_cloud.db_failed_queries` | gauge | `type: planner:xxx\|executor:2345\|...`
`instance_id: `
`instance_name: ` | The statistics of error types (for example, syntax errors, primary key conflicts) occurred when executing SQL statements per second |
+| `tidb_cloud.db_failed_queries` | gauge | `type: planner:xxx\|executor:2345\|...`
`instance_id: `
`instance_name: ` | The statistics of error types (such as syntax errors and primary key conflicts) that occur per second when executing SQL statements |
| `tidb_cloud.db_command_per_second` | gauge | `type: Query\|Ping\|...`
`instance_id: `
`instance_name: ` | The number of commands processed by TiDB per second |
-| `tidb_cloud.db_queries_using_plan_cache_ops` | gauge | `instance_id: `
`instance_name: ` | The statistics of queries hitting the Execution Plan Cache per second |
-| `tidb_cloud.db_average_query_duration` | gauge | `sql_type: Select\|Insert\|...`
`instance_id: `
`instance_name: ` | The duration between the time a network request is sent to TiDB and returned to the client |
+| `tidb_cloud.db_queries_using_plan_cache_ops` | gauge | `instance_id: `
`instance_name: ` | The number of queries that hit the execution plan cache per second |
+| `tidb_cloud.db_average_query_duration` | gauge | `sql_type: Select\|Insert\|...`
`instance_id: `
`instance_name: ` | The duration between the time a network request is sent to TiDB and the time a response is returned to the client |
| `tidb_cloud.db_transaction_per_second` | gauge | `type: Commit\|Rollback\|...`
`txn_mode: optimistic\|pessimistic`
`instance_id: `
`instance_name: ` | The number of transactions executed per second |
| `tidb_cloud.db_row_storage_used_bytes` | gauge | `instance_id: `
`instance_name: ` | The row-based storage size of the {{{ .premium }}} instance in bytes |
| `tidb_cloud.db_columnar_storage_used_bytes` | gauge | `instance_id: `
`instance_name: ` | The columnar storage size of the {{{ .premium }}} instance in bytes |
diff --git a/tidb-cloud/monitor-datadog-integration.md b/tidb-cloud/monitor-datadog-integration.md
index 7db54f693e894..cf3327e94e5db 100644
--- a/tidb-cloud/monitor-datadog-integration.md
+++ b/tidb-cloud/monitor-datadog-integration.md
@@ -5,7 +5,7 @@ summary: Learn how to monitor your TiDB cluster with the Datadog integration.
# Integrate TiDB Cloud with Datadog
-TiDB Cloud supports Datadog integration. You can configure TiDB Cloud to send metrics about your TiDB clusters to [Datadog](https://www.datadoghq.com/). After that, you can view these metrics in your Datadog dashboards directly.
+TiDB Cloud supports integration with Datadog. You can configure TiDB Cloud to send metrics for your TiDB clusters to [Datadog](https://www.datadoghq.com/). After that, you can view these metrics in your Datadog dashboards directly.
> **Note:**
>
@@ -30,7 +30,7 @@ TiDB Cloud has supported the project-level Datadog integration (Beta) since Marc
- To set up third-party metrics integration for TiDB Cloud, you must have the `Organization Owner` or `Project Owner` access in TiDB Cloud. To view the integration page or access configured dashboards via the provided links, you need at least the `Project Viewer` role to access the target TiDB Cloud Dedicated clusters under your project in TiDB Cloud.
-## Limitation
+## Limitations
- Datadog integration is not available for [TiDB Cloud Starter](/tidb-cloud/select-cluster-tier.md#starter) instances.
@@ -40,7 +40,7 @@ TiDB Cloud has supported the project-level Datadog integration (Beta) since Marc
## Steps
-### Step 1. Integrate with your Datadog API Key
+### Step 1. Integrate with your Datadog API key
Depending on your [Datadog integration version](#datadog-integration-version), the steps to access the integration page are different.