- Introduction
- Quick Start
- Perform a PoC
- Use Your Cluster
- Create a TiDB Cluster
- Connect to Your TiDB Cluster
- Set Up VPC Peering Connections
- Monitor a TiDB Cluster
- Overview
- Built-in Alerting
- Third-Party Monitoring Integrations
- Scale a TiDB Cluster
- Use an HTAP Cluster
- Back Up and Restore Data
- Tune Performance
- Upgrade a TiDB Cluster
- Delete a TiDB Cluster
- Migrate Data
- Import Sample Data
- Migrate Data into TiDB
- Export Data from TiDB
- Manage User Access
- Billing
- Reference
- Support
- FAQs
- Glossary
- Release Notes
Datadog Integration
You can configure TiDB Cloud to send metric data about your TiDB clusters to Datadog. After that, you can view these metrics in your Datadog dashboards directly.
Prerequisites
To integrate TiDB Cloud with Datadog, you must have a Datadog account and a Datadog API key. Datadog grants you an API key when you first create a Datadog account.
If you do not have a Datadog account, sign up at https://app.datadoghq.com/signup.
To edit third-party integration settings of TiDB Cloud, you must have the
Organization Owneraccess to your organization orProject Memberaccess to the target project in TiDB Cloud.
Limitation
You cannot use the Datadog integration in Developer Tier clusters.
Steps
Step 1. View the datadog integration
- On the TiDB Cloud console, click the account name in the upper-right corner of the window.
- Click Preferences. The project preferences page is displayed.
- In the Integrations column, click the Datadog icon of a project that you want to view or modify. The Integration page of the project is displayed.
Step 2. Integrate with your Datadog API Key
- On the Integration page, enter your API Key of Datadog, and choose the Site of Datadog.
- Click Test Integration, and then click Confirm.
Step 3. Install TiDB Cloud Integration in Datadog
- Log in to Datadog.
- Go to the TiDB Cloud Integration page (https://app.datadoghq.com/account/settings#integrations/tidb-cloud) in Datadog.
- In the Configuration tab, click Install Integration. The TiDBCloud Cluster Overview dashboard is displayed in your Dashboard List.
Pre-built dashboard
Click the Dashboard link in the Datadog card of the integrations. You can see the pre-built dashboard of your TiDB clusters.
Metrics available to Datadog
Datadog tracks the following metric data for your TiDB clusters.
| Metric name | Metric type | Labels | Description |
|---|---|---|---|
| tidb_cloud.db_queries_total | count | sql_type: Select\|Insert\|...cluster_name: <cluster name>instance: tidb-0\|tidb-1…component: tidb | The total number of statements executed |
| tidb_cloud.db_failed_queries_total | count | type: planner:xxx\|executor:2345\|...cluster_name: <cluster name>instance: tidb-0\|tidb-1…component: tidb | The total number of execution errors |
| tidb_cloud.db_connections | gauge | cluster_name: <cluster name>instance: tidb-0\|tidb-1…component: tidb | Current number of connections in your TiDB server |
| tidb_cloud.db_query_duration_seconds | histogram | sql_type: Select\|Insert\|...cluster_name: <cluster name>instance: tidb-0\|tidb-1…component: tidb | The duration histogram of statements |
| tidb_cloud.node_storage_used_bytes | gauge | cluster_name: <cluster name>instance: tikv-0\|tikv-1…\|tiflash-0\|tiflash-1…component: tikv\|tiflash | The disk usage bytes of TiKV/TiFlashbeta nodes |
| tidb_cloud.node_storage_capacity_bytes | gauge | cluster_name: <cluster name>instance: tikv-0\|tikv-1…\|tiflash-0\|tiflash-1…component: tikv\|tiflash | The disk capacity bytes of TiKV/TiFlashbeta nodes |
| tidb_cloud.node_cpu_seconds_total | count | cluster_name: <cluster name>instance: tidb-0\|tidb-1…\|tikv-0…\|tiflash-0…component: tidb\|tikv\|tiflash | The CPU usage of TiDB/TiKV/TiFlashbeta nodes |
| tidb_cloud.node_cpu_capacity_cores | gauge | cluster_name: <cluster name>instance: tidb-0\|tidb-1…\|tikv-0…\|tiflash-0…component: tidb\|tikv\|tiflash | The CPU limit cores of TiDB/TiKV/TiFlashbeta nodes |
| tidb_cloud.node_memory_used_bytes | gauge | cluster_name: <cluster name>instance: tidb-0\|tidb-1…\|tikv-0…\|tiflash-0…component: tidb\|tikv\|tiflash | The used memory bytes of TiDB/TiKV/TiFlashbeta nodes |
| tidb_cloud.node_memory_capacity_bytes | gauge | cluster_name: <cluster name>instance: tidb-0\|tidb-1…\|tikv-0…\|tiflash-0…component: tidb\|tikv\|tiflash | The memory capacity bytes of TiDB/TiKV/TiFlashbeta nodes |