cloud: add monitor-new-relic-integration-for-tidb-x.md by huoyao1125 · Pull Request #24470 · pingcap/docs

huoyao1125 · 2026-10-16T06:13:06Z

First-time contributors' checklist

I've signed the Contributor License Agreement, which is required for the repository owners to accept my contribution.

What is changed, added, or deleted? (Required)

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)?

Related code change PR links (if applicable):
This PR is translated from:
Other reference link(s):

AI agent involvement

The changes in this PR were primarily made by an AI agent on behalf of the PR author.

Do your changes match any of the following descriptions?

Delete files
Change aliases
Need modification after applied to another branch
Might cause conflicts after applied to another branch

Summary by CodeRabbit

Documentation
- Added setup guidance for integrating TiDB Cloud Essential and Premium instances with New Relic, including prerequisites, access roles, connection steps, dashboard imports, and dashboard access.
- Added links to the integration guide in the Essential and Premium documentation indexes.
- Documented unsupported instance types and statuses, plan-specific metrics, and Essential dashboard options by instance creation date, including CDC metric availability.
- Updated existing setup instructions to clarify API key and region selection, and dashboard account and permission settings.

coderabbitai · 2026-10-16T06:14:03Z

Note

Reviews paused

It looks like this branch is under active development. To avoid overwhelming you with review comments due to an influx of new commits, CodeRabbit has automatically paused this review. You can configure this behavior by changing the reviews.auto_review.auto_pause_after_reviewed_commits setting.

Last reviewed commit: a820b29
Latest commit, not reviewed: d64ddbd

Use the following commands to manage reviews:

@coderabbitai resume to resume automatic reviews.
@coderabbitai review to trigger a single review.

Use the checkboxes below for quick actions:

▶️ Resume reviews
🔍 Trigger review

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: Repository: pingcap/docs/.coderabbit.yaml
Review profile: ASSERTIVE
Plan: Advanced
Run ID: 685e7bc5-cdc6-4c98-bda5-4e705907539b

📥 Commits

Reviewing files that changed from the base of the PR and between a04c739 and a820b29.

📒 Files selected for processing: 2

tidb-cloud/monitor-new-relic-integration-for-tidb-x.md
tidb-cloud/monitor-new-relic-integration.md

Included review availability: This review used your included allowance. Your plan provides up to 4 included reviews per hour; 3 remain after this review.

📝 Walkthrough

Adds documentation for connecting TiDB Cloud Essential and Premium instances to New Relic. The guide covers prerequisites, dashboard import and access, connection testing, and plan-specific metrics. Both plan indexes now link to the guide. Existing integration instructions also reflect updated API key, region, and dashboard steps.

Changes: New Relic integration

Layer / File(s)	Summary
Prerequisites and dashboard import `tidb-cloud/monitor-new-relic-integration-for-tidb-x.md`, `TOC-tidb-cloud-essential.md`, `TOC-tidb-cloud-premium.md`	Documents account, API key, role, and instance-status requirements. Explains dashboard selection by plan and, for Essential instances, creation date. Adds guide links to both plan indexes.
Connect instances and view dashboards `tidb-cloud/monitor-new-relic-integration-for-tidb-x.md`, `tidb-cloud/monitor-new-relic-integration.md`	Provides separate connection paths for Essential and Premium instances. Both include API key entry, region selection, and integration testing. Updates existing integration and dashboard instructions, including account ID reference and dashboard settings.
Plan-specific metrics `tidb-cloud/monitor-new-relic-integration-for-tidb-x.md`	Lists metrics for Essential and Premium instances. Documents the CDC availability condition and TiFlash-related columnar-storage behavior for Essential instances.

Priority: ⬇️ Low

Estimated code review effort: 2 (Simple) | ~10 minutes

Change: Other

Suggested reviewers: qiancai

Merge Risk: 🟡 Moderate · up to a820b

The guide’s three dashboard-download links point to missing files, preventing users from importing the documented dashboards. Add the files or replace the links before merging.

Architecture risk: 🔵 Low · up to a820b

The change affects 3 systems.

