- Docs Home
- About TiDB Cloud
- Get Started
- Develop Applications
- Overview
- Quick Start
- Build a TiDB Developer Cluster
- CRUD SQL in TiDB
- Build a Simple CRUD App with TiDB
- Example Applications
- Connect to TiDB
- Design Database Schema
- Write Data
- Read Data
- Transaction
- Optimize
- Troubleshoot
- Reference
- Cloud Native Development Environment
- Manage Cluster
- Plan Your Cluster
- Create a TiDB Cluster
- Connect to Your TiDB Cluster
- Set Up VPC Peering Connections
- Use an HTAP Cluster with TiFlash
- Scale a TiDB Cluster
- Upgrade a TiDB Cluster
- Delete a TiDB Cluster
- Use TiDB Cloud API (Beta)
- Migrate Data
- Import Sample Data
- Migrate Data into TiDB
- Configure Amazon S3 Access and GCS Access
- Migrate from MySQL-Compatible Databases
- Migrate Incremental Data from MySQL-Compatible Databases
- Migrate from Amazon Aurora MySQL in Bulk
- Import or Migrate from Amazon S3 or GCS to TiDB Cloud
- Import CSV Files from Amazon S3 or GCS into TiDB Cloud
- Import Apache Parquet Files from Amazon S3 or GCS into TiDB Cloud
- Troubleshoot Access Denied Errors during Data Import from Amazon S3
- Export Data from TiDB
- Back Up and Restore
- Monitor and Alert
- Overview
- Built-in Monitoring
- Built-in Alerting
- Third-Party Monitoring Integrations
- Tune Performance
- Overview
- Analyze Performance
- SQL Tuning
- Overview
- Understanding the Query Execution Plan
- SQL Optimization Process
- Overview
- Logic Optimization
- Physical Optimization
- Prepare Execution Plan Cache
- Control Execution Plans
- TiKV Follower Read
- Coprocessor Cache
- Garbage Collection (GC)
- Tune TiFlash performance
- Manage User Access
- Billing
- Reference
- TiDB Cluster Architecture
- TiDB Cloud Cluster Limits and Quotas
- TiDB Limitations
- SQL
- Explore SQL with TiDB
- SQL Language Structure and Syntax
- SQL Statements
ADD COLUMNADD INDEXADMINADMIN CANCEL DDLADMIN CHECKSUM TABLEADMIN CHECK [TABLE|INDEX]ADMIN SHOW DDL [JOBS|QUERIES]ALTER DATABASEALTER INDEXALTER TABLEALTER TABLE COMPACTALTER USERANALYZE TABLEBATCHBEGINCHANGE COLUMNCOMMITCHANGE DRAINERCHANGE PUMPCREATE [GLOBAL|SESSION] BINDINGCREATE DATABASECREATE INDEXCREATE ROLECREATE SEQUENCECREATE TABLE LIKECREATE TABLECREATE USERCREATE VIEWDEALLOCATEDELETEDESCDESCRIBEDODROP [GLOBAL|SESSION] BINDINGDROP COLUMNDROP DATABASEDROP INDEXDROP ROLEDROP SEQUENCEDROP STATSDROP TABLEDROP USERDROP VIEWEXECUTEEXPLAIN ANALYZEEXPLAINFLASHBACK TABLEFLUSH PRIVILEGESFLUSH STATUSFLUSH TABLESGRANT <privileges>GRANT <role>INSERTKILL [TIDB]MODIFY COLUMNPREPARERECOVER TABLERENAME INDEXRENAME TABLEREPLACEREVOKE <privileges>REVOKE <role>ROLLBACKSELECTSET DEFAULT ROLESET [NAMES|CHARACTER SET]SET PASSWORDSET ROLESET TRANSACTIONSET [GLOBAL|SESSION] <variable>SHOW ANALYZE STATUSSHOW [GLOBAL|SESSION] BINDINGSSHOW BUILTINSSHOW CHARACTER SETSHOW COLLATIONSHOW [FULL] COLUMNS FROMSHOW CREATE SEQUENCESHOW CREATE TABLESHOW CREATE USERSHOW DATABASESSHOW DRAINER STATUSSHOW ENGINESSHOW ERRORSSHOW [FULL] FIELDS FROMSHOW GRANTSSHOW INDEX [FROM|IN]SHOW INDEXES [FROM|IN]SHOW KEYS [FROM|IN]SHOW MASTER STATUSSHOW PLUGINSSHOW PRIVILEGESSHOW [FULL] PROCESSSLISTSHOW PROFILESSHOW PUMP STATUSSHOW SCHEMASSHOW STATS_HEALTHYSHOW STATS_HISTOGRAMSSHOW STATS_METASHOW STATUSSHOW TABLE NEXT_ROW_IDSHOW TABLE REGIONSSHOW TABLE STATUSSHOW [FULL] TABLESSHOW [GLOBAL|SESSION] VARIABLESSHOW WARNINGSSHUTDOWNSPLIT REGIONSTART TRANSACTIONTABLETRACETRUNCATEUPDATEUSEWITH
- Data Types
- Functions and Operators
- Overview
- Type Conversion in Expression Evaluation
- Operators
- Control Flow Functions
- String Functions
- Numeric Functions and Operators
- Date and Time Functions
- Bit Functions and Operators
- Cast Functions and Operators
- Encryption and Compression Functions
- Locking Functions
- Information Functions
- JSON Functions
- Aggregate (GROUP BY) Functions
- Window Functions
- Miscellaneous Functions
- Precision Math
- Set Operations
- List of Expressions for Pushdown
- TiDB Specific Functions
- Clustered Indexes
- Constraints
- Generated Columns
- SQL Mode
- Table Attributes
- Transactions
- Views
- Partitioning
- Temporary Tables
- Cached Tables
- Character Set and Collation
- Read Historical Data
- System Tables
mysql- INFORMATION_SCHEMA
- Overview
ANALYZE_STATUSCLIENT_ERRORS_SUMMARY_BY_HOSTCLIENT_ERRORS_SUMMARY_BY_USERCLIENT_ERRORS_SUMMARY_GLOBALCHARACTER_SETSCLUSTER_INFOCOLLATIONSCOLLATION_CHARACTER_SET_APPLICABILITYCOLUMNSDATA_LOCK_WAITSDDL_JOBSDEADLOCKSENGINESKEY_COLUMN_USAGEPARTITIONSPROCESSLISTREFERENTIAL_CONSTRAINTSSCHEMATASEQUENCESSESSION_VARIABLESSLOW_QUERYSTATISTICSTABLESTABLE_CONSTRAINTSTABLE_STORAGE_STATSTIDB_HOT_REGIONS_HISTORYTIDB_INDEXESTIDB_SERVERS_INFOTIDB_TRXTIFLASH_REPLICATIKV_REGION_PEERSTIKV_REGION_STATUSTIKV_STORE_STATUSUSER_PRIVILEGESVIEWS
- System Variables
- API Reference
- Storage Engines
- Dumpling
- Table Filter
- Troubleshoot Inconsistency Between Data and Indexes
- FAQs
- Release Notes
- Support
- Glossary
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. Integrate with your Datadog API Key
On the TiDB Cloud console, choose a target project for Datadog integration, and then click the Project Settings tab.
In the left pane, click Integrations.
Click Integration to Datadog.
Enter your API key of Datadog and choose the site of Datadog.
Click Test Integration.
- If the test successes, the Confirm button is displayed.
- If the test fails, an error message is displayed. Follow the message for troubleshooting and retry the integration.
Click Confirm to complete the integration.
Step 2. 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/TiFlash 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/TiFlash 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/TiFlash 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/TiFlash 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/TiFlash 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/TiFlash nodes |
Was this page helpful?