From bad8efa1b762ebe55623e0362f710463f9574733 Mon Sep 17 00:00:00 2001 From: handlerww Date: Mon, 1 Dec 2025 03:08:59 +0000 Subject: [PATCH 1/8] Add migration guide for Prometheus integration at the cluster level --- TOC-tidb-cloud.md | 1 + ...migrate-prometheus-metrics-integrations.md | 42 +++++++++++++++++++ 2 files changed, 43 insertions(+) create mode 100644 tidb-cloud/migrate-prometheus-metrics-integrations.md diff --git a/TOC-tidb-cloud.md b/TOC-tidb-cloud.md index 97bc618b5570d..c42dc3c099953 100644 --- a/TOC-tidb-cloud.md +++ b/TOC-tidb-cloud.md @@ -164,6 +164,7 @@ - Third-Party Metrics Integrations - [Overview](/tidb-cloud/third-party-monitoring-integrations.md) - [Migrate Datadog and New Relic Integrations](/tidb-cloud/migrate-metrics-integrations.md) + - [Migrate Prometheus Integrations](/tidb-cloud/migrate-prometheus-metrics-integrations.md) - [TiDB Cloud Clinic](/tidb-cloud/tidb-cloud-clinic.md) - Tune Performance - [Overview](/tidb-cloud/tidb-cloud-tune-performance-overview.md) diff --git a/tidb-cloud/migrate-prometheus-metrics-integrations.md b/tidb-cloud/migrate-prometheus-metrics-integrations.md new file mode 100644 index 0000000000000..39aac8317585b --- /dev/null +++ b/tidb-cloud/migrate-prometheus-metrics-integrations.md @@ -0,0 +1,42 @@ +--- +title: Migrate Prometheus Integrations +summary: Learn how to migrate from the legacy project-level metrics integration to the new cluster-level Prometheus integrations. +--- + +# Migrate Prometheus Integrations + +TiDB Cloud now manages Prometheus integrations at the cluster level, offering more granular control and configuration. The legacy project-level Prometheus integrations(Beta) will be deprecated on January 6, 2026. If your organization is still using these legacy integrations, follow this guide to migrate to the new cluster-level Prometheus integrations to minimize disruptions to your metrics-related services. + +## Prerequisites + +- To set up third-party metrics integration for TiDB Cloud, you must have the `Organization Owner` or `Project Owner` access in TiDB Cloud. + +## Migration steps + +### Step 1. Delete the legacy project-level Prometheus integrations (Beta) + +1. In the [TiDB Cloud console](https://tidbcloud.com/), switch to the target project using the combo box in the upper-left corner. + +2. In the left navigation panel, click **Project Settings** > **Integrations**. + +3. On the **Integrations** > **Integration to Prometheus(Beta)** module, select **Scrape_config Files** and click **Delete**. + +4. In the displayed dialog, type `Delete` to confirm the removal of the legacy integration. + +### Step 2. Create a new cluster-level Prometheus integration for each cluster + +Repeat the following steps for each [TiDB Cloud Dedicated](/tidb-cloud/select-cluster-tier.md#tidb-cloud-dedicated) cluster in the project. + +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 panel, click **Settings** > **Integrations**. + +3. On the **Integrations** page, create a new Prometheus integration. For more information, see [Integrate TiDB Cloud with Prometheus and Grafana](/tidb-cloud/monitor-prometheus-and-grafana-integration.md). + +## Impact statement + +Deleting the project-level Prometheus integration (beta) immediately stops all clusters in the project from exposing metrics to the Prometheus endpoint. This results in a temporary loss of downstream data and interrupts integration-related services (such as monitoring and alerts) until you configure the new cluster-level Prometheus integrations. + +## Contact support + +For assistance, contact TiDB Cloud support at support@pingcap.com or reach out to your Technical Account Manager (TAM). From 6d3279bf10ecccbcaf65145031b7e0127a18ffe4 Mon Sep 17 00:00:00 2001 From: xixirangrang Date: Mon, 1 Dec 2025 14:47:44 +0800 Subject: [PATCH 2/8] Update tidb-cloud/migrate-prometheus-metrics-integrations.md --- tidb-cloud/migrate-prometheus-metrics-integrations.md | 1 + 1 file changed, 1 insertion(+) diff --git a/tidb-cloud/migrate-prometheus-metrics-integrations.md b/tidb-cloud/migrate-prometheus-metrics-integrations.md index 39aac8317585b..3a469cc676017 100644 --- a/tidb-cloud/migrate-prometheus-metrics-integrations.md +++ b/tidb-cloud/migrate-prometheus-metrics-integrations.md @@ -12,6 +12,7 @@ TiDB Cloud now manages Prometheus integrations at the cluster level, offering mo - To set up third-party metrics integration for TiDB Cloud, you must have the `Organization Owner` or `Project Owner` access in TiDB Cloud. ## Migration steps +Do the following to migrate the Prometheus integration. ### Step 1. Delete the legacy project-level Prometheus integrations (Beta) From a2528d435da55b23e45a2ab7d38f1598dffb8b14 Mon Sep 17 00:00:00 2001 From: xixirangrang Date: Mon, 1 Dec 2025 14:47:59 +0800 Subject: [PATCH 3/8] Update tidb-cloud/migrate-prometheus-metrics-integrations.md --- tidb-cloud/migrate-prometheus-metrics-integrations.md | 1 + 1 file changed, 1 insertion(+) diff --git a/tidb-cloud/migrate-prometheus-metrics-integrations.md b/tidb-cloud/migrate-prometheus-metrics-integrations.md index 3a469cc676017..cb21056013935 100644 --- a/tidb-cloud/migrate-prometheus-metrics-integrations.md +++ b/tidb-cloud/migrate-prometheus-metrics-integrations.md @@ -12,6 +12,7 @@ TiDB Cloud now manages Prometheus integrations at the cluster level, offering mo - To set up third-party metrics integration for TiDB Cloud, you must have the `Organization Owner` or `Project Owner` access in TiDB Cloud. ## Migration steps + Do the following to migrate the Prometheus integration. ### Step 1. Delete the legacy project-level Prometheus integrations (Beta) From 489c91cd26a70d5924cf96bd7e6dadc2a0aacb5f Mon Sep 17 00:00:00 2001 From: xixirangrang Date: Mon, 1 Dec 2025 15:48:14 +0800 Subject: [PATCH 4/8] Update tidb-cloud/migrate-prometheus-metrics-integrations.md --- tidb-cloud/migrate-prometheus-metrics-integrations.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/tidb-cloud/migrate-prometheus-metrics-integrations.md b/tidb-cloud/migrate-prometheus-metrics-integrations.md index cb21056013935..dfbf08de36fbf 100644 --- a/tidb-cloud/migrate-prometheus-metrics-integrations.md +++ b/tidb-cloud/migrate-prometheus-metrics-integrations.md @@ -35,7 +35,7 @@ Repeat the following steps for each [TiDB Cloud Dedicated](/tidb-cloud/select-cl 3. On the **Integrations** page, create a new Prometheus integration. For more information, see [Integrate TiDB Cloud with Prometheus and Grafana](/tidb-cloud/monitor-prometheus-and-grafana-integration.md). -## Impact statement +## Impact of deleting the project-level Prometheus integration (beta) Deleting the project-level Prometheus integration (beta) immediately stops all clusters in the project from exposing metrics to the Prometheus endpoint. This results in a temporary loss of downstream data and interrupts integration-related services (such as monitoring and alerts) until you configure the new cluster-level Prometheus integrations. From a099c3018818dc9e58ccff8ccf077e9c9801cba3 Mon Sep 17 00:00:00 2001 From: xixirangrang Date: Mon, 1 Dec 2025 15:53:48 +0800 Subject: [PATCH 5/8] Update tidb-cloud/migrate-prometheus-metrics-integrations.md --- tidb-cloud/migrate-prometheus-metrics-integrations.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/tidb-cloud/migrate-prometheus-metrics-integrations.md b/tidb-cloud/migrate-prometheus-metrics-integrations.md index dfbf08de36fbf..865afbf69310a 100644 --- a/tidb-cloud/migrate-prometheus-metrics-integrations.md +++ b/tidb-cloud/migrate-prometheus-metrics-integrations.md @@ -5,7 +5,7 @@ summary: Learn how to migrate from the legacy project-level metrics integration # Migrate Prometheus Integrations -TiDB Cloud now manages Prometheus integrations at the cluster level, offering more granular control and configuration. The legacy project-level Prometheus integrations(Beta) will be deprecated on January 6, 2026. If your organization is still using these legacy integrations, follow this guide to migrate to the new cluster-level Prometheus integrations to minimize disruptions to your metrics-related services. +TiDB Cloud now manages Prometheus integrations at the cluster level, offering more granular control and configuration. The legacy project-level Prometheus integrations (Beta) will be deprecated on January 6, 2026. If your organization is still using these legacy integrations, follow this guide to migrate them to the new cluster-level Prometheus integrations to minimize disruptions to your metrics-related services. ## Prerequisites From 0ebdc1d5f10ff5562f7473b8df3ee8b7c858576e Mon Sep 17 00:00:00 2001 From: xixirangrang Date: Mon, 1 Dec 2025 15:55:26 +0800 Subject: [PATCH 6/8] Update tidb-cloud/migrate-prometheus-metrics-integrations.md --- tidb-cloud/migrate-prometheus-metrics-integrations.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/tidb-cloud/migrate-prometheus-metrics-integrations.md b/tidb-cloud/migrate-prometheus-metrics-integrations.md index 865afbf69310a..6520057b37682 100644 --- a/tidb-cloud/migrate-prometheus-metrics-integrations.md +++ b/tidb-cloud/migrate-prometheus-metrics-integrations.md @@ -21,7 +21,7 @@ Do the following to migrate the Prometheus integration. 2. In the left navigation panel, click **Project Settings** > **Integrations**. -3. On the **Integrations** > **Integration to Prometheus(Beta)** module, select **Scrape_config Files** and click **Delete**. +3. On the **Integrations** > **Integration to Prometheus (BETA)** module, select **Scrape_config Files** and click **Delete**. 4. In the displayed dialog, type `Delete` to confirm the removal of the legacy integration. From e6921d35d3a215f608c5cb88375524c00362b0f6 Mon Sep 17 00:00:00 2001 From: xixirangrang Date: Mon, 1 Dec 2025 15:56:06 +0800 Subject: [PATCH 7/8] Update tidb-cloud/migrate-prometheus-metrics-integrations.md --- tidb-cloud/migrate-prometheus-metrics-integrations.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/tidb-cloud/migrate-prometheus-metrics-integrations.md b/tidb-cloud/migrate-prometheus-metrics-integrations.md index 6520057b37682..8e2a3d5bce05d 100644 --- a/tidb-cloud/migrate-prometheus-metrics-integrations.md +++ b/tidb-cloud/migrate-prometheus-metrics-integrations.md @@ -35,9 +35,9 @@ Repeat the following steps for each [TiDB Cloud Dedicated](/tidb-cloud/select-cl 3. On the **Integrations** page, create a new Prometheus integration. For more information, see [Integrate TiDB Cloud with Prometheus and Grafana](/tidb-cloud/monitor-prometheus-and-grafana-integration.md). -## Impact of deleting the project-level Prometheus integration (beta) +## Impact of deleting the project-level Prometheus integration (Beta) -Deleting the project-level Prometheus integration (beta) immediately stops all clusters in the project from exposing metrics to the Prometheus endpoint. This results in a temporary loss of downstream data and interrupts integration-related services (such as monitoring and alerts) until you configure the new cluster-level Prometheus integrations. +Deleting the project-level Prometheus integration (Beta) immediately stops all clusters in the project from exposing metrics to the Prometheus endpoint. This results in a temporary loss of downstream data and interrupts integration-related services (such as monitoring and alerts) until you configure the new cluster-level Prometheus integrations. ## Contact support From d433dcc4f4d0f79bca97d81e7e777e07efe8e542 Mon Sep 17 00:00:00 2001 From: xixirangrang Date: Mon, 1 Dec 2025 18:47:44 +0800 Subject: [PATCH 8/8] Apply suggestions from code review Co-authored-by: Grace Cai --- tidb-cloud/migrate-prometheus-metrics-integrations.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/tidb-cloud/migrate-prometheus-metrics-integrations.md b/tidb-cloud/migrate-prometheus-metrics-integrations.md index 8e2a3d5bce05d..9820fc393b4e3 100644 --- a/tidb-cloud/migrate-prometheus-metrics-integrations.md +++ b/tidb-cloud/migrate-prometheus-metrics-integrations.md @@ -1,11 +1,11 @@ --- title: Migrate Prometheus Integrations -summary: Learn how to migrate from the legacy project-level metrics integration to the new cluster-level Prometheus integrations. +summary: Learn how to migrate from the legacy project-level Prometheus integration to the new cluster-level Prometheus integrations. --- # Migrate Prometheus Integrations -TiDB Cloud now manages Prometheus integrations at the cluster level, offering more granular control and configuration. The legacy project-level Prometheus integrations (Beta) will be deprecated on January 6, 2026. If your organization is still using these legacy integrations, follow this guide to migrate them to the new cluster-level Prometheus integrations to minimize disruptions to your metrics-related services. +TiDB Cloud now manages [Prometheus integrations](/tidb-cloud/monitor-prometheus-and-grafana-integration.md) at the cluster level, offering more granular control and configuration. The legacy project-level Prometheus integrations (Beta) will be deprecated on January 6, 2026. If your organization is still using these legacy integrations, follow this guide to migrate them to the new cluster-level Prometheus integrations to minimize disruptions to your metrics-related services. ## Prerequisites @@ -37,7 +37,7 @@ Repeat the following steps for each [TiDB Cloud Dedicated](/tidb-cloud/select-cl ## Impact of deleting the project-level Prometheus integration (Beta) -Deleting the project-level Prometheus integration (Beta) immediately stops all clusters in the project from exposing metrics to the Prometheus endpoint. This results in a temporary loss of downstream data and interrupts integration-related services (such as monitoring and alerts) until you configure the new cluster-level Prometheus integrations. +Deleting the project-level Prometheus integration (Beta) immediately stops all clusters in the project from exposing metrics to the Prometheus endpoint. This results in a temporary loss of downstream data and interrupts integration-related services (such as monitoring and alerts) until you configure new cluster-level Prometheus integrations. ## Contact support