PingCAP Clinic Diagnostic Data

PingCAP Clinic Diagnostic Service (PingCAP Clinic) collects diagnostic data from TiDB clusters that are deployed using TiDB Operator. This document lists the types of data collected and their corresponding parameters.

When you collect data using Diag client (Diag), you can add the required parameters to the command according to your needs.

The diagnostic data collected by PingCAP Clinic is only used for troubleshooting cluster problems.

Clinic Server is a diagnostic service deployed in the cloud. There are two independent services based on different storage locations:

  • Clinic Server in the US: If you upload the collected data to Clinic Server in the US, the data will be stored in the Amazon S3 set up by PingCAP in AWS US regions. PingCAP strictly controls permissions for data and only allows authorized internal technical support staff to access the data.
  • Clinic Server in the Chinese mainland: If you upload the collected data to Clinic Server in the Chinese mainland, the data will be stored in the Amazon S3 set up by PingCAP in AWS China (Beijing) regions. PingCAP strictly controls permissions for data and only allows authorized internal technical support staff to access the data.

TiDB cluster information

Data typeExported fileParameter for PingCAP Clinic
Basic information of the cluster, including the cluster IDcluster.jsonThe data is collected per run by default.
Detailed information of the clustertidbcluster.jsonThe data is collected per run by default.

TiDB diagnostic data

Data typeExported fileParameter for PingCAP Clinic
Real-time configurationconfig.jsoncollectors:config

TiKV diagnostic data

Data typeExported fileParameter for PingCAP Clinic
Real-time configurationconfig.jsoncollectors:config

PD diagnostic data

Data typeExported fileParameter for PingCAP Clinic
Real-time configurationconfig.jsoncollectors:config
Outputs of the command tiup ctl pd -u http://${pd IP}:${PORT} storestore.jsoncollectors:config
Outputs of the command tiup ctl pd -u http://${pd IP}:${PORT} config placement-rules showplacement-rule.jsoncollectors:config

TiFlash diagnostic data

Data typeExported fileParameter for PingCAP Clinic
Real-time configurationconfig.jsoncollectors:config

TiCDC diagnostic data

Data typeExported fileParameter for PingCAP Clinic
Real-time configurationconfig.jsoncollectors:config
Debug datainfo.txt, status.txt, changefeeds.txt, captures.txt, processors.txtcollectors:debug (Diag does not collect this data type by default)

Prometheus monitoring data

Data typeExported fileParameter for PingCAP Clinic
All Metrics data{metric_name}.jsoncollectors:monitor
Alert configurationalerts.jsoncollectors:monitor
Was this page helpful?