📣TiDB Cloud BYOC、TiDB Cloud Filesystem 和 PostgreSQL-compatible TiDB Cloud Starter 全新发布,开放公测中。此页面由 AI 自动翻译,英文原文请见此处。

集成 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。

  1. 根据你的实例类型下载对应的 New Relic 仪表板 JSON 文件:

  2. 在 JSON 文件中,将你的 New Relic account ID 添加到所有 "accountIds": [] 字段中。

    例如:

    "accountIds": [ 1234567 ],
  3. 登录 New Relic,在左侧导航栏中点击 Dashboards,然后点击右上角的 Import dashboard。

  4. 在显示的对话框中,将准备好的 JSON 文件内容粘贴到文本区域,选择权限设置,然后点击 Save。

步骤 2. 使用你的 New Relic API key 进行集成

  1. 在 TiDB Cloud console 中,进入 My TiDB 页面,然后点击目标 TiDB Cloud Essential 实例的名称,进入其实例概览页面。

  2. 在左侧导航窗格中,点击 Integrations。

  3. 在 Integrations 页面上,找到 New Relic (PREVIEW) 集成并点击 Connect。

  4. 输入你的 New Relic API key,选择托管你的 New Relic 账户的区域,然后点击 Test Integration。

    • 如果测试成功,会显示 Confirm 按钮。
    • 如果测试失败,会显示错误消息。请根据消息进行故障排查,然后重试集成。
  5. 点击 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 实例的以下指标。

指标名称指标类型标签描述
tidb_cloud.db_total_connectiongaugeinstance_id: <instance id>
instance_name: <instance name>
TiDB server 中当前连接数
tidb_cloud.db_active_connectionsgaugeinstance_id: <instance id>
instance_name: <instance name>
活跃连接数
tidb_cloud.db_disconnectionsgaugeresult: Error\|...
instance_id: <instance id>
instance_name: <instance name>
按连接结果统计的客户端断开连接数
tidb_cloud.db_database_timegaugesql_type: Select\|Insert\|...
instance_id: <instance id>
instance_name: <instance name>
TiDB 中每秒运行的所有 SQL 语句消耗的总时间,包括所有进程的 CPU 时间和非空闲等待时间
tidb_cloud.db_query_per_secondgaugetype: Select\|Insert\|...
instance_id: <instance id>
instance_name: <instance name>
按语句类型统计的每秒执行 SQL 语句数
tidb_cloud.db_failed_queriesgaugetype: planner:xxx\|executor:2345\|...
instance_id: <instance id>
instance_name: <instance name>
执行 SQL 语句时每秒发生的错误类型统计(例如语法错误和主键冲突)
tidb_cloud.db_command_per_secondgaugetype: Query\|Ping\|...
instance_id: <instance id>
instance_name: <instance name>
TiDB 每秒处理的命令数
tidb_cloud.db_queries_using_plan_cache_opsgaugeinstance_id: <instance id>
instance_name: <instance name>
每秒命中执行计划缓存的查询数
tidb_cloud.db_average_query_durationgaugesql_type: Select\|Insert\|...
instance_id: <instance id>
instance_name: <instance name>
从网络请求发送到 TiDB 到响应返回给客户端之间的持续时间
tidb_cloud.db_transaction_per_secondgaugetype: Commit\|Rollback\|...
txn_mode: optimistic\|pessimistic
instance_id: <instance id>
instance_name: <instance name>
每秒执行的事务数
tidb_cloud.db_row_storage_used_bytesgaugeinstance_id: <instance id>
instance_name: <instance name>
TiDB Cloud Essential 实例基于行的存储大小(字节)
tidb_cloud.db_columnar_storage_used_bytesgaugeinstance_id: <instance id>
instance_name: <instance name>
TiDB Cloud Essential 实例的列式存储大小(字节)。如果未启用 TiFlash,则返回 0。
tidb_cloud.resource_manager_resource_request_unit_totalgaugeinstance_id: <instance id>
instance_name: <instance name>
消耗的总 Request Units/s(RU/s)
tidb_cloud.cdc_changefeed_latencygaugechangefeed_id: <changefeed-id>
instance_id: <instance id>
instance_name: <instance name>
changefeed 上游与下游之间的数据复制延时
tidb_cloud.cdc_changefeed_statusgaugechangefeed_id: <changefeed-id>
instance_id: <instance id>
instance_name: <instance name>
Changefeed 状态:
-1: Unknown
0: Normal
1: Warning
2: Failed
3: Stopped
4: Finished
6: Warning
7: Other

文档内容是否有帮助?