Add migration guide for Prometheus integration at the cluster level #22086
Conversation
ti-chi-bot
bot
added
the
first-time-contributor
Summary of ChangesHello @handlerww, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed! This pull request provides essential documentation to assist users in migrating their Prometheus monitoring setups in TiDB Cloud. It addresses the deprecation of project-level integrations by offering a clear path to adopt the more granular cluster-level approach, ensuring continuous and effective monitoring for TiDB Cloud users. Highlights
Using Gemini Code AssistThe full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips. Invoking Gemini You can request assistance from Gemini at any point by creating a comment using either
Customization To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a Limitations & Feedback Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here. You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension. Footnotes
|
ti-chi-bot
bot
added
the
missing-translation-status
|
|
ti-chi-bot
bot
added
the
size/M
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request adds a new migration guide for Prometheus integrations, helping users transition from the legacy project-level setup to the new cluster-level integrations. The changes are clear and well-structured. I've provided a few suggestions to improve consistency and clarity in the new documentation file, mainly regarding the use of plural for 'integrations' and phrasing around the deprecation date.
handlerww
force-pushed
the
handlerww/prom-integration-migration
branch
2 times, most recently
from
8ea26c2 to
0554dbc
Compare
|
|
||
| # 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 will be deprecated on December 31, 2025. 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. |
There was a problem hiding this comment.
Please update deprecated time: January 6, 2026.
|
|
||
| 4. In the displayed dialog, type `Delete` to confirm the removal of the legacy integration. | ||
|
|
||
| ### Step 2. Create the new Prometheus integration for each cluster |
There was a problem hiding this comment.
Create a new cluster-level Prometheus integration for each cluster
|
|
||
| 2. In the left navigation panel, click **Project Settings** > **Integrations**. | ||
|
|
||
| 3. On the **Integrations** page, click **Delete** next to **Integration to Prometheus**. |
There was a problem hiding this comment.
On the Integrations > Integration to Prometheus(Beta) module, select Scrape_config Files and click Delete.
|
|
||
| # 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 will be deprecated on December 31, 2025. 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. |
There was a problem hiding this comment.
The legacy project-level Prometheus integrations(Beta) will be deprecated on January 6, 2026.
|
|
||
| ## Migration steps | ||
|
|
||
| ### Step 1. Delete the legacy project-level Prometheus integrations |
There was a problem hiding this comment.
Step 1. Delete the legacy project-level Prometheus integrations (Beta)
|
|
||
| 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/), switch to the target cluster using the combo box in the upper-left corner. |
There was a problem hiding this comment.
- In the TiDB Cloud console, navigate to the Clusters page of your project, and then click the name of your target cluster to go to its overview page.
|
|
||
| ## Impact statement | ||
|
|
||
| Deleting the project-level integration 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. |
There was a problem hiding this comment.
Deleting the project-level Prometheus integration (beta) immediately stops all clusters in the project from exposing metrics to the Prometheus endpoint.
|
@huoyao1125: adding LGTM is restricted to approvers and reviewers in OWNERS files. In response to this: Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository. |
hfxsd
added
translation/no-need
|
|
||
| ## Migration steps | ||
|
|
||
| ### Step 1. Delete the legacy project-level Prometheus integrations |
There was a problem hiding this comment.
| ### Step 1. Delete the legacy project-level Prometheus integrations | |
| ### Step 1. Delete the legacy project-level Prometheus integrations (Beta) |
handlerww
force-pushed
the
handlerww/prom-integration-migration
branch
from
eb03db7 to
9c4e4e9
Compare
handlerww
force-pushed
the
handlerww/prom-integration-migration
branch
from
9c4e4e9 to
bad8efa
Compare
Co-authored-by: Grace Cai <[email protected]>
ti-chi-bot
bot
added
lgtm
and removed
needs-1-more-lgtm
|
/approve |
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: hfxsd The full list of commands accepted by this bot can be found here. The pull request process is described here
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
5 participants
First-time contributors' checklist
What is changed, added or deleted? (Required)
This PR adds a migration guide for Prometheus integration at the cluster level. The guide assists users in transitioning from legacy project-level Prometheus integrations to the new cluster-level integrations in TiDB Cloud. It outlines the necessary steps, prerequisites, and highlights the impact of deleting legacy integrations. Additionally, it provides support contact information for further assistance.
Which TiDB version(s) do your changes apply to? (Required)
Tips for choosing the affected version(s):
By default, CHOOSE MASTER ONLY so your changes will be applied to the next TiDB major or minor releases. If your PR involves a product feature behavior change or a compatibility change, CHOOSE THE AFFECTED RELEASE BRANCH(ES) AND MASTER.
For details, see tips for choosing the affected versions.
What is the related PR or file link(s)?
Do your changes match any of the following descriptions?