From edf9b3c8abda5de6ae445686939846a06cfebc4d Mon Sep 17 00:00:00 2001 From: huoyao1125 <90880576+huoyao1125@users.noreply.github.com> Date: Wed, 15 Oct 2025 10:24:42 +0800 Subject: [PATCH 01/26] Update monitor-prometheus-and-grafana-integration.md --- tidb-cloud/monitor-prometheus-and-grafana-integration.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/tidb-cloud/monitor-prometheus-and-grafana-integration.md b/tidb-cloud/monitor-prometheus-and-grafana-integration.md index 9f1643bdbd01e..e2bbd1df708b0 100644 --- a/tidb-cloud/monitor-prometheus-and-grafana-integration.md +++ b/tidb-cloud/monitor-prometheus-and-grafana-integration.md @@ -1,9 +1,9 @@ --- -title: Integrate TiDB Cloud with Prometheus and Grafana (Beta) +title: Integrate TiDB Cloud with Prometheus and Grafana summary: Learn how to monitor your TiDB cluster with the Prometheus and Grafana integration. --- -# Integrate TiDB Cloud with Prometheus and Grafana (Beta) +# Integrate TiDB Cloud with Prometheus and Grafana TiDB Cloud provides a [Prometheus](https://prometheus.io/) API endpoint (beta). If you have a Prometheus service, you can monitor key metrics of TiDB Cloud from the endpoint easily. From 1a75c2c51d3c91c83e8916e26834df01eedbf9ae Mon Sep 17 00:00:00 2001 From: huoyao1125 <90880576+huoyao1125@users.noreply.github.com> Date: Wed, 15 Oct 2025 11:13:39 +0800 Subject: [PATCH 02/26] Update monitor-prometheus-and-grafana-integration.md --- .../monitor-prometheus-and-grafana-integration.md | 11 +++++++++-- 1 file changed, 9 insertions(+), 2 deletions(-) diff --git a/tidb-cloud/monitor-prometheus-and-grafana-integration.md b/tidb-cloud/monitor-prometheus-and-grafana-integration.md index e2bbd1df708b0..b7f93522de2b9 100644 --- a/tidb-cloud/monitor-prometheus-and-grafana-integration.md +++ b/tidb-cloud/monitor-prometheus-and-grafana-integration.md @@ -1,14 +1,21 @@ ---- +image--- title: Integrate TiDB Cloud with Prometheus and Grafana summary: Learn how to monitor your TiDB cluster with the Prometheus and Grafana integration. --- # Integrate TiDB Cloud with Prometheus and Grafana -TiDB Cloud provides a [Prometheus](https://prometheus.io/) API endpoint (beta). If you have a Prometheus service, you can monitor key metrics of TiDB Cloud from the endpoint easily. +TiDB Cloud provides a [Prometheus](https://prometheus.io/) API endpoint. If you have a Prometheus service, you can monitor key metrics of TiDB Cloud from the endpoint easily. This document describes how to configure your Prometheus service to read key metrics from the TiDB Cloud endpoint and how to view the metrics using [Grafana](https://grafana.com/). +## Prometheus integration version + +TiDB Cloud has supported the project-level Prometheus integration (Beta) since March 4, 2022(?please help update the date). Starting from October 21, 2025, TiDB Cloud introduces the cluster-level Prometheus integration (Preview). + +- **Cluster-level Prometheus integration (Preview)**: if no legacy project-level Prometheus integration remains undeleted within your organization by October 21, 2025, TiDB Cloud provides the cluster-level Prometheus integration (Preview) for your organization to experience the latest enhancements. +- **Legacy project-level Prometheus integration (Beta)**: if at least one legacy project-level Prometheus integration remains undeleted within your organization by October 21, 2025, TiDB Cloud retains both existing and new integrations at the project level for your organization to avoid affecting current dashboards. + ## Prerequisites - To integrate TiDB Cloud with Prometheus, you must have a self-hosted or managed Prometheus service. From d3f3e7d29ae1cfadc6a1efa1da3bdfcc86e5e61e Mon Sep 17 00:00:00 2001 From: huoyao1125 <90880576+huoyao1125@users.noreply.github.com> Date: Wed, 15 Oct 2025 11:29:29 +0800 Subject: [PATCH 03/26] Update monitor-prometheus-and-grafana-integration.md --- ...itor-prometheus-and-grafana-integration.md | 20 ++++++++++++++++--- 1 file changed, 17 insertions(+), 3 deletions(-) diff --git a/tidb-cloud/monitor-prometheus-and-grafana-integration.md b/tidb-cloud/monitor-prometheus-and-grafana-integration.md index b7f93522de2b9..643cada7013f1 100644 --- a/tidb-cloud/monitor-prometheus-and-grafana-integration.md +++ b/tidb-cloud/monitor-prometheus-and-grafana-integration.md @@ -32,17 +32,31 @@ TiDB Cloud has supported the project-level Prometheus integration (Beta) since M ### Step 1. Get a scrape_config file for Prometheus -Before configuring your Prometheus service to read metrics of TiDB Cloud, you need to generate a `scrape_config` YAML file in TiDB Cloud first. The `scrape_config` file contains a unique bearer token that allows the Prometheus service to monitor any database clusters in the current project. +Before configuring your Prometheus service to read metrics of TiDB Cloud, you need to generate a `scrape_config` YAML file in TiDB Cloud first. The `scrape_config` file contains a unique bearer token that allows the Prometheus service to monitor your target database clusters. -To get the `scrape_config` file for Prometheus, do the following: +Depending on your [Prometheus integration version](#prometheus-integration-version), the steps to get the `scrape_config` file for Prometheus and access the integration page are different. + + +
+ +1. In the [TiDB Cloud console](https://tidbcloud.com/), navigate to the [**Clusters**](https://tidbcloud.com/project/clusters) page of your project, and then click the name of your target cluster to go to its overview page. +2. In the left navigation pane, click **Settings** > **Integrations**. +3. On the **Integrations** page, click **Integration to Prometheus(Preview)**. +4. Click **Add File** to generate and show the scrape_config file for the current cluster. +5. Make a copy of the scrape_config file content for later use. + +
+
1. In the [TiDB Cloud console](https://tidbcloud.com), switch to your target project using the combo box in the upper-left corner. 2. In the left navigation pane, click **Project Settings** > **Integrations**. 3. On the **Integrations** page, click **Integration to Prometheus (BETA)**. 4. Click **Add File** to generate and show the scrape_config file for the current project. - 5. Make a copy of the `scrape_config` file content for later use. +
+ + > **Note:** > > For security reasons, TiDB Cloud only shows a newly generated `scrape_config` file once. Ensure that you copy the content before closing the file window. If you forget to do so, you need to delete the `scrape_config` file in TiDB Cloud and generate a new one. To delete a `scrape_config` file, select the file, click **...**, and then click **Delete**. From 21290d085cc62d0a4ce6aaf90ff2f374635bb454 Mon Sep 17 00:00:00 2001 From: jinshayumi <791682161@QQ.COM> Date: Fri, 17 Oct 2025 16:33:55 +0800 Subject: [PATCH 04/26] Revise Grafana dashboard links and add DM metrics Updated Grafana dashboard download links for different project levels and added new metrics related to Data Migration. --- tidb-cloud/monitor-prometheus-and-grafana-integration.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/tidb-cloud/monitor-prometheus-and-grafana-integration.md b/tidb-cloud/monitor-prometheus-and-grafana-integration.md index 643cada7013f1..94c9a69e7bdc6 100644 --- a/tidb-cloud/monitor-prometheus-and-grafana-integration.md +++ b/tidb-cloud/monitor-prometheus-and-grafana-integration.md @@ -75,7 +75,7 @@ Depending on your [Prometheus integration version](#prometheus-integration-versi After your Prometheus service is reading metrics from TiDB Cloud, you can use Grafana GUI dashboards to visualize the metrics as follows: -1. Download the Grafana dashboard JSON of TiDB Cloud [here](https://github.com/pingcap/docs/blob/master/tidb-cloud/monitor-prometheus-and-grafana-integration-grafana-dashboard-UI.json). +1. For legacy Project-level, download the Grafana dashboard JSON of TiDB Cloud [here](https://github.com/pingcap/docs/blob/master/tidb-cloud/monitor-prometheus-and-grafana-integration-grafana-dashboard-UI.json). For Cluster-level, download the Grafana dashboard JSON of TiDB Cloud [here](https://github.com/pingcap/docs/blob/master/tidb-cloud/monitor-prometheus-and-grafana-integration-tidb-cloud-dynamic-tracker.json). 2. [Import this JSON to your own Grafana GUI](https://grafana.com/docs/grafana/v8.5/dashboards/export-import/#import-dashboard) to visualize the metrics. @@ -124,6 +124,10 @@ Prometheus tracks the following metric data for your TiDB clusters. | tidbcloud_changefeed_status | gauge | changefeed_id: ``
cluster_name: `` | Changefeed status:
`-1`: Unknown
`0`: Normal
`1`: Warning
`2`: Failed
`3`: Stopped
`4`: Finished
`6`: Warning
`7`: Other | | tidbcloud_resource_manager_resource_unit_read_request_unit | gauge | cluster_name: ``
resource_group: `` | The read request units consumed by Resource Manager | | tidbcloud_resource_manager_resource_unit_write_request_unit | gauge | cluster_name: ``
resource_group: `` | The write request units consumed by Resource Manager | +| tidbcloud_dm_task_status | gauge | instance: `instance`
task: `task`
cluster_name: `` | Task State of Data Migration:
0: Invalid
1: New
2: Running
3: Paused
4: Stopped
5: Finished
15: Error | +| tidbcloud_dm_syncer_replication_lag_bucket | gauge | instance: `instance`
cluster_name: `` | Replicate lag (bucket) of Data Migration. | +| tidbcloud_dm_syncer_replication_lag_gauge | gauge | instance: `instance`
task: `task`
cluster_name: `` | Replicate lag (gauge) of Data Migration. | +| tidbcloud_dm_relay_read_error_count | gauge | instance: `instance`
cluster_name: `` | Fail to read binlog from master. | ## FAQ From 8de917546ffb7eb8bc75003413471b39035d5c6d Mon Sep 17 00:00:00 2001 From: huoyao1125 <90880576+huoyao1125@users.noreply.github.com> Date: Fri, 17 Oct 2025 17:38:56 +0800 Subject: [PATCH 05/26] Update monitor-prometheus-and-grafana-integration.md --- tidb-cloud/monitor-prometheus-and-grafana-integration.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/tidb-cloud/monitor-prometheus-and-grafana-integration.md b/tidb-cloud/monitor-prometheus-and-grafana-integration.md index 643cada7013f1..d77313ae253c6 100644 --- a/tidb-cloud/monitor-prometheus-and-grafana-integration.md +++ b/tidb-cloud/monitor-prometheus-and-grafana-integration.md @@ -13,7 +13,7 @@ This document describes how to configure your Prometheus service to read key met TiDB Cloud has supported the project-level Prometheus integration (Beta) since March 4, 2022(?please help update the date). Starting from October 21, 2025, TiDB Cloud introduces the cluster-level Prometheus integration (Preview). -- **Cluster-level Prometheus integration (Preview)**: if no legacy project-level Prometheus integration remains undeleted within your organization by October 21, 2025, TiDB Cloud provides the cluster-level Prometheus integration (Preview) for your organization to experience the latest enhancements. +- **Cluster-level Prometheus integration (Preview)**: if no legacy project-level Prometheus integration remains undeleted within your organization by October 21, 2025, TiDB Cloud provides the cluster-level Prometheus integration (Preview) for your organization to experience the latest enhancements. This feature is currently available for Dedicated clusters on AWS and GCP, and we are working to bring it to Azure in the near future. - **Legacy project-level Prometheus integration (Beta)**: if at least one legacy project-level Prometheus integration remains undeleted within your organization by October 21, 2025, TiDB Cloud retains both existing and new integrations at the project level for your organization to avoid affecting current dashboards. ## Prerequisites From 1afb1adf605a02796a5b3f0ecb3dcb79e831e8d5 Mon Sep 17 00:00:00 2001 From: huoyao1125 <90880576+huoyao1125@users.noreply.github.com> Date: Fri, 17 Oct 2025 17:43:15 +0800 Subject: [PATCH 06/26] Update tidb-cloud/monitor-prometheus-and-grafana-integration.md Co-authored-by: Grace Cai --- tidb-cloud/monitor-prometheus-and-grafana-integration.md | 1 - 1 file changed, 1 deletion(-) diff --git a/tidb-cloud/monitor-prometheus-and-grafana-integration.md b/tidb-cloud/monitor-prometheus-and-grafana-integration.md index d77313ae253c6..375923c0a4169 100644 --- a/tidb-cloud/monitor-prometheus-and-grafana-integration.md +++ b/tidb-cloud/monitor-prometheus-and-grafana-integration.md @@ -1,4 +1,3 @@ -image--- title: Integrate TiDB Cloud with Prometheus and Grafana summary: Learn how to monitor your TiDB cluster with the Prometheus and Grafana integration. --- From 4fa00f995e1ae323dbfe0efe0ae7189100f7fb64 Mon Sep 17 00:00:00 2001 From: huoyao1125 <90880576+huoyao1125@users.noreply.github.com> Date: Fri, 17 Oct 2025 17:55:00 +0800 Subject: [PATCH 07/26] Update monitor-prometheus-and-grafana-integration.md --- ...itor-prometheus-and-grafana-integration.md | 20 +++++++++++++++++-- 1 file changed, 18 insertions(+), 2 deletions(-) diff --git a/tidb-cloud/monitor-prometheus-and-grafana-integration.md b/tidb-cloud/monitor-prometheus-and-grafana-integration.md index 3ca97059ae04b..3b50cf8029938 100644 --- a/tidb-cloud/monitor-prometheus-and-grafana-integration.md +++ b/tidb-cloud/monitor-prometheus-and-grafana-integration.md @@ -74,7 +74,20 @@ Depending on your [Prometheus integration version](#prometheus-integration-versi After your Prometheus service is reading metrics from TiDB Cloud, you can use Grafana GUI dashboards to visualize the metrics as follows: -1. For legacy Project-level, download the Grafana dashboard JSON of TiDB Cloud [here](https://github.com/pingcap/docs/blob/master/tidb-cloud/monitor-prometheus-and-grafana-integration-grafana-dashboard-UI.json). For Cluster-level, download the Grafana dashboard JSON of TiDB Cloud [here](https://github.com/pingcap/docs/blob/master/tidb-cloud/monitor-prometheus-and-grafana-integration-tidb-cloud-dynamic-tracker.json). +1. Depending on your [Prometheus integration version](#prometheus-integration-version), the link to download the Grafana dashboard JSON of TiDB Cloud for Prometheus is different. + + +
+ +Please download the Grafana dashboard JSON of TiDB Cloud [here](https://github.com/pingcap/docs/blob/master/tidb-cloud/monitor-prometheus-and-grafana-integration-tidb-cloud-dynamic-tracker.json). + +
+
+ +Please download the Grafana dashboard JSON of TiDB Cloud [here](https://github.com/pingcap/docs/blob/master/tidb-cloud/monitor-prometheus-and-grafana-integration-grafana-dashboard-UI.json). + +
+ 2. [Import this JSON to your own Grafana GUI](https://grafana.com/docs/grafana/v8.5/dashboards/export-import/#import-dashboard) to visualize the metrics. @@ -93,7 +106,7 @@ To improve data security, it is a general best practice to periodically rotate ` 1. Follow [Step 1](#step-1-get-a-scrape_config-file-for-prometheus) to create a new `scrape_config` file for Prometheus. 2. Add the content of the new file to your Prometheus configuration file. 3. Once you have confirmed that your Prometheus service is still able to read from TiDB Cloud, remove the content of the old `scrape_config` file from your Prometheus configuration file. -4. On the **Integrations** page of your project, delete the corresponding old `scrape_config` file to block anyone else from using it to read from the TiDB Cloud Prometheus endpoint. +4. On the **Integrations** page of your project/cluster, delete the corresponding old `scrape_config` file to block anyone else from using it to read from the TiDB Cloud Prometheus endpoint. ## Metrics available to Prometheus @@ -123,6 +136,9 @@ Prometheus tracks the following metric data for your TiDB clusters. | tidbcloud_changefeed_status | gauge | changefeed_id: ``
cluster_name: `` | Changefeed status:
`-1`: Unknown
`0`: Normal
`1`: Warning
`2`: Failed
`3`: Stopped
`4`: Finished
`6`: Warning
`7`: Other | | tidbcloud_resource_manager_resource_unit_read_request_unit | gauge | cluster_name: ``
resource_group: `` | The read request units consumed by Resource Manager | | tidbcloud_resource_manager_resource_unit_write_request_unit | gauge | cluster_name: ``
resource_group: `` | The write request units consumed by Resource Manager | + +For cluster-level Prometheus integration, the following additional metrics are also available: + | tidbcloud_dm_task_status | gauge | instance: `instance`
task: `task`
cluster_name: `` | Task State of Data Migration:
0: Invalid
1: New
2: Running
3: Paused
4: Stopped
5: Finished
15: Error | | tidbcloud_dm_syncer_replication_lag_bucket | gauge | instance: `instance`
cluster_name: `` | Replicate lag (bucket) of Data Migration. | | tidbcloud_dm_syncer_replication_lag_gauge | gauge | instance: `instance`
task: `task`
cluster_name: `` | Replicate lag (gauge) of Data Migration. | From 8c8f77d37a83721bde29917c50b2da53f0a7c290 Mon Sep 17 00:00:00 2001 From: huoyao1125 <90880576+huoyao1125@users.noreply.github.com> Date: Mon, 20 Oct 2025 18:56:42 +0800 Subject: [PATCH 08/26] Update tidb-cloud/monitor-prometheus-and-grafana-integration.md Co-authored-by: Grace Cai --- tidb-cloud/monitor-prometheus-and-grafana-integration.md | 1 + 1 file changed, 1 insertion(+) diff --git a/tidb-cloud/monitor-prometheus-and-grafana-integration.md b/tidb-cloud/monitor-prometheus-and-grafana-integration.md index 3b50cf8029938..bcc33f2dea803 100644 --- a/tidb-cloud/monitor-prometheus-and-grafana-integration.md +++ b/tidb-cloud/monitor-prometheus-and-grafana-integration.md @@ -1,3 +1,4 @@ +--- title: Integrate TiDB Cloud with Prometheus and Grafana summary: Learn how to monitor your TiDB cluster with the Prometheus and Grafana integration. --- From b652e2b15cdb52e90130b8af9696b78418245b7a Mon Sep 17 00:00:00 2001 From: huoyao1125 <90880576+huoyao1125@users.noreply.github.com> Date: Mon, 20 Oct 2025 18:57:10 +0800 Subject: [PATCH 09/26] Update tidb-cloud/monitor-prometheus-and-grafana-integration.md Co-authored-by: Grace Cai --- tidb-cloud/monitor-prometheus-and-grafana-integration.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/tidb-cloud/monitor-prometheus-and-grafana-integration.md b/tidb-cloud/monitor-prometheus-and-grafana-integration.md index bcc33f2dea803..dcae204a23a6c 100644 --- a/tidb-cloud/monitor-prometheus-and-grafana-integration.md +++ b/tidb-cloud/monitor-prometheus-and-grafana-integration.md @@ -11,7 +11,7 @@ This document describes how to configure your Prometheus service to read key met ## Prometheus integration version -TiDB Cloud has supported the project-level Prometheus integration (Beta) since March 4, 2022(?please help update the date). Starting from October 21, 2025, TiDB Cloud introduces the cluster-level Prometheus integration (Preview). +TiDB Cloud has supported the project-level Prometheus integration (Beta) since March 15, 2022. Starting from October 21, 2025, TiDB Cloud introduces the cluster-level Prometheus integration (Preview). - **Cluster-level Prometheus integration (Preview)**: if no legacy project-level Prometheus integration remains undeleted within your organization by October 21, 2025, TiDB Cloud provides the cluster-level Prometheus integration (Preview) for your organization to experience the latest enhancements. This feature is currently available for Dedicated clusters on AWS and GCP, and we are working to bring it to Azure in the near future. - **Legacy project-level Prometheus integration (Beta)**: if at least one legacy project-level Prometheus integration remains undeleted within your organization by October 21, 2025, TiDB Cloud retains both existing and new integrations at the project level for your organization to avoid affecting current dashboards. From 248fe19e30d7a86043be85f5bc1f3e95d770551f Mon Sep 17 00:00:00 2001 From: huoyao1125 <90880576+huoyao1125@users.noreply.github.com> Date: Mon, 20 Oct 2025 18:57:29 +0800 Subject: [PATCH 10/26] Update tidb-cloud/monitor-prometheus-and-grafana-integration.md Co-authored-by: Grace Cai --- tidb-cloud/monitor-prometheus-and-grafana-integration.md | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/tidb-cloud/monitor-prometheus-and-grafana-integration.md b/tidb-cloud/monitor-prometheus-and-grafana-integration.md index dcae204a23a6c..2a94e884684c1 100644 --- a/tidb-cloud/monitor-prometheus-and-grafana-integration.md +++ b/tidb-cloud/monitor-prometheus-and-grafana-integration.md @@ -13,7 +13,12 @@ This document describes how to configure your Prometheus service to read key met TiDB Cloud has supported the project-level Prometheus integration (Beta) since March 15, 2022. Starting from October 21, 2025, TiDB Cloud introduces the cluster-level Prometheus integration (Preview). -- **Cluster-level Prometheus integration (Preview)**: if no legacy project-level Prometheus integration remains undeleted within your organization by October 21, 2025, TiDB Cloud provides the cluster-level Prometheus integration (Preview) for your organization to experience the latest enhancements. This feature is currently available for Dedicated clusters on AWS and GCP, and we are working to bring it to Azure in the near future. +- **Cluster-level Prometheus integration (Preview)**: if no legacy project-level Prometheus integration remains undeleted within your organization by October 21, 2025, TiDB Cloud provides the cluster-level Prometheus integration (Preview) for your organization to experience the latest enhancements. + + > **Note** + > + > Currently, cluster-level Prometheus integration (Preview) is available only for TiDB Cloud Dedicated clusters hosted on AWS and Google Cloud. + - **Legacy project-level Prometheus integration (Beta)**: if at least one legacy project-level Prometheus integration remains undeleted within your organization by October 21, 2025, TiDB Cloud retains both existing and new integrations at the project level for your organization to avoid affecting current dashboards. ## Prerequisites From f117163eb8c63b72fb48aa793f504f7994d33380 Mon Sep 17 00:00:00 2001 From: huoyao1125 <90880576+huoyao1125@users.noreply.github.com> Date: Mon, 20 Oct 2025 18:57:54 +0800 Subject: [PATCH 11/26] Update tidb-cloud/monitor-prometheus-and-grafana-integration.md Co-authored-by: Grace Cai --- tidb-cloud/monitor-prometheus-and-grafana-integration.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/tidb-cloud/monitor-prometheus-and-grafana-integration.md b/tidb-cloud/monitor-prometheus-and-grafana-integration.md index 2a94e884684c1..d0dea5022f2c2 100644 --- a/tidb-cloud/monitor-prometheus-and-grafana-integration.md +++ b/tidb-cloud/monitor-prometheus-and-grafana-integration.md @@ -37,7 +37,7 @@ TiDB Cloud has supported the project-level Prometheus integration (Beta) since M ### Step 1. Get a scrape_config file for Prometheus -Before configuring your Prometheus service to read metrics of TiDB Cloud, you need to generate a `scrape_config` YAML file in TiDB Cloud first. The `scrape_config` file contains a unique bearer token that allows the Prometheus service to monitor your target database clusters. +Before configuring your Prometheus service to read metrics of TiDB Cloud, you need to generate a `scrape_config` YAML file in TiDB Cloud first. The `scrape_config` file contains a unique bearer token that allows the Prometheus service to monitor your target clusters. Depending on your [Prometheus integration version](#prometheus-integration-version), the steps to get the `scrape_config` file for Prometheus and access the integration page are different. From 29718edfe2a8f91ab45f5458e03d28bb68c05e47 Mon Sep 17 00:00:00 2001 From: huoyao1125 <90880576+huoyao1125@users.noreply.github.com> Date: Mon, 20 Oct 2025 18:58:10 +0800 Subject: [PATCH 12/26] Update tidb-cloud/monitor-prometheus-and-grafana-integration.md Co-authored-by: Grace Cai --- tidb-cloud/monitor-prometheus-and-grafana-integration.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/tidb-cloud/monitor-prometheus-and-grafana-integration.md b/tidb-cloud/monitor-prometheus-and-grafana-integration.md index d0dea5022f2c2..d29f7559760d4 100644 --- a/tidb-cloud/monitor-prometheus-and-grafana-integration.md +++ b/tidb-cloud/monitor-prometheus-and-grafana-integration.md @@ -47,7 +47,7 @@ Depending on your [Prometheus integration version](#prometheus-integration-versi 1. In the [TiDB Cloud console](https://tidbcloud.com/), navigate to the [**Clusters**](https://tidbcloud.com/project/clusters) page of your project, and then click the name of your target cluster to go to its overview page. 2. In the left navigation pane, click **Settings** > **Integrations**. 3. On the **Integrations** page, click **Integration to Prometheus(Preview)**. -4. Click **Add File** to generate and show the scrape_config file for the current cluster. +4. Click **Add File** to generate and show the `scrape_config` file for the current cluster. 5. Make a copy of the scrape_config file content for later use. From 089e99b110f8bf7379e26f148723f2831483130a Mon Sep 17 00:00:00 2001 From: huoyao1125 <90880576+huoyao1125@users.noreply.github.com> Date: Mon, 20 Oct 2025 18:58:19 +0800 Subject: [PATCH 13/26] Update tidb-cloud/monitor-prometheus-and-grafana-integration.md Co-authored-by: Grace Cai --- tidb-cloud/monitor-prometheus-and-grafana-integration.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/tidb-cloud/monitor-prometheus-and-grafana-integration.md b/tidb-cloud/monitor-prometheus-and-grafana-integration.md index d29f7559760d4..0655135a96566 100644 --- a/tidb-cloud/monitor-prometheus-and-grafana-integration.md +++ b/tidb-cloud/monitor-prometheus-and-grafana-integration.md @@ -48,7 +48,7 @@ Depending on your [Prometheus integration version](#prometheus-integration-versi 2. In the left navigation pane, click **Settings** > **Integrations**. 3. On the **Integrations** page, click **Integration to Prometheus(Preview)**. 4. Click **Add File** to generate and show the `scrape_config` file for the current cluster. -5. Make a copy of the scrape_config file content for later use. +5. Make a copy of the `scrape_config` file content for later use.
From 6a8263ab8bd3a2db08ea3abb7ceaf66eb68d2671 Mon Sep 17 00:00:00 2001 From: huoyao1125 <90880576+huoyao1125@users.noreply.github.com> Date: Mon, 20 Oct 2025 18:58:46 +0800 Subject: [PATCH 14/26] Update tidb-cloud/monitor-prometheus-and-grafana-integration.md Co-authored-by: Grace Cai --- tidb-cloud/monitor-prometheus-and-grafana-integration.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/tidb-cloud/monitor-prometheus-and-grafana-integration.md b/tidb-cloud/monitor-prometheus-and-grafana-integration.md index 0655135a96566..492cabe8e21b5 100644 --- a/tidb-cloud/monitor-prometheus-and-grafana-integration.md +++ b/tidb-cloud/monitor-prometheus-and-grafana-integration.md @@ -62,9 +62,9 @@ Depending on your [Prometheus integration version](#prometheus-integration-versi
- > **Note:** - > - > For security reasons, TiDB Cloud only shows a newly generated `scrape_config` file once. Ensure that you copy the content before closing the file window. If you forget to do so, you need to delete the `scrape_config` file in TiDB Cloud and generate a new one. To delete a `scrape_config` file, select the file, click **...**, and then click **Delete**. +> **Note:** +> +> For security reasons, TiDB Cloud only shows a newly generated `scrape_config` file once. Ensure that you copy the content before closing the file window. If you forget to do so, you need to delete the `scrape_config` file in TiDB Cloud and generate a new one. To delete a `scrape_config` file, select the file, click **...**, and then click **Delete**. ### Step 2. Integrate with Prometheus From a4a5bf94444e49f496e7b6c025baef09819842c9 Mon Sep 17 00:00:00 2001 From: huoyao1125 <90880576+huoyao1125@users.noreply.github.com> Date: Mon, 20 Oct 2025 18:59:32 +0800 Subject: [PATCH 15/26] Update tidb-cloud/monitor-prometheus-and-grafana-integration.md Co-authored-by: Grace Cai --- .../monitor-prometheus-and-grafana-integration.md | 14 ++------------ 1 file changed, 2 insertions(+), 12 deletions(-) diff --git a/tidb-cloud/monitor-prometheus-and-grafana-integration.md b/tidb-cloud/monitor-prometheus-and-grafana-integration.md index 492cabe8e21b5..61b3edb471db8 100644 --- a/tidb-cloud/monitor-prometheus-and-grafana-integration.md +++ b/tidb-cloud/monitor-prometheus-and-grafana-integration.md @@ -82,18 +82,8 @@ After your Prometheus service is reading metrics from TiDB Cloud, you can use Gr 1. Depending on your [Prometheus integration version](#prometheus-integration-version), the link to download the Grafana dashboard JSON of TiDB Cloud for Prometheus is different. - -
- -Please download the Grafana dashboard JSON of TiDB Cloud [here](https://github.com/pingcap/docs/blob/master/tidb-cloud/monitor-prometheus-and-grafana-integration-tidb-cloud-dynamic-tracker.json). - -
-
- -Please download the Grafana dashboard JSON of TiDB Cloud [here](https://github.com/pingcap/docs/blob/master/tidb-cloud/monitor-prometheus-and-grafana-integration-grafana-dashboard-UI.json). - -
- + - For cluster-level Prometheus integration (Preview), download the Grafana dashboard JSON file [here](https://github.com/pingcap/docs/blob/master/tidb-cloud/monitor-prometheus-and-grafana-integration-tidb-cloud-dynamic-tracker.json). + - For legacy project-level Prometheus integration (Beta), download the Grafana dashboard JSON file [here](https://github.com/pingcap/docs/blob/master/tidb-cloud/monitor-prometheus-and-grafana-integration-grafana-dashboard-UI.json). 2. [Import this JSON to your own Grafana GUI](https://grafana.com/docs/grafana/v8.5/dashboards/export-import/#import-dashboard) to visualize the metrics. From a8f0c86cc6508657c3e6a774e0eb1422d539dd63 Mon Sep 17 00:00:00 2001 From: huoyao1125 <90880576+huoyao1125@users.noreply.github.com> Date: Mon, 20 Oct 2025 18:59:55 +0800 Subject: [PATCH 16/26] Update tidb-cloud/monitor-prometheus-and-grafana-integration.md Co-authored-by: Grace Cai --- tidb-cloud/monitor-prometheus-and-grafana-integration.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/tidb-cloud/monitor-prometheus-and-grafana-integration.md b/tidb-cloud/monitor-prometheus-and-grafana-integration.md index 61b3edb471db8..1b006d3de834a 100644 --- a/tidb-cloud/monitor-prometheus-and-grafana-integration.md +++ b/tidb-cloud/monitor-prometheus-and-grafana-integration.md @@ -102,7 +102,7 @@ To improve data security, it is a general best practice to periodically rotate ` 1. Follow [Step 1](#step-1-get-a-scrape_config-file-for-prometheus) to create a new `scrape_config` file for Prometheus. 2. Add the content of the new file to your Prometheus configuration file. 3. Once you have confirmed that your Prometheus service is still able to read from TiDB Cloud, remove the content of the old `scrape_config` file from your Prometheus configuration file. -4. On the **Integrations** page of your project/cluster, delete the corresponding old `scrape_config` file to block anyone else from using it to read from the TiDB Cloud Prometheus endpoint. +4. On the **Integrations** page of your project or cluster, delete the corresponding old `scrape_config` file to block anyone else from using it to read from the TiDB Cloud Prometheus endpoint. ## Metrics available to Prometheus From 2e47c584035f01a4a040d6070da56663e4700a0b Mon Sep 17 00:00:00 2001 From: huoyao1125 <90880576+huoyao1125@users.noreply.github.com> Date: Mon, 20 Oct 2025 19:00:10 +0800 Subject: [PATCH 17/26] Update tidb-cloud/monitor-prometheus-and-grafana-integration.md Co-authored-by: Grace Cai --- tidb-cloud/monitor-prometheus-and-grafana-integration.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/tidb-cloud/monitor-prometheus-and-grafana-integration.md b/tidb-cloud/monitor-prometheus-and-grafana-integration.md index 1b006d3de834a..139eb1d9d17db 100644 --- a/tidb-cloud/monitor-prometheus-and-grafana-integration.md +++ b/tidb-cloud/monitor-prometheus-and-grafana-integration.md @@ -135,6 +135,8 @@ Prometheus tracks the following metric data for your TiDB clusters. For cluster-level Prometheus integration, the following additional metrics are also available: +| Metric name | Metric type | Labels | Description | +|:--- |:--- |:--- |:--- | | tidbcloud_dm_task_status | gauge | instance: `instance`
task: `task`
cluster_name: `` | Task State of Data Migration:
0: Invalid
1: New
2: Running
3: Paused
4: Stopped
5: Finished
15: Error | | tidbcloud_dm_syncer_replication_lag_bucket | gauge | instance: `instance`
cluster_name: `` | Replicate lag (bucket) of Data Migration. | | tidbcloud_dm_syncer_replication_lag_gauge | gauge | instance: `instance`
task: `task`
cluster_name: `` | Replicate lag (gauge) of Data Migration. | From 7208d800191a0f402d6c35f1769f56dcd3384a98 Mon Sep 17 00:00:00 2001 From: huoyao1125 <90880576+huoyao1125@users.noreply.github.com> Date: Mon, 20 Oct 2025 19:00:52 +0800 Subject: [PATCH 18/26] Update tidb-cloud/monitor-prometheus-and-grafana-integration.md Co-authored-by: Grace Cai --- tidb-cloud/monitor-prometheus-and-grafana-integration.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/tidb-cloud/monitor-prometheus-and-grafana-integration.md b/tidb-cloud/monitor-prometheus-and-grafana-integration.md index 139eb1d9d17db..165d8e61f9a8f 100644 --- a/tidb-cloud/monitor-prometheus-and-grafana-integration.md +++ b/tidb-cloud/monitor-prometheus-and-grafana-integration.md @@ -137,7 +137,7 @@ For cluster-level Prometheus integration, the following additional metrics are a | Metric name | Metric type | Labels | Description | |:--- |:--- |:--- |:--- | -| tidbcloud_dm_task_status | gauge | instance: `instance`
task: `task`
cluster_name: `` | Task State of Data Migration:
0: Invalid
1: New
2: Running
3: Paused
4: Stopped
5: Finished
15: Error | +| tidbcloud_dm_task_status | gauge | instance: `instance`
task: `task`
cluster_name: `` | Task state of Data Migration:
0: Invalid
1: New
2: Running
3: Paused
4: Stopped
5: Finished
15: Error | | tidbcloud_dm_syncer_replication_lag_bucket | gauge | instance: `instance`
cluster_name: `` | Replicate lag (bucket) of Data Migration. | | tidbcloud_dm_syncer_replication_lag_gauge | gauge | instance: `instance`
task: `task`
cluster_name: `` | Replicate lag (gauge) of Data Migration. | | tidbcloud_dm_relay_read_error_count | gauge | instance: `instance`
cluster_name: `` | Fail to read binlog from master. | From e320bdd0678df093185976eab81e8d24c1770fa7 Mon Sep 17 00:00:00 2001 From: huoyao1125 <90880576+huoyao1125@users.noreply.github.com> Date: Mon, 20 Oct 2025 19:12:59 +0800 Subject: [PATCH 19/26] Update monitor-prometheus-and-grafana-integration.md --- tidb-cloud/monitor-prometheus-and-grafana-integration.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/tidb-cloud/monitor-prometheus-and-grafana-integration.md b/tidb-cloud/monitor-prometheus-and-grafana-integration.md index 165d8e61f9a8f..412eb400879e4 100644 --- a/tidb-cloud/monitor-prometheus-and-grafana-integration.md +++ b/tidb-cloud/monitor-prometheus-and-grafana-integration.md @@ -29,7 +29,7 @@ TiDB Cloud has supported the project-level Prometheus integration (Beta) since M ## Limitation -- You cannot use the Prometheus and Grafana integration in [{{{ .starter }}}](/tidb-cloud/select-cluster-tier.md#tidb-cloud-serverless) or [{{{ .essential }}}](/tidb-cloud/select-cluster-tier.md#essential) clusters. +- Prometheus and Grafana integration now is only available for in [{{{ .dedicated }}}](/tidb-cloud/select-cluster-tier.md#tidb-cloud-dedicated) clusters. - Prometheus and Grafana integrations are not available when the cluster status is **CREATING**, **RESTORING**, **PAUSED**, or **RESUMING**. From 6c958186e5fd7108e8cf18b295476a5bd4c92b73 Mon Sep 17 00:00:00 2001 From: huoyao1125 <90880576+huoyao1125@users.noreply.github.com> Date: Tue, 21 Oct 2025 09:53:16 +0800 Subject: [PATCH 20/26] Update monitor-prometheus-and-grafana-integration.md --- tidb-cloud/monitor-prometheus-and-grafana-integration.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/tidb-cloud/monitor-prometheus-and-grafana-integration.md b/tidb-cloud/monitor-prometheus-and-grafana-integration.md index 412eb400879e4..bac1fd6101df7 100644 --- a/tidb-cloud/monitor-prometheus-and-grafana-integration.md +++ b/tidb-cloud/monitor-prometheus-and-grafana-integration.md @@ -25,7 +25,7 @@ TiDB Cloud has supported the project-level Prometheus integration (Beta) since M - To integrate TiDB Cloud with Prometheus, you must have a self-hosted or managed Prometheus service. -- To edit third-party integration settings of TiDB Cloud, you must have the `Organization Owner` access to your organization or `Project Member` access to the target project in TiDB Cloud. +- 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, you need at least the `Project Viewer` role to access the target clusters under the project in TiDB Cloud. ## Limitation From 910d31618af6dea3dfed6b98c4e5cf46e620e455 Mon Sep 17 00:00:00 2001 From: huoyao1125 <90880576+huoyao1125@users.noreply.github.com> Date: Tue, 21 Oct 2025 09:54:50 +0800 Subject: [PATCH 21/26] Update monitor-prometheus-and-grafana-integration.md --- tidb-cloud/monitor-prometheus-and-grafana-integration.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/tidb-cloud/monitor-prometheus-and-grafana-integration.md b/tidb-cloud/monitor-prometheus-and-grafana-integration.md index bac1fd6101df7..45dde9b0c83f2 100644 --- a/tidb-cloud/monitor-prometheus-and-grafana-integration.md +++ b/tidb-cloud/monitor-prometheus-and-grafana-integration.md @@ -29,7 +29,7 @@ TiDB Cloud has supported the project-level Prometheus integration (Beta) since M ## Limitation -- Prometheus and Grafana integration now is only available for in [{{{ .dedicated }}}](/tidb-cloud/select-cluster-tier.md#tidb-cloud-dedicated) clusters. +- Prometheus and Grafana integrations now are only available for [{{{ .dedicated }}}](/tidb-cloud/select-cluster-tier.md#tidb-cloud-dedicated) clusters. - Prometheus and Grafana integrations are not available when the cluster status is **CREATING**, **RESTORING**, **PAUSED**, or **RESUMING**. From ede3381d77d85371bcb440f2a86023de2dee9c9a Mon Sep 17 00:00:00 2001 From: qiancai Date: Tue, 21 Oct 2025 10:15:13 +0800 Subject: [PATCH 22/26] remove beta after Prometheus and Grafana integration --- .../monitor-prometheus-and-grafana-integration.md | 14 +++++++------- tidb-cloud/monitoring-concepts.md | 2 +- tidb-cloud/third-party-monitoring-integrations.md | 4 ++-- 3 files changed, 10 insertions(+), 10 deletions(-) diff --git a/tidb-cloud/monitor-prometheus-and-grafana-integration.md b/tidb-cloud/monitor-prometheus-and-grafana-integration.md index 45dde9b0c83f2..74d4f00024c2e 100644 --- a/tidb-cloud/monitor-prometheus-and-grafana-integration.md +++ b/tidb-cloud/monitor-prometheus-and-grafana-integration.md @@ -13,13 +13,13 @@ This document describes how to configure your Prometheus service to read key met TiDB Cloud has supported the project-level Prometheus integration (Beta) since March 15, 2022. Starting from October 21, 2025, TiDB Cloud introduces the cluster-level Prometheus integration (Preview). -- **Cluster-level Prometheus integration (Preview)**: if no legacy project-level Prometheus integration remains undeleted within your organization by October 21, 2025, TiDB Cloud provides the cluster-level Prometheus integration (Preview) for your organization to experience the latest enhancements. +- **Cluster-level Prometheus integration (Preview)**: if no legacy project-level Prometheus integration remains undeleted within your organization by October 21, 2025, TiDB Cloud provides the cluster-level Prometheus integration (Preview) for your organization to experience the latest enhancements. > **Note** > - > Currently, cluster-level Prometheus integration (Preview) is available only for TiDB Cloud Dedicated clusters hosted on AWS and Google Cloud. + > Currently, cluster-level Prometheus integrations (Preview) are available only for TiDB Cloud Dedicated clusters hosted on AWS and Google Cloud. -- **Legacy project-level Prometheus integration (Beta)**: if at least one legacy project-level Prometheus integration remains undeleted within your organization by October 21, 2025, TiDB Cloud retains both existing and new integrations at the project level for your organization to avoid affecting current dashboards. +- **Legacy project-level Prometheus integration (Beta)**: if at least one legacy project-level Prometheus integration remains undeleted within your organization by October 21, 2025, TiDB Cloud retains both existing and new integrations at the project level for your organization to avoid affecting current dashboards. ## Prerequisites @@ -29,7 +29,7 @@ TiDB Cloud has supported the project-level Prometheus integration (Beta) since M ## Limitation -- Prometheus and Grafana integrations now are only available for [{{{ .dedicated }}}](/tidb-cloud/select-cluster-tier.md#tidb-cloud-dedicated) clusters. +- Prometheus and Grafana integrations now are only available for [TiDB Cloud Dedicated](/tidb-cloud/select-cluster-tier.md#tidb-cloud-dedicated) clusters. - Prometheus and Grafana integrations are not available when the cluster status is **CREATING**, **RESTORING**, **PAUSED**, or **RESUMING**. @@ -83,10 +83,10 @@ After your Prometheus service is reading metrics from TiDB Cloud, you can use Gr 1. Depending on your [Prometheus integration version](#prometheus-integration-version), the link to download the Grafana dashboard JSON of TiDB Cloud for Prometheus is different. - For cluster-level Prometheus integration (Preview), download the Grafana dashboard JSON file [here](https://github.com/pingcap/docs/blob/master/tidb-cloud/monitor-prometheus-and-grafana-integration-tidb-cloud-dynamic-tracker.json). - - For legacy project-level Prometheus integration (Beta), download the Grafana dashboard JSON file [here](https://github.com/pingcap/docs/blob/master/tidb-cloud/monitor-prometheus-and-grafana-integration-grafana-dashboard-UI.json). + - For legacy project-level Prometheus integration (Beta), download the Grafana dashboard JSON file [here](https://github.com/pingcap/docs/blob/master/tidb-cloud/monitor-prometheus-and-grafana-integration-grafana-dashboard-UI.json). + +2. [Import this JSON to your own Grafana GUI](https://grafana.com/docs/grafana/v8.5/dashboards/export-import/#import-dashboard) to visualize the metrics. -2. [Import this JSON to your own Grafana GUI](https://grafana.com/docs/grafana/v8.5/dashboards/export-import/#import-dashboard) to visualize the metrics. - > **Note:** > > If you are already using Prometheus and Grafana to monitor TiDB Cloud and want to incorporate the newly available metrics, it is recommended that you create a new dashboard instead of directly updating the JSON of the existing one. diff --git a/tidb-cloud/monitoring-concepts.md b/tidb-cloud/monitoring-concepts.md index 61c9bbc3afd3d..a456d55fd94cb 100644 --- a/tidb-cloud/monitoring-concepts.md +++ b/tidb-cloud/monitoring-concepts.md @@ -39,6 +39,6 @@ TiDB Cloud lets you integrate any of the following third-party metrics services - [Datadog integration](/tidb-cloud/monitor-datadog-integration.md) -- [Prometheus and Grafana integration (Beta)](/tidb-cloud/monitor-prometheus-and-grafana-integration.md) +- [Prometheus and Grafana integration](/tidb-cloud/monitor-prometheus-and-grafana-integration.md) - [New Relic integration](/tidb-cloud/monitor-new-relic-integration.md) diff --git a/tidb-cloud/third-party-monitoring-integrations.md b/tidb-cloud/third-party-monitoring-integrations.md index c58671d4ce980..e55ed7ed9cca9 100644 --- a/tidb-cloud/third-party-monitoring-integrations.md +++ b/tidb-cloud/third-party-monitoring-integrations.md @@ -8,7 +8,7 @@ summary: Learn how to use third-party metrics integrations. You can integrate TiDB Cloud with the following third-party metrics services to receive TiDB Cloud alerts and view the performance metrics of your TiDB cluster in these services: - [Datadog integration](#datadog-integration) -- [Prometheus and Grafana integration (Beta)](#prometheus-and-grafana-integration-beta) +- [Prometheus and Grafana integration](#prometheus-and-grafana-integration) - [New Relic integration](#new-relic-integration) ## Datadog integration @@ -17,7 +17,7 @@ With the Datadog integration, you can configure TiDB Cloud to send metric data a For the detailed integration steps and a list of metrics that Datadog tracks, refer to [Integrate TiDB Cloud with Datadog](/tidb-cloud/monitor-datadog-integration.md). -## Prometheus and Grafana integration (Beta) +## Prometheus and Grafana integration With the Prometheus and Grafana integration, you can 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. From b70b8bd8e988fca81d8566fb1bdd098828751492 Mon Sep 17 00:00:00 2001 From: Grace Cai Date: Tue, 21 Oct 2025 14:35:01 +0800 Subject: [PATCH 23/26] Apply suggestions from code review Co-authored-by: xixirangrang --- tidb-cloud/monitor-prometheus-and-grafana-integration.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/tidb-cloud/monitor-prometheus-and-grafana-integration.md b/tidb-cloud/monitor-prometheus-and-grafana-integration.md index 74d4f00024c2e..a768915b99777 100644 --- a/tidb-cloud/monitor-prometheus-and-grafana-integration.md +++ b/tidb-cloud/monitor-prometheus-and-grafana-integration.md @@ -46,7 +46,7 @@ Depending on your [Prometheus integration version](#prometheus-integration-versi 1. In the [TiDB Cloud console](https://tidbcloud.com/), navigate to the [**Clusters**](https://tidbcloud.com/project/clusters) page of your project, and then click the name of your target cluster to go to its overview page. 2. In the left navigation pane, click **Settings** > **Integrations**. -3. On the **Integrations** page, click **Integration to Prometheus(Preview)**. +3. On the **Integrations** page, click **Integration to Prometheus (Preview)**. 4. Click **Add File** to generate and show the `scrape_config` file for the current cluster. 5. Make a copy of the `scrape_config` file content for later use. From 88b96dead3ce40386ae95ad780ccd71a238df49b Mon Sep 17 00:00:00 2001 From: Grace Cai Date: Tue, 21 Oct 2025 14:38:45 +0800 Subject: [PATCH 24/26] Update tidb-cloud/monitor-prometheus-and-grafana-integration.md --- tidb-cloud/monitor-prometheus-and-grafana-integration.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/tidb-cloud/monitor-prometheus-and-grafana-integration.md b/tidb-cloud/monitor-prometheus-and-grafana-integration.md index a768915b99777..d0879c7ecb38f 100644 --- a/tidb-cloud/monitor-prometheus-and-grafana-integration.md +++ b/tidb-cloud/monitor-prometheus-and-grafana-integration.md @@ -25,7 +25,7 @@ TiDB Cloud has supported the project-level Prometheus integration (Beta) since M - To integrate TiDB Cloud with Prometheus, you must have a self-hosted or managed Prometheus service. -- 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, you need at least the `Project Viewer` role to access the target clusters under the project in TiDB Cloud. +- 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, you need at least the `Project Viewer` role to access the target clusters under your project in TiDB Cloud. ## Limitation From b56d78862d7beb6f85c6a8349ea5887e0bcd9f4b Mon Sep 17 00:00:00 2001 From: qiancai Date: Tue, 21 Oct 2025 14:39:26 +0800 Subject: [PATCH 25/26] Update monitor-datadog-integration.md --- tidb-cloud/monitor-datadog-integration.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/tidb-cloud/monitor-datadog-integration.md b/tidb-cloud/monitor-datadog-integration.md index 6aeb24cfd7319..8a7b586b9131f 100644 --- a/tidb-cloud/monitor-datadog-integration.md +++ b/tidb-cloud/monitor-datadog-integration.md @@ -20,7 +20,7 @@ TiDB Cloud has supported the project-level Datadog integration (Beta) since Marc 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 `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 clusters under the project in TiDB Cloud. +- 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 clusters under your project in TiDB Cloud. ## Limitation From 7be1a4a3dc5badd5adc598159a279f7b92d75e69 Mon Sep 17 00:00:00 2001 From: Grace Cai Date: Tue, 21 Oct 2025 17:00:25 +0800 Subject: [PATCH 26/26] Update tidb-cloud/monitor-prometheus-and-grafana-integration.md Co-authored-by: xixirangrang --- tidb-cloud/monitor-prometheus-and-grafana-integration.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/tidb-cloud/monitor-prometheus-and-grafana-integration.md b/tidb-cloud/monitor-prometheus-and-grafana-integration.md index d0879c7ecb38f..339ac8120cf72 100644 --- a/tidb-cloud/monitor-prometheus-and-grafana-integration.md +++ b/tidb-cloud/monitor-prometheus-and-grafana-integration.md @@ -140,7 +140,7 @@ For cluster-level Prometheus integration, the following additional metrics are a | tidbcloud_dm_task_status | gauge | instance: `instance`
task: `task`
cluster_name: `` | Task state of Data Migration:
0: Invalid
1: New
2: Running
3: Paused
4: Stopped
5: Finished
15: Error | | tidbcloud_dm_syncer_replication_lag_bucket | gauge | instance: `instance`
cluster_name: `` | Replicate lag (bucket) of Data Migration. | | tidbcloud_dm_syncer_replication_lag_gauge | gauge | instance: `instance`
task: `task`
cluster_name: `` | Replicate lag (gauge) of Data Migration. | -| tidbcloud_dm_relay_read_error_count | gauge | instance: `instance`
cluster_name: `` | Fail to read binlog from master. | +| tidbcloud_dm_relay_read_error_count | count | instance: `instance`
cluster_name: `` | The number of failed attempts to read binlog from the master. | ## FAQ