遥测

    TiDB、TiUP 及 TiDB Dashboard 默认会收集使用情况信息，并将这些信息分享给 PingCAP 用于改善产品，例如，通过这些使用信息，PingCAP 可以了解常见的 TiDB 集群操作，从而确定新功能优先级。

    以下章节具体描述了各个组件收集并分享的使用情况信息。若收集的使用情况信息有变化，将在版本更新说明中告知。

    当 TiDB 遥测功能开启时，TiDB 集群将会以 6 小时为周期收集使用情况信息并分享给 PingCAP，包括（但不限于）：

    • 随机生成的遥测标示符
    • 集群的部署情况，包括各个组件所在的硬件信息（CPU、内存、磁盘）、组件版本号、操作系统版本号等
    • 系统组件的使用情况，例如 Async Commit 功能是否有被使用

    可以通过执行以下 SQL 语句查看 TiDB 收集的使用情况信息内容：

    TiDB Dashboard

    • 随机生成的遥测标示符
    • 用户浏览器及操作系统信息，如浏览器名称和版本号、操作系统名称、屏幕分辨率等

    可以使用 的网络功能或 的网络监视器功能查看 TiDB Dashboard 发送的使用情况信息内容。

    当 TiUP 遥测功能开启时，执行 TiUP 命令时会将使用情况信息分享给 PingCAP，包括（但不限于）：

    • 随机生成的遥测标示符
    • TiUP 命令的执行情况，如命令执行是否成功、命令执行耗时等
    • 使用 TiUP 进行部署的情况，如部署的目标机器硬件信息、组件版本号、修改过的部署配置名称等

    使用 TiUP 时，可通过设置 环境变量输出执行命令时收集的使用情况信息，例如：

    1. TIUP_CLUSTER_DEBUG=enable tiup cluster list

    部署 TiDB 时禁用 TiDB 遥测

    部署 TiDB 集群时，可以为每个 TiDB 集群设置 以禁用 TiDB 遥测功能。也可以在已部署的 TiDB 集群上修改该配置项，但需要重启集群后才能生效。

    以下是在各个部署工具中修改遥测配置的具体步骤。

    通过二进制手工部署 创建配置文件 tidb_config.toml 包含如下内容： toml enable-telemetry = false 启动 TiDB 时指定命令行参数 --config=tidb_config.toml 使得该配置生效。 详情参见 TiDB 配置参数、。 通过 TiUP Playground 试用 创建配置文件 tidb_config.toml 包含如下内容： toml enable-telemetry = false 启动 TiUP Playground 时，指定命令行参数 --db.config tidb_config.toml 使得该配置生效，如： shell tiup playground --db.config tidb_config.toml 详情参见 TiUP - 本地快速部署 TiDB 集群。 通过 TiUP Cluster 部署 修改部署拓扑文件 ，新增（或在现有项中添加）以下内容： yaml server_configs: tidb: enable-telemetry: false 通过 TiDB Operator 在 Kubernetes 上部署 在 tidb-cluster.yaml 中或者 TidbCluster Custom Resource 中配置 spec.tidb.config.enable-telemetry: false。 详情参见。 > 注意： > > 该配置需使用 TiDB Operator v1.1.3 或更高版本才能生效。

    对于已部署的 TiDB 集群，还可以修改系统全局变量 tidb_enable_telemetry 动态禁用 TiDB 遥测功能：

    禁用 TiDB Dashboard 遥测

    可以修改 PD 配置中 禁用 TiDB Dashboard 遥测功能。对于已启动的集群，该配置需要重启后才能生效。

    以下列出在各个部署工具中修改遥测配置的具体步骤。

    通过二进制手工部署 创建配置文件 pd_config.toml 包含如下内容： toml [dashboard] enable-telemetry = false 启动 PD 时指定命令行参数 --config=pd_config.toml 使得该配置生效。 详情参见 PD 配置参数、。 通过 TiUP Playground 试用 创建配置文件 pd_config.toml 包含如下内容： 启动 TiUP Playground 时，指定命令行参数 --pd.config pd_config.toml 使得该配置生效，如： shell tiup playground --pd.config pd_config.toml 详情参见 TiUP - 本地快速部署 TiDB 集群。 通过 TiUP Cluster 部署 修改部署拓扑文件 topology.yaml，新增（或在现有项中添加）以下内容： yaml server_configs: pd: dashboard.enable-telemetry: false 通过 TiDB Operator 在 Kubernetes 上部署 在 tidb-cluster.yaml 中或者 TidbCluster Custom Resource 中配置 spec.pd.config.dashboard.enable-telemetry: false。 详情参见。 > 注意： > > 该配置需使用 TiDB Operator v1.1.3 或更高版本才能生效。

    可通过执行以下命令禁用 TiUP 遥测功能：

    1. tiup telemetry disable

    对于 TiDB 遥测，可通过执行以下 SQL 语句查看遥测状态：

    若 DATA_PREVIEW 列为空，说明遥测没有开启，否则说明遥测已开启。还可以从 LAST_STATUS 列了解上次分享使用情况信息的时间、是否成功等。

    对于 TiUP 遥测，可通过执行以下命令查看遥测状态：

    • 若为中国大陆以外 IP 地址，使用情况信息将会发送并存储于美国的公有云服务器。

    可参阅 PingCAP 隐私声明了解详情。