TiDB Cloud

Supported OS Linux Mac OS Windows

Overview

TiDB Cloud is a fully managed cloud service of TiDB, an open-source database.

Use the TiDB Cloud Datadog integration to export metrics from TiDB Cloud clusters to Datadog.

Note:

Setup

To set up the TiDB Cloud Datadog integration for your cluster, provide a Datadog API key and region to TiDB Cloud.

See TiDB Cloud Preferences to configure the Datadog integration for your TiDB Cloud project.

Data Collected

Metrics

tidb_cloud.db_queries_total
(count)
Total number of statements executed
Shown as query
tidb_cloud.db_failed_queries_total
(count)
Total number of execution errors
Shown as query
tidb_cloud.db_connections
(gauge)
Current number of connections in TiDB server
Shown as connection
tidb_cloud.db_query_duration_seconds.count
(count)
Total number of handled queries in server
Shown as query
tidb_cloud.db_query_duration_seconds.sum
(count)
Sum of handled query duration in server
Shown as second
tidb_cloud.db_total_connection
(gauge)
The number of current connection
Shown as connection
tidb_cloud.db_active_connections
(gauge)
The number of active connection
Shown as connection
tidb_cloud.db_disconnections
(gauge)
The number of clients disconnected
Shown as connection
tidb_cloud.db_database_time
(gauge)
A time model statistic that is the sum of all process' CPU consumption plus the sum of non-idle wait time.
Shown as second
tidb_cloud.db_query_per_second
(gauge)
The number of SQL statements executed per second on all TiDB instances, which is counted according to SELECT, INSERT, UPDATE, and other types of statements
Shown as query
tidb_cloud.db_failed_queries
(gauge)
The statistics of error types (such as syntax errors and primary key conflicts) according to the errors occurred when executing SQL statements per second on each TiDB instance.
Shown as query
tidb_cloud.db_command_per_second
(gauge)
The number of commands processed by TiDB per second, which is classified according to the success or failure of command execution results
Shown as command
tidb_cloud.db_queries_using_plan_cache_ops
(gauge)
The statistics of queries using Plan Cache per second. The execution plan cache only supports the prepared statement command. If the value is 0, the execution plan cache has not been hit.
Shown as query
tidb_cloud.db_average_query_duration
(gauge)
The duration between the time that the client's network request is sent to TiDB and the time that the request is returned to the client after TiDB has executed it.
Shown as second
tidb_cloud.db_transaction_per_second
(gauge)
The number of transactions executed per second
Shown as transaction
tidb_cloud.node_storage_used_bytes
(gauge)
Disk usage bytes of TiKV/TiFlash instances
Shown as byte
tidb_cloud.node_storage_capacity_bytes
(gauge)
Disk capacity bytes of TiKV/TiFlash instances
Shown as byte
tidb_cloud.node_cpu_seconds_total
(count)
Sum of CPU usage seconds of TiDB/TiKV/TiFlash instances
Shown as second
tidb_cloud.node_cpu_capacity_cores
(gauge)
CPU limit cores of TiDB/TiKV/TiFlash instances
Shown as core
tidb_cloud.node_memory_used_bytes
(gauge)
Resident memory bytes of TiDB/TiKV/TiFlash instances
Shown as byte
tidb_cloud.node_memory_capacity_bytes
(gauge)
Memory limit bytes of TiDB/TiKV/TiFlash instances
Shown as byte

Service Checks

The TiDB Cloud integration does not include any service checks.

Events

The TiDB Cloud integration does not include any events.

Troubleshooting

Need help? Contact Datadog support.

PREVIEWING: may/unit-testing