Changed systems: tidb-cloud, TOC-tidb-cloud-essential.md, TOC-tidb-cloud-premium.md

Architecture concerns
No architecture-level concerns identified.

Review details

Systems and components

observed — tidb-cloud (service) was modified; 2 changed files map to changed impact.
observed — TOC-tidb-cloud-essential.md (service) was modified; 1 changed file maps to changed impact.
observed — TOC-tidb-cloud-premium.md (service) was modified; 1 changed file maps to changed impact.

Before / after behavior

observed — Modified behavior in TOC-tidb-cloud-essential.md: Added a New Relic integration link under Monitor and Alert.
observed — Modified behavior in TOC-tidb-cloud-essential.md: Added New Relic to the Integrations list, linking to the same integration documentation.
observed — Modified behavior in TOC-tidb-cloud-premium.md: Added a New Relic integration guide under the TiDB Cloud monitoring links.
observed — Modified behavior in TOC-tidb-cloud-premium.md: Added New Relic to the Integrations list, linking to the same guide as the monitoring entry.

Pre-merge checks: 4 · 1

Failed checks: 1 warning

Check name	Status	Explanation	Resolution
Description check		The description retains the template but provides no content for the required change summary or affected TiDB versions. Reference links and other checklist details are also left blank.	Add a summary of the documentation changes and their purpose. Select the applicable TiDB version checkbox, such as master or release-8.5, and complete relevant reference links and checklist items.

Passed checks: 4 passed

Check name	Status	Explanation
Title check		The title clearly identifies the main change: adding the TiDB Cloud New Relic monitoring integration documentation.
Docstring Coverage		No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0…
Linked Issues check		Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check		Check skipped because no linked issues were found for this pull request.

Full details: Docstring Coverage

Explanation

No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0 files. (2 skipped: 2 unsupported.)

✨ Finishing Touches: 💡 1

🛠️ Fix failing CI checks: 💡

Commit to this branch
Create a new PR

🧪 Generate unit tests (beta)

Commit to this branch
Create a new PR

Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

_{Comment @coderabbitai help to get the list of available commands.}

coderabbitai

Actionable comments posted: 1

ℹ️ Review info

⚙️ Run configuration

Configuration used: Repository: pingcap/docs/.coderabbit.yaml
Review profile: ASSERTIVE
Plan: Advanced
Run ID: 1988cdb4-5001-485c-955d-b99d68cca314

📥 Commits

Reviewing files that changed from the base of the PR and between e65d125 and 5e7a903.

📒 Files selected for processing: 1

tidb-cloud/monitor-new-relic-integration-for-tidb-x.md

Included review availability: This review used your included allowance. Your plan provides up to 4 included reviews per hour; 3 remain after this review.

…md TOC

… TOC

…emium

Yujie-Xie

LGTM

ti-chi-bot · 2026-10-19T14:40:18Z

@Yujie-Xie: adding LGTM is restricted to approvers and reviewers in OWNERS files.

Details

In response to this:

LGTM

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.

ti-chi-bot · 2026-10-20T06:35:49Z

[LGTM Timeline notifier]

Timeline:

2026-10-20 06:35:48.815501506 +0000 UTC m=+85761.075588423: ☑️ agreed by qiancai.

qiancai · 2026-10-20T10:30:22Z

/approve

ti-chi-bot · 2026-10-20T10:30:32Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: qiancai

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Details

Needs approval from an approver in each of these files:

~~OWNERS~~ [qiancai]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

Create monitor-new-relic-integration-for-tidb-x.md

71ea0f2

ti-chi-bot Bot added missing-translation-status This PR does not have translation status info. size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. labels Oct 16, 2026

huoyao1125 added 2 commits October 16, 2026 14:17

Add New Relic integration doc for TiDB X (Premium and Essential)

c5881f4

Remove misplaced duplicate created under tidb-cloud/tidb-cloud/

5e7a903

ti-chi-bot Bot added size/L Denotes a PR that changes 100-499 lines, ignoring generated files. and removed size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. labels Oct 16, 2026

coderabbitai Bot reviewed Oct 16, 2026

View reviewed changes

Comment thread tidb-cloud/monitor-new-relic-integration-for-tidb-x.md

huoyao1125 added 4 commits October 16, 2026 14:23

Add (PREVIEW) suffix to the New Relic integration UI label

653b4a3

Add New Relic integration to the TiDB Cloud TOC-tidb-cloud-essential.…

8acec66

…md TOC

Add New Relic integration to the TiDB Cloud TOC-tidb-cloud-premium.md…

31d783f

… TOC

Update monitor-new-relic-integration-for-tidb-x.md

a04c739

qiancai self-assigned this Oct 19, 2026

qiancai added translation/no-need No need to translate this PR. area/tidb-cloud This PR relates to the area of TiDB Cloud. and removed missing-translation-status This PR does not have translation status info. labels Oct 19, 2026

qiancai changed the title ~~Create monitor-new-relic-integration-for-tidb-x.md~~ cloud: add monitor-new-relic-integration-for-tidb-x.md Oct 19, 2026

qiancai and others added 3 commits October 19, 2026 14:48

revise instructions

a820b29

features: set new relic status to public preview for essential and pr…

f0127f6

…emium

Update monitor-new-relic-integration.md

8009884

Yujie-Xie approved these changes Oct 19, 2026

View reviewed changes

qiancai reviewed Oct 20, 2026

View reviewed changes

Comment thread tidb-cloud/monitor-new-relic-integration-for-tidb-x.md Outdated

Update tidb-cloud/monitor-new-relic-integration-for-tidb-x.md

d64ddbd

qiancai approved these changes Oct 20, 2026

View reviewed changes

ti-chi-bot Bot added the needs-1-more-lgtm Indicates a PR needs 1 more LGTM. label Oct 20, 2026

qiancai approved these changes Oct 20, 2026

View reviewed changes

qiancai added the lgtm label Oct 20, 2026

ti-chi-bot Bot added the approved label Oct 20, 2026

ti-chi-bot Bot merged commit d34955c into release-8.5 Oct 20, 2026
11 of 12 checks passed

Navigation Menu

Repository navigation

cloud: add monitor-new-relic-integration-for-tidb-x.md - #24470

cloud: add monitor-new-relic-integration-for-tidb-x.md#24470
ti-chi-bot[bot] merged 11 commits into
release-8.5from
huoyao1125-patch-6

huoyao1125 commented Oct 16, 2026 •

edited by coderabbitai Bot

Loading

Uh oh!

coderabbitai Bot commented Oct 16, 2026 •

edited

Loading

Reviews paused

Uh oh!

coderabbitai Bot left a comment

Uh oh!

Uh oh!

Yujie-Xie left a comment

Uh oh!

ti-chi-bot Bot commented Oct 19, 2026

Uh oh!

Uh oh!

ti-chi-bot Bot commented Oct 20, 2026

Uh oh!

qiancai commented Oct 20, 2026

Uh oh!

ti-chi-bot Bot commented Oct 20, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Conversation

huoyao1125 commented Oct 16, 2026 • edited by coderabbitai Bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

First-time contributors' checklist

What is changed, added, or deleted? (Required)

Which TiDB version(s) do your changes apply to? (Required)

What is the related PR or file link(s)?

AI agent involvement

Do your changes match any of the following descriptions?

Summary by CodeRabbit

Uh oh!

coderabbitai Bot commented Oct 16, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Reviews paused

Uh oh!

coderabbitai Bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Yujie-Xie left a comment

Choose a reason for hiding this comment

Uh oh!

ti-chi-bot Bot commented Oct 19, 2026

Uh oh!

Uh oh!

ti-chi-bot Bot commented Oct 20, 2026

[LGTM Timeline notifier]

Uh oh!

qiancai commented Oct 20, 2026

Uh oh!

ti-chi-bot Bot commented Oct 20, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

huoyao1125 commented Oct 16, 2026 •

edited by coderabbitai Bot

Loading

coderabbitai Bot commented Oct 16, 2026 •

edited

Loading