Skip to content

Commit 9c4e4e9

Browse files
committed
Add migration guide for Prometheus integration at the cluster level
1 parent 2b4f8e2 commit 9c4e4e9

File tree

2 files changed

+44
-0
lines changed

2 files changed

+44
-0
lines changed

TOC-tidb-cloud.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -164,6 +164,7 @@
164164
- Third-Party Metrics Integrations
165165
- [Overview](/tidb-cloud/third-party-monitoring-integrations.md)
166166
- [Migrate Datadog and New Relic Integrations](/tidb-cloud/migrate-metrics-integrations.md)
167+
- [Migrate Prometheus Integrations](/tidb-cloud/migrate-prometheus-metrics-integrations.md)
167168
- [TiDB Cloud Clinic](/tidb-cloud/tidb-cloud-clinic.md)
168169
- Tune Performance
169170
- [Overview](/tidb-cloud/tidb-cloud-tune-performance-overview.md)
Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
---
2+
title: Migrate Prometheus Integrations
3+
summary: Learn how to migrate from the legacy project-level metrics integration to the new cluster-level Prometheus integrations.
4+
---
5+
6+
# Migrate Prometheus Integrations
7+
8+
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.
9+
10+
## Prerequisites
11+
12+
- To set up third-party metrics integration for TiDB Cloud, you must have the `Organization Owner` or `Project Owner` access in TiDB Cloud.
13+
14+
## Migration steps
15+
16+
### Step 1. Delete the legacy project-level Prometheus integrations (Beta)
17+
18+
1. In the [TiDB Cloud console](https://tidbcloud.com/), switch to the target project using the combo box in the upper-left corner.
19+
20+
2. In the left navigation panel, click **Project Settings** > **Integrations**.
21+
22+
3. On the **Integrations** > **Integration to Prometheus(Beta)** module, select **Scrape_config Files** and click **Delete**.
23+
24+
4. In the displayed dialog, type `Delete` to confirm the removal of the legacy integration.
25+
26+
### Step 2. Create a new cluster-level Prometheus integration for each cluster
27+
28+
29+
Repeat the following steps for each [TiDB Cloud Dedicated](/tidb-cloud/select-cluster-tier.md#tidb-cloud-dedicated) cluster in the project.
30+
31+
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.
32+
33+
2. In the left navigation panel, click **Settings** > **Integrations**.
34+
35+
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).
36+
37+
## Impact statement
38+
39+
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.
40+
41+
## Contact support
42+
43+
For assistance, contact TiDB Cloud support at <a href="mailto:[email protected]">[email protected]</a> or reach out to your Technical Account Manager (TAM).

0 commit comments

Comments
 (0)