PingCAP Clinic Diagnostic Data

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.

Clinic Server is a diagnostic service deployed in the cloud. Currently, you can upload the collected diagnostic data to Clinic Server China only. The uploaded data is stored in the AWS S3 China (Beijing) region server set up by PingCAP. Clinic Server Global will be provided soon with a new URL and data storage location. For details, see PingCAP Clinic components.

PingCAP strictly controls permissions for data access and only allows authorized in-house technical support staff to access the uploaded data.

After a technical support case is closed, PingCAP permanently deletes or anonymizes the corresponding data within 90 days.

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 typeExported fileParameter for data collection by PingCAP Clinic
Basic information of the cluster, including the cluster IDcluster.jsonThe data is collected per run by default.
Detailed information of the clustermeta.yamlThe data is collected per run by default.

TiDB diagnostic data

Data typeExported fileParameter for data collection by PingCAP Clinic
Logtidb.log--include=log
Error logtidb_stderr.log--include=log
Slow logtidb_slow_query.log--include=log
Configuration filetidb.toml--include=config
Real-time configurationconfig.json--include=config
Performance datacpu_profile.proto, mem_heap.proto, goroutine.txt, mutex.txt--include=perf

TiKV diagnostic data

Data typeExported fileParameter for data collection by PingCAP Clinic
Logtikv.log--include=log
Error logtikv_stderr.log--include=log
Configuration filetikv.toml--include=config
Real-time configurationconfig.json--include=config
Performance datacpu_profile.proto--include=perf

PD diagnostic data

Data typeExported fileParameter for data collection by PingCAP Clinic
Logpd.log--include=log
Error logpd_stderr.log--include=log
Configuration filepd.toml--include=config
Real-time configurationconfig.json--include=config
Outputs of the command tiup ctl pd -u http://${pd IP}:${PORT} storestore.json--include=config
Outputs of the command tiup ctl pd -u http://${pd IP}:${PORT} config placement-rules showplacement-rule.json--include=config
Performance datacpu_profile.proto, mem_heap.proto, goroutine.txt, mutex.txt--include=perf

TiFlash diagnostic data

Data typeExported fileParameter for data collection by PingCAP Clinic
Logtiflash.log--include=log
Error logtiflash_stderr.log--include=log
Configuration filetiflash-learner.tomltiflash-preprocessed.tomltiflash.toml--include=config
Real-time configurationconfig.json--include=config
Performance datacpu_profile.proto--include=perf

TiCDC diagnostic data

Data typeExported fileParameter for data collection by PingCAP Clinic
Logticdc.log--include=log
Error logticdc_stderr.log--include=log
Configuration fileticdc.toml--include=config
Performance datacpu_profile.proto, mem_heap.proto, goroutine.txt, mutex.txt--include=perf
Debug datainfo.txt, status.txt, changefeeds.txt, captures.txt, processors.txt--include=debug

Prometheus monitoring data

Data typeExported fileParameter for data collection by PingCAP Clinic
All metrics data{metric_name}.json--include=monitor
All alerts dataalerts.json--include=monitor

TiDB system variables

Data typeExported fileParameter for data collection by PingCAP Clinic
TiDB system variables (Diag does not collect this data type by default; if you need to collect this data type, database credential is required)mysql.tidb.csv--include=db_vars
global_variables.csv--include=db_vars

System information of the cluster node

Data typeExported fileParameter for data collection by PingCAP Clinic
Kernel logdmesg.log--include=system
Basic information of the system and hardwareinsight.json--include=system
Contents in the /etc/security/limits.conflimits.conf--include=system
List of kernel parameterssysctl.conf--include=system
Socket system information, which is the output of the ss commandss.txt--include=system

DM clusters

This section lists the types of diagnostic data that can be collected by Diag from the DM clusters deployed using TiUP.

DM cluster information

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

dm-master diagnostic data

Data typeExported fileParameter for data collection by PingCAP Clinic
Logm-master.log--include=log
Error logdm-master_stderr.log--include=log
Configuration filedm-master.toml--include=config

dm-worker diagnostic data

Data typeExported fileParameter for data collection by PingCAP Clinic
Logdm-worker.log--include=log
Error logdm-worker_stderr.log--include=log
Configuration filedm-work.toml--include=config

Prometheus monitoring data

Data typeExported fileParameter for data collection by PingCAP Clinic
All metrics data{metric_name}.json--include=monitor
All alerts dataalerts.json--include=monitor

System information of the cluster node

Data typeExported fileParameter for data collection by PingCAP Clinic
Kernel logdmesg.log--include=system
Basic information of the system and hardwareinsight.json--include=system
Contents in the /etc/security/limits.conf systemlimits.conf--include=system
List of kernel parameterssysctl.conf--include=system
Socket system information, which is the output of the ss commandss.txt--include=system
Was this page helpful?