将 TiDB Cloud 与 Datadog 集成(Beta)
TiDB Cloud 支持 Datadog 集成(beta)。你可以配置 TiDB Cloud 将 TiDB 集群的指标数据发送到 Datadog。之后,你可以直接在 Datadog 仪表板中查看这些指标。
前提条件
要将 TiDB Cloud 与 Datadog 集成,你必须拥有 Datadog 账户和 Datadog API 密钥。首次创建 Datadog 账户时,Datadog 会授予你一个 API 密钥。
如果你没有 Datadog 账户,请在 https://app.datadoghq.com/signup 注册。
要编辑 TiDB Cloud 的第三方集成设置,你必须在 TiDB Cloud 中拥有组织的
Organization Owner
访问权限或目标项目的Project Member
访问权限。
限制
你不能在 TiDB Cloud Serverless 集群中使用 Datadog 集成。
当集群状态为 CREATING、RESTORING、PAUSED 或 RESUMING 时,Datadog 集成不可用。
步骤
步骤 1. 与你的 Datadog API 密钥集成
在 TiDB Cloud 控制台中,使用左上角的组合框切换到目标项目。
在左侧导航栏中,点击项目设置 > 集成。
在集成页面上,点击 Datadog 集成(BETA)。
输入你的 Datadog API 密钥并选择 Datadog 的站点。
点击测试集成。
- 如果测试成功,将显示确认按钮。
- 如果测试失败,将显示错误消息。按照消息进行故障排除并重试集成。
点击确认以完成集成。
步骤 2. 在 Datadog 中安装 TiDB Cloud 集成
- 登录 Datadog。
- 在 Datadog 中转到 TiDB Cloud 集成页面(https://app.datadoghq.com/account/settings#integrations/tidb-cloud)。
- 在配置标签中,点击安装集成。TiDBCloud 集群概览仪表板将显示在你的仪表板列表中。
预构建仪表板
点击集成中 Datadog 卡片的仪表板链接。你可以看到 TiDB 集群的预构建仪表板。
Datadog 可用的指标
Datadog 跟踪 TiDB 集群的以下指标数据。
指标名称 | 指标类型 | 标签 | 描述 |
---|---|---|---|
tidb_cloud.db_database_time | gauge | sql_type: Select|Insert|... cluster_name: <cluster name> instance: tidb-0|tidb-1… component: tidb | TiDB 中运行的所有 SQL 语句每秒消耗的总时间,包括所有进程的 CPU 时间和非空闲等待时间。 |
tidb_cloud.db_query_per_second | gauge | type: Select|Insert|... cluster_name: <cluster name> instance: tidb-0|tidb-1… component: tidb | 所有 TiDB 实例每秒执行的 SQL 语句数量,按 SELECT、INSERT、UPDATE 和其他类型的语句计数。 |
tidb_cloud.db_average_query_duration | gauge | sql_type: Select|Insert|... cluster_name: <cluster name> instance: tidb-0|tidb-1… component: tidb | 从客户端的网络请求发送到 TiDB 到 TiDB 执行后将请求返回给客户端的时间间隔。 |
tidb_cloud.db_failed_queries | gauge | type: executor:xxxx|parser:xxxx|... cluster_name: <cluster name> instance: tidb-0|tidb-1… component: tidb | 根据每个 TiDB 实例每秒发生的 SQL 执行错误(如语法错误和主键冲突)统计的错误类型。 |
tidb_cloud.db_total_connection | gauge | cluster_name: <cluster name> instance: tidb-0|tidb-1… component: tidb | TiDB 服务器中的当前连接数。 |
tidb_cloud.db_active_connections | gauge | cluster_name: <cluster name> instance: tidb-0|tidb-1… component: tidb | 活动连接数。 |
tidb_cloud.db_disconnections | gauge | result: ok|error|undetermined cluster_name: <cluster name> instance: tidb-0|tidb-1… component: tidb | 断开连接的客户端数量。 |
tidb_cloud.db_command_per_second | gauge | type: Query|StmtPrepare|... cluster_name: <cluster name> instance: tidb-0|tidb-1… component: tidb | TiDB 每秒处理的命令数,根据命令执行结果的成功或失败进行分类。 |
tidb_cloud.db_queries_using_plan_cache_ops | gauge | cluster_name: <cluster name> instance: tidb-0|tidb-1… component: tidb | 每秒使用执行计划缓存的查询统计。执行计划缓存仅支持预处理语句命令。 |
tidb_cloud.db_transaction_per_second | gauge | txn_mode: pessimistic|optimistic type: abort|commit|... cluster_name: <cluster name> instance: tidb-0|tidb-1… component: tidb | 每秒执行的事务数。 |
tidb_cloud.node_storage_used_bytes | gauge | cluster_name: <cluster name> instance: tikv-0|tikv-1…|tiflash-0|tiflash-1… component: tikv|tiflash | TiKV/TiFlash 节点的磁盘使用量,以字节为单位。 |
tidb_cloud.node_storage_capacity_bytes | gauge | cluster_name: <cluster name> instance: tikv-0|tikv-1…|tiflash-0|tiflash-1… component: tikv|tiflash | TiKV/TiFlash 节点的磁盘容量,以字节为单位。 |
tidb_cloud.node_cpu_seconds_total | count | cluster_name: <cluster name> instance: tidb-0|tidb-1…|tikv-0…|tiflash-0… component: tidb|tikv|tiflash | TiDB/TiKV/TiFlash 节点的 CPU 使用率。 |
tidb_cloud.node_cpu_capacity_cores | gauge | cluster_name: <cluster name> instance: tidb-0|tidb-1…|tikv-0…|tiflash-0… component: tidb|tikv|tiflash | TiDB/TiKV/TiFlash 节点的 CPU 核心限制。 |
tidb_cloud.node_memory_used_bytes | gauge | cluster_name: <cluster name> instance: tidb-0|tidb-1…|tikv-0…|tiflash-0… component: tidb|tikv|tiflash | TiDB/TiKV/TiFlash 节点的已用内存,以字节为单位。 |
tidb_cloud.node_memory_capacity_bytes | gauge | cluster_name: <cluster name> instance: tidb-0|tidb-1…|tikv-0…|tiflash-0… component: tidb|tikv|tiflash | TiDB/TiKV/TiFlash 节点的内存容量,以字节为单位。 |