Skip to content

tidb-cloud: add New Relic dashboards for Premium and Essential - #24447

Merged
ti-chi-bot[bot] merged 1 commit into
pingcap:masterfrom
Yujie-Xie:codex/add-new-relic-dashboards
Oct 20, 2026
Merged

ti-chi-bot[bot] merged 1 commit into
pingcap:masterfrom
Yujie-Xie:codex/add-new-relic-dashboards

Conversation

@Yujie-Xie

@Yujie-Xie Yujie-Xie commented Oct 13, 2026 •

Copy link
Copy Markdown
Contributor

What is changed, added or deleted? (Required)

Add New Relic dashboard JSON templates under tidb-cloud/ for TiDB Cloud Premium, Essential, and Essential v2 (instances created on or after July 1, 2026). Follow the dashboard asset naming and placement used in #22662.

The three templates are copied byte-for-byte from artifacts/dashboard/newrelic/ in tidbcloud/metrics-integration at commit 7ccec7a2731a5709d3d1802ee26a2a4957065a4b. New Relic account IDs remain empty for users to configure during import.

Validation: parsed all three files with Python's JSON parser, verified SHA-256 equality with the source files, confirmed all accountIds fields are empty, and ran git diff --cached --check. This is an asset-only change; no application code or documentation prose changes.

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.

  • master (the latest development version)
  • v8.5 (TiDB 8.5 versions)
  • v8.4 (TiDB 8.4 versions)
  • v8.3 (TiDB 8.3 versions)
  • v8.2 (TiDB 8.2 versions)
  • v8.1 (TiDB 8.1 versions)
  • v7.5 (TiDB 7.5 versions)
  • v7.1 (TiDB 7.1 versions)
  • v6.5 (TiDB 6.5 versions)

What is the related PR or file 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

  • New Features
    • Added New Relic dashboards for TiDB Cloud Essential and Premium instances, with views of performance, storage, connections, commands and transactions, and resource-unit usage.
    • Added filters for instance name and ID. Dashboards also include changefeed metrics where available; those panels remain empty when CDC is not enabled.

@ti-chi-bot ti-chi-bot Bot added contribution This PR is from a community contributor. needs-ok-to-test Indicates a PR created by contributors and need ORG member send '/ok-to-test' to start testing. labels Oct 13, 2026
@ti-chi-bot

ti-chi-bot Bot commented Oct 13, 2026

Copy link
Copy Markdown

Hi @Yujie-Xie. Thanks for your PR.

I'm waiting for a pingcap member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work.

Tip

We noticed you've done this a few times! Consider joining the org to skip this step and gain /lgtm and other bot rights. We recommend asking approvers on your previous PRs to sponsor you.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

Details

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 ti-chi-bot Bot added missing-translation-status This PR does not have translation status info. size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. labels Oct 13, 2026
@coderabbitai

coderabbitai Bot commented Oct 13, 2026 •

Copy link
Copy Markdown

Review in Change Stack →

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: 102d2bce-df5c-467c-9e7a-5c179eeb292f
📥 Commits

Reviewing files that changed from the base of the PR and between 727dea6 and 7a4dddd.

📒 Files selected for processing (3)
  • tidb-cloud/monitor-new-relic-integration-tidb-cloud-dynamic-tracker-essential-v2.json
  • tidb-cloud/monitor-new-relic-integration-tidb-cloud-dynamic-tracker-essential.json
  • tidb-cloud/monitor-new-relic-integration-tidb-cloud-dynamic-tracker-premium.json

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

The pull request adds New Relic dynamic tracker dashboards for TiDB Cloud Essential, Essential v2, and Premium instances. The dashboards include instance filters and panels for performance, storage, connections, commands and transactions, and request units. Essential v2 and Premium also include changefeed panels.

Changes: TiDB Cloud tier dashboards

Layer / File(s) Summary
Essential dashboard panels and selectors
tidb-cloud/monitor-new-relic-integration-tidb-cloud-dynamic-tracker-essential.json
Adds dashboard metadata, performance and storage panels, connection metrics, command and transaction panels, request-unit usage, and instance name and ID selectors.
Essential v2 and Premium dashboards
tidb-cloud/monitor-new-relic-integration-tidb-cloud-dynamic-tracker-essential-v2.json, tidb-cloud/monitor-new-relic-integration-tidb-cloud-dynamic-tracker-premium.json
Adds dashboards with performance, storage, connection, command and transaction, and request-unit panels. Both dashboards also include CDC changefeed panels and instance selectors.

Priority: ➖ Normal

Estimated code review effort: 4 (Complex) | ~45 minutes

Change: Feature

Merge Risk: ⚪ Minimal · up to 7a4dd

This change adds New Relic dashboard templates for TiDB Cloud Essential, Essential v2, and Premium, and changes no application behavior. Users configure their account IDs when they import a template, as the existing guide describes. No merge-blocking risk was found.

