集成 TiDB Cloud 与 Datadog（PREVIEW）

TiDB Cloud 支持与 Datadog 集成。你可以将 TiDB Cloud 配置为把你的 TiDB Cloud Essential 实例的指标发送到 Datadog。完成后，你可以直接在 Datadog 仪表板中查看这些指标。

前提条件

• 要将 TiDB Cloud 与 Datadog 集成，你必须拥有一个 Datadog 账户以及一个 Datadog API key。首次创建 Datadog 账户时，Datadog 会为你分配一个 API key。

  如果你还没有 Datadog 账户，请访问 https://app.datadoghq.com/signup 注册。

• 要为 TiDB Cloud 设置第三方指标集成，你必须在 TiDB Cloud 中具有 Organization Owner、Project Owner 或 Instance Manager 访问权限。要查看集成页面，你至少需要 Project Viewer 或 Instance Viewer 角色，以访问 TiDB Cloud 中你所在组织下目标 TiDB Cloud Essential 实例。

限制

• TiDB Cloud Starter 实例不支持 Datadog 集成。
• 当你的 TiDB Cloud Essential 实例状态为 CREATING、RESTORING、PAUSED 或 RESUMING 时，不支持 Datadog 集成。

步骤

第 1 步：导入预构建的 Datadog 仪表板

目前，适用于 TiDB Cloud Essential 的 TiDB Cloud 仪表板尚未在 Datadog 集成市场中提供。你需要手动下载仪表板 JSON 文件并将其导入 Datadog。

1. 下载适用于你的实例类型的 Datadog 仪表板 JSON 文件：

   https://github.com/pingcap/docs/blob/master/tidb-cloud/monitor-datadog-integration-tidb-cloud-dynamic-tracker-essential.json

2. 登录 Datadog，然后进入 Dashboards > Dashboard List。

3. 点击右上角的 + New Dashboard。输入仪表板名称，然后选择 Start from blank dashboard。

4. 在新建的仪表板中，点击右上角的齿轮图标（Configure），然后选择 Import dashboard JSON...。

5. 在弹出的对话框中，粘贴 JSON 内容，或拖放 JSON 文件。

6. 点击 Yes, Replace 确认导入。

第 2 步：使用你的 Datadog API key 进行集成

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

2. 在左侧导航栏中，点击 Integrations。

3. 在 Integrations 页面上，找到 Datadog (PREVIEW) 集成并点击 Connect。

4. 输入你的 Datadog API key，选择你的 Datadog Region，然后点击 Test Integration。

   • 如果测试成功，会显示 Confirm 按钮。
   • 如果测试失败，会显示错误信息。请根据提示进行故障排查，然后重试集成。

5. 点击 Confirm 完成集成。

查看预构建的仪表板

完成集成后，要查看预构建的仪表板，请在 Datadog 中进入 Dashboards > Dashboard List，然后选择在第 1 步中导入的仪表板。在仪表板页面中，你可以按目标实例名称进行筛选并查看指标。

你也可以从 TiDB Cloud console 进入 Datadog 的 Dashboard List 页面：进入目标实例的 Integrations 页面，点击 Datadog (PREVIEW)，然后点击 Dashboard。

Datadog 可用的指标

Datadog 会跟踪你的 TiDB Cloud Essential 实例的以下指标。