-
Notifications
You must be signed in to change notification settings - Fork 708
Add migration guide for Prometheus integration at the cluster level #22086
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
ti-chi-bot
merged 8 commits into
pingcap:release-8.5
from
handlerww:handlerww/prom-integration-migration
Dec 2, 2025
Merged
Changes from all commits
Commits
Show all changes
8 commits
Select commit
Hold shift + click to select a range
bad8efa
Add migration guide for Prometheus integration at the cluster level
handlerww 6d3279b
Update tidb-cloud/migrate-prometheus-metrics-integrations.md
hfxsd a2528d4
Update tidb-cloud/migrate-prometheus-metrics-integrations.md
hfxsd 489c91c
Update tidb-cloud/migrate-prometheus-metrics-integrations.md
hfxsd a099c30
Update tidb-cloud/migrate-prometheus-metrics-integrations.md
hfxsd 0ebdc1d
Update tidb-cloud/migrate-prometheus-metrics-integrations.md
hfxsd e6921d3
Update tidb-cloud/migrate-prometheus-metrics-integrations.md
hfxsd d433dcc
Apply suggestions from code review
hfxsd File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,44 @@ | ||
| --- | ||
| title: Migrate 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](/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 | ||
|
|
||
| - 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. | ||
hfxsd marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| ### 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 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 new cluster-level Prometheus integrations. | ||
|
|
||
| ## Contact support | ||
|
|
||
| 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). | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.