Skip to content

Commit 0eff9aa

Browse files
authored
Add migration guide for Prometheus integration at the cluster level (#22086)
1 parent 4c2899a commit 0eff9aa

File tree

2 files changed

+45
-0
lines changed

2 files changed

+45
-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: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
---
2+
title: Migrate Prometheus Integrations
3+
summary: Learn how to migrate from the legacy project-level Prometheus integration to the new cluster-level Prometheus integrations.
4+
---
5+
6+
# Migrate Prometheus Integrations
7+
8+
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.
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+
Do the following to migrate the Prometheus integration.
17+
18+
### Step 1. Delete the legacy project-level Prometheus integrations (Beta)
19+
20+
1. In the [TiDB Cloud console](https://tidbcloud.com/), switch to the target project using the combo box in the upper-left corner.
21+
22+
2. In the left navigation panel, click **Project Settings** > **Integrations**.
23+
24+
3. On the **Integrations** > **Integration to Prometheus (BETA)** module, select **Scrape_config Files** and click **Delete**.
25+
26+
4. In the displayed dialog, type `Delete` to confirm the removal of the legacy integration.
27+
28+
### Step 2. Create a new cluster-level Prometheus integration for each cluster
29+
30+
Repeat the following steps for each [TiDB Cloud Dedicated](/tidb-cloud/select-cluster-tier.md#tidb-cloud-dedicated) cluster in the project.
31+
32+
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.
33+
34+
2. In the left navigation panel, click **Settings** > **Integrations**.
35+
36+
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).
37+
38+
## Impact of deleting the project-level Prometheus integration (Beta)
39+
40+
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.
41+
42+
## Contact support
43+
44+
For assistance, contact TiDB Cloud support at <a href="mailto:support@pingcap.com">support@pingcap.com</a> or reach out to your Technical Account Manager (TAM).

0 commit comments

Comments
 (0)