This document provides the types of diagnostic data that can be collected by PingCAP Clinic Diagnostic Service (PingCAP Clinic) from the TiDB and DM clusters deployed using TiUP. Also, the document lists the parameters for data collection corresponding to each data type. When running a command to collect data using Diag client (Diag), you can add the required parameters to the command according to the types of the data to be collected.
The diagnostic data collected by PingCAP Clinic is only used for troubleshooting cluster problems.
A diagnostic service deployed in the cloud, Clinic Server provides two independent services depending on the data storage location:
Clinic Server for international users: If you upload the collected data to Clinic Server for international users, the data will be stored in the Amazon S3 service deployed by PingCAP in AWS US regions. PingCAP uses strict data access policies and only authorized technical support can access the data.
Clinic Server for users in the Chinese mainland: If you upload the collected data to Clinic Server for users in the Chinese mainland, the data will be stored in the Amazon S3 service deployed by PingCAP in China (Beijing) regions. PingCAP uses strict data access policies and only authorized technical support can access the data.
TiDB clusters
This section lists the types of diagnostic data that can be collected by Diag from the TiDB clusters deployed using TiUP.
TiDB cluster information
Data type
Exported file
Parameter for data collection by PingCAP Clinic
Basic information of the cluster, including the cluster ID
cluster.json
The data is collected per run by default.
Detailed information of the cluster
meta.yaml
The data is collected per run by default.
TiDB diagnostic data
Data type
Exported file
Parameter for data collection by PingCAP Clinic
Log
tidb.log
--include=log
Error log
tidb_stderr.log
--include=log
Slow log
tidb_slow_query.log
--include=log
Configuration file
tidb.toml
--include=config
Real-time configuration
config.json
--include=config
TiKV diagnostic data
Data type
Exported file
Parameter for data collection by PingCAP Clinic
Log
tikv.log
--include=log
Error log
tikv_stderr.log
--include=log
Configuration file
tikv.toml
--include=config
Real-time configuration
config.json
--include=config
PD diagnostic data
Data type
Exported file
Parameter for data collection by PingCAP Clinic
Log
pd.log
--include=log
Error log
pd_stderr.log
--include=log
Configuration file
pd.toml
--include=config
Real-time configuration
config.json
--include=config
Outputs of the command tiup ctl:v<CLUSTER_VERSION> pd -u http://${pd IP}:${PORT} store
store.json
--include=config
Outputs of the command tiup ctl:v<CLUSTER_VERSION> pd -u http://${pd IP}:${PORT} config placement-rules show