Doc Menu

tiup telemetry

TiDB, TiUP, and TiDB Dashboard collect usage information by default and share the information with PingCAP to improve the product. For example, through this usage information, PingCAP learns about common TiDB cluster operations and thereby determines the priority of new features.

When TiUP telemetry is enabled, usage information is shared with PingCAP when TiUP commands are executed, including (but not limited to):

  • Randomly generated telemetry identifiers.
  • The execution status of the TiUP command, such as whether the command execution is successful and the duration of command execution.
  • Situations using TiUP for deployment, such as target machine hardware information, component version number, and modified deployment configuration name.

The information below is not shared:

  • The accurate name of the cluster
  • The cluster topology
  • The cluster configuration file

TiUP uses the tiup telemetry command to control telemetry.

Note:

This feature is enabled by default.

Syntax

tiup telemetry <command>

<command> stands for sub-commands. For the list of supported sub-commands, refer to the commands section below.

Commands

status

The tiup telemetry status command is used to view the current telemetry settings and output the following information:

  • status: specifies enabling or disabling the telemetry (enable|disable).
  • uuid: specifies the randomly generated telemetry identifiers.

reset

The tiup telemetry reset command is used to reset the current telemetry identifier and replaces it with a new random identifier.

enable

The tiup telemetry enable command is used to enable the telemetry.

disable

The tiup telemetry disable command is used to disable the telemetry.

<< Back to the previous page - TiUP Reference command list