集成 TiDB Cloud 与 New Relic(PREVIEW)
TiDB Cloud 支持与 New Relic 集成。你可以将 TiDB Cloud 配置为把你的 TiDB Cloud Essential 实例的指标发送到 New Relic。完成后,你可以直接在 New Relic 仪表板中查看这些指标。
前提条件
要将 TiDB Cloud 与 New Relic 集成,你必须拥有一个 New Relic 账户,并创建一个 New Relic API key,其类型为
Ingest - License。如果你还没有 New Relic 账户,请访问 https://newrelic.com/signup 注册。
要为 TiDB Cloud 设置第三方指标集成,你必须在 TiDB Cloud 中具有
Organization Owner、Project Owner或Instance Manager访问权限。要查看集成页面,你至少需要Project Viewer或Instance Viewer角色,以访问 TiDB Cloud 中你所在组织下的目标 TiDB Cloud Essential 实例。
限制
- TiDB Cloud Starter 实例不支持 New Relic 集成。
- 当你的 TiDB Cloud Essential 实例状态为 CREATING、RESTORING、PAUSED 或 RESUMING 时,不支持 New Relic 集成。
- 删除已集成 New Relic 的实例时,其关联的集成服务也会一并删除。
步骤
步骤 1. 导入预构建的 New Relic 仪表板
目前,适用于 TiDB Cloud Essential 的 TiDB Cloud 仪表板尚未在 New Relic marketplace 中提供。在其发布之前,你需要手动下载仪表板 JSON 文件并将其导入 New Relic。
根据你的实例类型下载对应的 New Relic 仪表板 JSON 文件:
- 对于在 2026 年 7 月 1 日及之后创建的 TiDB Cloud Essential 实例,请下载此 JSON 文件:https://github.com/pingcap/docs/blob/master/tidb-cloud/monitor-new-relic-integration-tidb-cloud-dynamic-tracker-essential-v2.json。注意,
v2后缀仅表示仪表板 JSON 文件的版本。 - 对于在 2026 年 7 月 1 日之前创建的 TiDB Cloud Essential 实例,请下载此 JSON 文件:https://github.com/pingcap/docs/blob/master/tidb-cloud/monitor-new-relic-integration-tidb-cloud-dynamic-tracker-essential.json。
- 对于在 2026 年 7 月 1 日及之后创建的 TiDB Cloud Essential 实例,请下载此 JSON 文件:https://github.com/pingcap/docs/blob/master/tidb-cloud/monitor-new-relic-integration-tidb-cloud-dynamic-tracker-essential-v2.json。注意,
在 JSON 文件中,将你的 New Relic account ID 添加到所有
"accountIds": []字段中。例如:
"accountIds": [ 1234567 ],登录 New Relic,在左侧导航栏中点击 Dashboards,然后点击右上角的 Import dashboard。
在显示的对话框中,将准备好的 JSON 文件内容粘贴到文本区域,选择权限设置,然后点击 Save。
步骤 2. 使用你的 New Relic API key 进行集成
在 TiDB Cloud console 中,进入 My TiDB 页面,然后点击目标 TiDB Cloud Essential 实例的名称,进入其实例概览页面。
在左侧导航窗格中,点击 Integrations。
在 Integrations 页面上,找到 New Relic (PREVIEW) 集成并点击 Connect。
输入你的 New Relic API key,选择托管你的 New Relic 账户的区域,然后点击 Test Integration。
- 如果测试成功,会显示 Confirm 按钮。
- 如果测试失败,会显示错误消息。请根据消息进行故障排查,然后重试集成。
点击 Confirm 完成集成。
查看预构建的仪表板
完成集成后,要查看预构建的仪表板,请在 New Relic 中进入 Dashboards > Dashboard List,然后选择在步骤 1中导入的仪表板。在仪表板页面上,你可以按目标实例名称或实例 ID 进行筛选,然后查看指标。
你也可以从 TiDB Cloud console 访问 New Relic 中的 Dashboard List 页面:进入目标实例的 Integrations 页面,点击 New Relic (PREVIEW),然后点击 Dashboard。
New Relic 可用的指标
New Relic 会跟踪你的 TiDB Cloud Essential 实例的以下指标。