### Architecture Summary

Architecture risk: 🔵 Low · up to 7a4dd

The change affects 1 system.

Changed systems: tidb-cloud

Architecture concerns
No architecture-level concerns identified.

Review details

Systems and components

  • observed — tidb-cloud (service) was modified; 3 changed files map to changed impact.

Before / after behavior

  • observed — Modified behavior in tidb-cloud/monitor-new-relic-integration-tidb-cloud-dynamic-tracker-essential-v2.json: Adds the TiDB Cloud Essential dynamic tracker dashboard, including its Overview page, metric panels and NRQL queries, markdown section headings, and instance_name and instance_id variables. The variables default to * and query available values from tidb_cloud.% metrics. Panels cover database time, query throughput and duration, failures, storage, connections, SQL commands, plan-cache queries, transactions, request units, and CDC changefeed lag and status.
  • observed — Modified behavior in tidb-cloud/monitor-new-relic-integration-tidb-cloud-dynamic-tracker-essential.json: Adds the public dashboard metadata and introductory markdown panels, identifying the dashboard as an Essential-instance overview and excluding Dedicated-only node, DM, and CDC metrics.
  • observed — Modified behavior in tidb-cloud/monitor-new-relic-integration-tidb-cloud-dynamic-tracker-essential.json: Adds performance and storage panels for database time, queries per second, average query duration, failed queries, and row and columnar storage. The panels use 24-hour time series filtered by the instance variables; performance panels include configured SQL-type or operation-type breakdowns, and storage panels report bytes.
  • observed — Modified behavior in tidb-cloud/monitor-new-relic-integration-tidb-cloud-dynamic-tracker-essential.json: Adds a Connections section with time-series panels for total and active connections and disconnections. The disconnection panel breaks results down by result; all three filter on the instance variables.
Pre-merge checks · Passed 4 · Failed 1

Failed Failed checks (1 warning)

Check name Status Explanation Resolution
Description check Warning The description includes the required change summary, version selection, reference links, AI involvement, and change-category sections. However, it selects only master while the PR objectives identify… Update the TiDB version selection to include v8.5, and include master if the change also applies to the development branch. Otherwise, clarify the intended target so the description matches the PR objectives.
Passed Passed checks (4 passed)
Check name Status Explanation
Docstring Coverage Passed 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 Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check Passed Check skipped because no linked issues were found for this pull request.
Title check Passed The title clearly identifies the addition of New Relic dashboards for the Premium and Essential TiDB Cloud plans. It accurately summarizes the main change.
Full details: Description check

Explanation

The description includes the required change summary, version selection, reference links, AI involvement, and change-category sections. However, it selects only master while the PR objectives identify release-8.5 as the target branch.

  • Fix all pre-merge checks with AI
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • 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.

@Yujie-Xie
Yujie-Xie force-pushed the codex/add-new-relic-dashboards branch from 7a4dddd to a7c8b5e Compare October 13, 2026 09:59
@Yujie-Xie
Yujie-Xie changed the base branch from release-8.5 to master October 13, 2026 09:59
@qiancai qiancai added translation/no-need No need to translate this PR. area/tidb-cloud This PR relates to the area of TiDB Cloud. labels Oct 20, 2026
@ti-chi-bot ti-chi-bot Bot removed the missing-translation-status This PR does not have translation status info. label Oct 20, 2026
@ti-chi-bot ti-chi-bot Bot added the needs-1-more-lgtm Indicates a PR needs 1 more LGTM. label Oct 20, 2026
@ti-chi-bot

ti-chi-bot Bot commented Oct 20, 2026

Copy link
Copy Markdown

[LGTM Timeline notifier]

Timeline:

  • 2026-10-20 10:00:55.916598778 +0000 UTC m=+98068.176685715: ☑️ agreed by qiancai.

@qiancai

qiancai commented Oct 20, 2026

Copy link
Copy Markdown
Collaborator

/approve

@qiancai qiancai added the lgtm label Oct 20, 2026
@ti-chi-bot

ti-chi-bot Bot commented Oct 20, 2026

Copy link
Copy Markdown

[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:

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

@qiancai

qiancai commented Oct 20, 2026

Copy link
Copy Markdown
Collaborator

/ok-to-test

@ti-chi-bot ti-chi-bot Bot added approved ok-to-test Indicates a PR is ready to be tested. and removed needs-ok-to-test Indicates a PR created by contributors and need ORG member send '/ok-to-test' to start testing. labels Oct 20, 2026
@ti-chi-bot
ti-chi-bot Bot merged commit 0571c90 into pingcap:master Oct 20, 2026
11 of 12 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

approved area/tidb-cloud This PR relates to the area of TiDB Cloud. contribution This PR is from a community contributor. lgtm needs-1-more-lgtm Indicates a PR needs 1 more LGTM. ok-to-test Indicates a PR is ready to be tested. size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. translation/no-need No need to translate this PR.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants