From 225064898d6caa47ecad98c0a6e42a40e06600eb Mon Sep 17 00:00:00 2001 From: mohangjie <mohangjie1995@gmail.com> Date: Wed, 25 Jun 2025 13:46:35 +0800 Subject: [PATCH 1/7] telemetry: update telemetry related doc files --- system-variables.md | 10 ++++++---- telemetry.md | 1 + tidb-configuration-file.md | 6 ++++-- 3 files changed, 11 insertions(+), 6 deletions(-) diff --git a/system-variables.md b/system-variables.md index b913e383ed8d..1e49d363a2dc 100644 --- a/system-variables.md +++ b/system-variables.md @@ -2442,18 +2442,20 @@ Query OK, 0 rows affected (0.09 sec) - 类型:枚举型 - 从 v8.4.0 开始,该变量被废弃。其值将固定为默认值 `ON`,即默认启用[分区表](/partitioned-table.md)。 -### `tidb_enable_telemetry` <span class="version-mark">从 v4.0.2 版本开始引入,从 v8.1.0 版本开始废弃</span> +### `tidb_enable_telemetry` <span class="version-mark">从 v4.0.2 版本开始引入</span> > **警告:** > -> 从 TiDB v8.1.0 开始,TiDB 已移除遥测功能,该变量已不再生效。保留该变量仅用于与之前版本兼容。 +> 在 TiDB v8.1.0 之前,TiDB 会定期向 PingCAP 上报遥测信息。 +> +> 从 TiDB v8.1.3、v8.5.3 和 v9.0.0 起,TiDB 重新引入了遥测功能,但其行为已调整为仅将遥测相关信息输出到日志文件,不再通过网络上报。 - 作用域:GLOBAL - 是否持久化到集群:是 - 是否受 Hint [SET_VAR](/optimizer-hints.md#set_varvar_namevar_value) 控制:否 - 类型:布尔型 -- 默认值:`OFF` -- 在 v8.1.0 之前,这个变量用于动态地控制 TiDB 遥测功能是否开启。 +- 默认值:`ON` +- 该变量用于动态控制 TiDB 遥测功能是否开启。仅当 TiDB 实例的配置项 [`enable-telemetry`](/tidb-configuration-file.md#enable-telemetry-从-v402-版本开始引入) 设置为 `true` 时,该变量才会生效。 ### `tidb_enable_tiflash_read_for_write_stmt` <span class="version-mark">从 v6.3.0 版本开始引入</span> diff --git a/telemetry.md b/telemetry.md index ea46040c59ab..432833fb8c5c 100644 --- a/telemetry.md +++ b/telemetry.md @@ -13,6 +13,7 @@ aliases: ['/docs-cn/dev/telemetry/','/zh/tidb/dev/sql-statement-admin-show-telem > - 从 TiUP v1.11.3 起,TiUP 遥测功能默认关闭,即 TiUP 默认不再收集使用情况信息。如果从 v1.11.3 之前的 TiUP 版本升级至 v1.11.3 或更高 TiUP 版本,遥测保持升级前的开启或关闭状态。 > - 从 TiSpark v3.0.3 开始,TiSpark 遥测功能默认关闭,即 TiSpark 默认不收集使用情况信息。 > - 从 TiDB v8.1.0 起,TiDB 和 TiDB Dashboard 移除了遥测功能。 +> - 从 TiDB v8.1.3、v8.5.3 和 v9.0.0 起,TiDB 重新引入了遥测功能,但其行为已调整为仅将遥测相关信息输出到日志文件,不再通过网络上报。 ## 开启遥测后哪些使用情况信息会被收集? diff --git a/tidb-configuration-file.md b/tidb-configuration-file.md index 327b4ad73ba5..363a3a96094d 100644 --- a/tidb-configuration-file.md +++ b/tidb-configuration-file.md @@ -171,13 +171,15 @@ TiDB 配置文件比命令行参数支持更多的选项。你可以在 [config/ + 默认值:64 + 目前的合法值范围 `[64, 512]`。 -### `enable-telemetry` <span class="version-mark">从 v4.0.2 版本开始引入,从 v8.1.0 版本开始废弃</span> +### `enable-telemetry` <span class="version-mark">从 v4.0.2 版本开始引入</span> > **警告:** > > 从 TiDB v8.1.0 开始,TiDB 已移除遥测功能,该配置项已不再生效。保留该配置项仅用于与之前版本兼容。 +> +> 从 TiDB v8.1.3、v8.5.3 和 v9.0.0 起,TiDB 重新引入了遥测功能,并将其行为调整为仅将相关信息输出到日志文件中。 -+ 在 v8.1.0 之前,用于控制是否在 TiDB 实例上开启遥测功能。 ++ 用于控制是否在 TiDB 实例上开启遥测功能。 + 默认值:false ### `deprecate-integer-display-length` From 8d34a4091da9892d6a40c3681b47b6f324a876c3 Mon Sep 17 00:00:00 2001 From: mohangjie <mohangjie1995@gmail.com> Date: Wed, 25 Jun 2025 14:05:32 +0800 Subject: [PATCH 2/7] update --- releases/release-6.1.5.md | 6 +++--- releases/release-6.5.1.md | 4 ++-- releases/release-6.6.0.md | 2 +- releases/release-8.1.0.md | 4 ++-- system-variable-reference.md | 2 +- 5 files changed, 9 insertions(+), 9 deletions(-) diff --git a/releases/release-6.1.5.md b/releases/release-6.1.5.md index 0106a3589926..b1a0f8b56814 100644 --- a/releases/release-6.1.5.md +++ b/releases/release-6.1.5.md @@ -15,8 +15,8 @@ TiDB 版本:6.1.5 - 自 2023 年 2 月 20 日起,新发布的 TiDB 和 TiDB Dashboard 版本(包含 6.1.5),默认关闭[遥测功能](/telemetry.md),即默认不再收集使用情况信息分享给 PingCAP。如果升级至这些版本前使用默认的遥测配置,则升级后遥测功能处于关闭状态。具体的版本可参考 [TiDB 版本发布时间线](/releases/release-timeline.md)。 - - 系统变量 [`tidb_enable_telemetry`](/system-variables.md#tidb_enable_telemetry-从-v402-版本开始引入从-v810-版本开始废弃) 默认值由 `ON` 修改为 `OFF`。 - - TiDB 配置项 [`enable-telemetry`](/tidb-configuration-file.md#enable-telemetry-从-v402-版本开始引入从-v810-版本开始废弃) 默认值由 `true` 改为 `false`。 + - 系统变量 [`tidb_enable_telemetry`](/system-variables.md#tidb_enable_telemetry-从-v402-版本开始引入) 默认值由 `ON` 修改为 `OFF`。 + - TiDB 配置项 [`enable-telemetry`](/tidb-configuration-file.md#enable-telemetry-从-v402-版本开始引入) 默认值由 `true` 改为 `false`。 - PD 配置项 [`enable-telemetry`](/pd-configuration-file.md#enable-telemetry) 默认值由 `true` 改为 `false`。 - 从 v1.11.3 起,新部署的 TiUP 默认关闭遥测功能,即默认不再收集使用情况信息。如果从 v1.11.3 之前的 TiUP 版本升级至 v1.11.3 或更高 TiUP 版本,遥测保持升级前的开启或关闭状态。 @@ -48,4 +48,4 @@ TiDB 版本:6.1.5 + TiDB Data Migration (DM) - 修复 `binlog-schema delete` 命令执行失败的问题 [#7373](https://github.com/pingcap/tiflow/issues/7373) @[liumengya94](https://github.com/liumengya94) - - 修复当最后一个 binlog 是被 skip 的 DDL 时,checkpoint 不推进的问题 [#8175](https://github.com/pingcap/tiflow/issues/8175) @[D3Hunter](https://github.com/D3Hunter) \ No newline at end of file + - 修复当最后一个 binlog 是被 skip 的 DDL 时,checkpoint 不推进的问题 [#8175](https://github.com/pingcap/tiflow/issues/8175) @[D3Hunter](https://github.com/D3Hunter) diff --git a/releases/release-6.5.1.md b/releases/release-6.5.1.md index d4e956fa7a98..5441d8cef9e3 100644 --- a/releases/release-6.5.1.md +++ b/releases/release-6.5.1.md @@ -15,8 +15,8 @@ TiDB 版本:6.5.1 - 自 2023 年 2 月 20 日起,新发布的 TiDB 和 TiDB Dashboard 版本(包含 6.5.1),默认关闭[遥测功能](/telemetry.md),即默认不再收集使用情况信息分享给 PingCAP。如果升级至这些版本前使用默认的遥测配置,则升级后遥测功能处于关闭状态。具体的版本可参考 [TiDB 版本发布时间线](/releases/release-timeline.md)。 - - 系统变量 [`tidb_enable_telemetry`](/system-variables.md#tidb_enable_telemetry-从-v402-版本开始引入从-v810-版本开始废弃) 默认值由 `ON` 修改为 `OFF`。 - - TiDB 配置项 [`enable-telemetry`](/tidb-configuration-file.md#enable-telemetry-从-v402-版本开始引入从-v810-版本开始废弃) 默认值由 `true` 改为 `false`。 + - 系统变量 [`tidb_enable_telemetry`](/system-variables.md#tidb_enable_telemetry-从-v402-版本开始引入) 默认值由 `ON` 修改为 `OFF`。 + - TiDB 配置项 [`enable-telemetry`](/tidb-configuration-file.md#enable-telemetry-从-v402-版本开始引入) 默认值由 `true` 改为 `false`。 - PD 配置项 [`enable-telemetry`](/pd-configuration-file.md#enable-telemetry) 默认值由 `true` 改为 `false`。 - 从 v1.11.3 起,新部署的 TiUP 默认关闭遥测功能,即默认不再收集使用情况信息。如果从 v1.11.3 之前的 TiUP 版本升级至 v1.11.3 或更高 TiUP 版本,遥测保持升级前的开启或关闭状态。 diff --git a/releases/release-6.6.0.md b/releases/release-6.6.0.md index 8d878c0f7e62..08fefd5ee126 100644 --- a/releases/release-6.6.0.md +++ b/releases/release-6.6.0.md @@ -351,7 +351,7 @@ TiDB 版本:6.6.0-[DMR](/releases/versioning.md#开发里程碑版本) | `tidb_enable_general_plan_cache` | 修改 | 这个变量用来控制是否开启 General Plan Cache。自 v6.6.0 起,该变量更名为 [`tidb_enable_non_prepared_plan_cache`](/system-variables.md#tidb_enable_non_prepared_plan_cache)。 | | [`tidb_enable_historical_stats`](/system-variables.md#tidb_enable_historical_stats) | 修改 | 这个变量用来控制是否开启历史统计信息。默认值由 `OFF` 修改为 `ON`,表示默认开启历史统计信息。 | | [`tidb_enable_plan_replayer_capture`](/system-variables.md#tidb_enable_plan_replayer_capture) | 修改 | 这个变量从 v6.6.0 开始生效,用来控制是否开启 [`PLAN REPLAYER CAPTURE`](/sql-plan-replayer.md#使用-plan-replayer-capture-抓取目标计划)。默认值由 `OFF` 修改为 `ON`,代表默认开启 `PLAN REPLAYER CAPTURE`。 | -| [`tidb_enable_telemetry`](/system-variables.md#tidb_enable_telemetry-从-v402-版本开始引入从-v810-版本开始废弃) | 修改 | 默认值由 `ON` 修改为 `OFF`,表示默认关闭 TiDB 的遥测功能。 | +| [`tidb_enable_telemetry`](/system-variables.md#tidb_enable_telemetry-从-v402-版本开始引入) | 修改 | 默认值由 `ON` 修改为 `OFF`,表示默认关闭 TiDB 的遥测功能。 | | `tidb_general_plan_cache_size` | 修改 | 这个变量用来控制 General Plan Cache 最多能够缓存的计划数量。自 v6.6.0 起,该变量更名为 [`tidb_non_prepared_plan_cache_size`](/system-variables.md#tidb_non_prepared_plan_cache_size)。 | | [`tidb_replica_read`](/system-variables.md#tidb_replica_read-从-v40-版本开始引入) | 修改 | 新增选项 `learner`,指定 TiDB 从只读节点中读取数据的 learner 副本。 | | [`tidb_replica_read`](/system-variables.md#tidb_replica_read-从-v40-版本开始引入) | 修改 | 新增选项 `prefer-leader`,以提高 TiDB 集群整体的读可用性。该选项被启用时,TiDB 会优先选择 Leader 副本进行读取操作;当 Leader 副本的处理性能显著下降时,TiDB 会自动将读操作转发给 Follower 副本。| diff --git a/releases/release-8.1.0.md b/releases/release-8.1.0.md index 81b59d26f306..74c27b4e7790 100644 --- a/releases/release-8.1.0.md +++ b/releases/release-8.1.0.md @@ -173,7 +173,7 @@ TiDB 8.1.0 为长期支持版本 (Long-Term Support Release, LTS)。 | 变量名 | 修改类型 | 描述 | |--------|------------------------------|------| -| [`tidb_enable_telemetry`](/system-variables.md#tidb_enable_telemetry-从-v402-版本开始引入从-v810-版本开始废弃) | 废弃 | 从 TiDB v8.1.0 开始,TiDB 移除了遥测功能,该变量已不再生效。保留该变量仅用于与之前版本兼容。 | +| [`tidb_enable_telemetry`](/system-variables.md#tidb_enable_telemetry-从-v402-版本开始引入) | 废弃 | 从 TiDB v8.1.0 开始,TiDB 移除了遥测功能,该变量已不再生效。保留该变量仅用于与之前版本兼容。 | | [`tidb_auto_analyze_ratio`](/system-variables.md#tidb_auto_analyze_ratio) | 修改 | 取值范围从 `[0, 18446744073709551615]` 修改为 `(0, 1]`。 | | [`tidb_enable_dist_task`](/system-variables.md#tidb_enable_dist_task-从-v710-版本开始引入) | 修改 | 默认值从 `OFF` 修改为 `ON`,代表默认开启分布式执行框架,从而充分利用 TiDB 集群的资源,大幅提升 `ADD INDEX` 和 `IMPORT INTO` 任务的性能。如果要从低版本的集群升级到 v8.1.0 或更高版本,且该集群已开启分布式执行框架,为了避免升级期间 `ADD INDEX` 操作可能导致数据索引不一致的问题,请在升级前关闭分布式执行框架(即将 `tidb_enable_dist_task` 设置为 `OFF`),升级后再手动开启。| | [`tidb_service_scope`](/system-variables.md#tidb_service_scope-从-v740-版本开始引入) | 修改 | 该变量的可选值从 `""` 或 `background` 修改为长度小于或等于 64 的字符串,可用合法字符包括数字 `0-9`、字母 `a-zA-Z`、下划线 `_` 和连字符 `-`,从而更灵活地控制各 TiDB 节点的服务范围。分布式执行框架会根据该变量的值决定将分布式任务调度到哪些 TiDB 节点上执行,具体规则请参考[任务调度](/tidb-distributed-execution-framework.md#任务调度)。 | @@ -182,7 +182,7 @@ TiDB 8.1.0 为长期支持版本 (Long-Term Support Release, LTS)。 | 配置文件 | 配置项 | 修改类型 | 描述 | |----------------|--------------------|------|------------------------------------| -| TiDB | [`enable-telemetry`](/tidb-configuration-file.md#enable-telemetry-从-v402-版本开始引入从-v810-版本开始废弃) | 废弃 | 从 v8.1.0 开始,TiDB 移除了遥测功能,该配置项已不再生效。保留该配置项仅用于与之前版本兼容。 | +| TiDB | [`enable-telemetry`](/tidb-configuration-file.md#enable-telemetry-从-v402-版本开始引入) | 废弃 | 从 v8.1.0 开始,TiDB 移除了遥测功能,该配置项已不再生效。保留该配置项仅用于与之前版本兼容。 | | TiDB| [`concurrently-init-stats`](/tidb-configuration-file.md#concurrently-init-stats-从-v810-和-v752-版本开始引入) | 新增 | 用于控制 TiDB 启动时是否并发初始化统计信息。默认值为 `false`。 | | PD | [`enable-telemetry`](/pd-configuration-file.md#enable-telemetry) | 废弃 | 从 TiDB v8.1.0 开始,TiDB Dashboard 移除了遥测功能,该配置项已不再生效。保留该配置项仅用于与之前版本兼容。 | | TiDB Lightning | [`conflict.max-record-rows`](/tidb-lightning/tidb-lightning-configuration.md#tidb-lightning-任务配置) | 修改 | 从 v8.1.0 开始,TiDB Lightning 会自动将 `conflict.max-record-rows` 的值设置为 `conflict.threshold` 的值,并忽略用户输入,因此无需再单独配置 `conflict.max-record-rows`。`conflict.max-record-rows` 将在未来版本中废弃。 | diff --git a/system-variable-reference.md b/system-variable-reference.md index 5a8657bb5d4e..4f290b95e3ae 100644 --- a/system-variable-reference.md +++ b/system-variable-reference.md @@ -1932,7 +1932,7 @@ summary: 查看 TiDB 所有的系统变量,以及引用这些变量的文档 引用该变量的文档: -- [系统变量](/system-variables.md#tidb_enable_telemetry-从-v402-版本开始引入从-v810-版本开始废弃) +- [系统变量](/system-variables.md#tidb_enable_telemetry-从-v402-版本开始引入) - [TiDB 8.1.0 Release Notes](/releases/release-8.1.0.md) - [TiDB 6.6.0 Release Notes](/releases/release-6.6.0.md) - [TiDB 6.5.1 Release Notes](/releases/release-6.5.1.md) From 6a44994c0d3c34af74bec481dc31883bf6c28f0c Mon Sep 17 00:00:00 2001 From: mohangjie <mohangjie1995@gmail.com> Date: Thu, 3 Jul 2025 10:39:34 +0800 Subject: [PATCH 3/7] update --- releases/release-6.6.0.md | 2 +- releases/release-8.1.0.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/releases/release-6.6.0.md b/releases/release-6.6.0.md index 08fefd5ee126..aeec4ce8d304 100644 --- a/releases/release-6.6.0.md +++ b/releases/release-6.6.0.md @@ -379,7 +379,7 @@ TiDB 版本:6.6.0-[DMR](/releases/versioning.md#开发里程碑版本) | TiKV | `raftdb.enable-statistics` | 删除 | 该配置项指定是否开启 Raft RocksDB 的统计信息收集功能。从 v6.6.0 起,删除该配置项。所有集群默认开启统计信息收集,以便于故障排查。详情参见 [#13942](https://github.com/tikv/tikv/pull/13942)。 | | TiKV | `storage.block-cache.shared` | 删除 | 从 v6.6.0 起删除该配置项,默认开启 block cache 且无法关闭,详情参见 [#12936](https://github.com/tikv/tikv/issues/12936)。 | | DM | `on-duplicate` | 删除 | 该配置项控制全量导入阶段针对冲突数据的解决方式。自 v6.6.0 起,引入新的配置项 `on-duplicate-logical` 和 `on-duplicate-physical`,取代 `on-duplicate`。 | -| TiDB | [`enable-telemetry`](/tidb-configuration-file.md#enable-telemetry-从-v402-版本开始引入从-v810-版本开始废弃) | 修改 | 自 v6.6.0 起,该配置项默认值由 `true` 改为 `false`,表示默认关闭 TiDB 的遥测功能。 | +| TiDB | [`enable-telemetry`](/tidb-configuration-file.md#enable-telemetry-从-v402-版本开始引入) | 修改 | 自 v6.6.0 起,该配置项默认值由 `true` 改为 `false`,表示默认关闭 TiDB 的遥测功能。 | | TiKV | [`rocksdb.defaultcf.block-size`](/tikv-configuration-file.md#block-size) 和 [`rocksdb.writecf.block-size`](/tikv-configuration-file.md#block-size) | 修改 | 默认值由 `64K` 调整为 `32K`。 | | TiKV | [`rocksdb.defaultcf.block-cache-size`](/tikv-configuration-file.md#block-cache-size), [`rocksdb.writecf.block-cache-size`](/tikv-configuration-file.md#block-cache-size), [`rocksdb.lockcf.block-cache-size`](/tikv-configuration-file.md#block-cache-size) | 修改 | 从 v6.6.0 起,这三个配置项被废弃。详情参见 [#12936](https://github.com/tikv/tikv/issues/12936)。 | | PD | [`enable-telemetry`](/pd-configuration-file.md#enable-telemetry) | 修改 | 从 v6.6.0 起,该配置项的默认值由 `true` 改为 `false`,表示默认关闭 TiDB Dashboard 的遥测功能。 | diff --git a/releases/release-8.1.0.md b/releases/release-8.1.0.md index 74c27b4e7790..eb1c35f46b61 100644 --- a/releases/release-8.1.0.md +++ b/releases/release-8.1.0.md @@ -198,7 +198,7 @@ TiDB 8.1.0 为长期支持版本 (Long-Term Support Release, LTS)。 * 从 TiDB v8.1.0 开始,TiDB 和 TiDB Dashboard 移除了遥测功能: - * 废弃系统变量 [`tidb_enable_telemetry`](/system-variables.md#tidb_enable_telemetry-从-v402-版本开始引入从-v810-版本开始废弃)、TiDB 配置项 [`enable-telemetry`](/tidb-configuration-file.md#enable-telemetry-从-v402-版本开始引入从-v810-版本开始废弃) 和 PD 配置项 [`enable-telemetry`](/pd-configuration-file.md#enable-telemetry)。这些变量和配置项的值已不再生效。 + * 废弃系统变量 [`tidb_enable_telemetry`](/system-variables.md#tidb_enable_telemetry-从-v402-版本开始引入)、TiDB 配置项 [`enable-telemetry`](/tidb-configuration-file.md#enable-telemetry-从-v402-版本开始引入) 和 PD 配置项 [`enable-telemetry`](/pd-configuration-file.md#enable-telemetry)。这些变量和配置项的值已不再生效。 * 移除 `ADMIN SHOW TELEMETRY` 语法。 * 删除 `TELEMETRY` 和 `TELEMETRY_ID` 关键字。 From 331420558b04a33bdc37da07bcb628959d9754ab Mon Sep 17 00:00:00 2001 From: Hangjie Mo <mohangjie1995@gmail.com> Date: Tue, 8 Jul 2025 22:49:45 +0800 Subject: [PATCH 4/7] Update system-variables.md --- system-variables.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/system-variables.md b/system-variables.md index 1e49d363a2dc..13d5413e4ecf 100644 --- a/system-variables.md +++ b/system-variables.md @@ -2448,7 +2448,7 @@ Query OK, 0 rows affected (0.09 sec) > > 在 TiDB v8.1.0 之前,TiDB 会定期向 PingCAP 上报遥测信息。 > -> 从 TiDB v8.1.3、v8.5.3 和 v9.0.0 起,TiDB 重新引入了遥测功能,但其行为已调整为仅将遥测相关信息输出到日志文件,不再通过网络上报。 +> 从 TiDB v8.5.3 和 v9.0.0 起,TiDB 重新引入了遥测功能,但其行为已调整为仅将遥测相关信息输出到日志文件,不再通过网络上报。 - 作用域:GLOBAL - 是否持久化到集群:是 From 8c99fd2ac920dce01e039e7eb4eff2e7167119bc Mon Sep 17 00:00:00 2001 From: Hangjie Mo <mohangjie1995@gmail.com> Date: Tue, 8 Jul 2025 22:50:04 +0800 Subject: [PATCH 5/7] Update telemetry.md --- telemetry.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/telemetry.md b/telemetry.md index 432833fb8c5c..ef4d37442f95 100644 --- a/telemetry.md +++ b/telemetry.md @@ -13,7 +13,7 @@ aliases: ['/docs-cn/dev/telemetry/','/zh/tidb/dev/sql-statement-admin-show-telem > - 从 TiUP v1.11.3 起,TiUP 遥测功能默认关闭,即 TiUP 默认不再收集使用情况信息。如果从 v1.11.3 之前的 TiUP 版本升级至 v1.11.3 或更高 TiUP 版本,遥测保持升级前的开启或关闭状态。 > - 从 TiSpark v3.0.3 开始,TiSpark 遥测功能默认关闭,即 TiSpark 默认不收集使用情况信息。 > - 从 TiDB v8.1.0 起,TiDB 和 TiDB Dashboard 移除了遥测功能。 -> - 从 TiDB v8.1.3、v8.5.3 和 v9.0.0 起,TiDB 重新引入了遥测功能,但其行为已调整为仅将遥测相关信息输出到日志文件,不再通过网络上报。 +> - 从 TiDB v8.5.3 和 v9.0.0 起,TiDB 重新引入了遥测功能,但其行为已调整为仅将遥测相关信息输出到日志文件,不再通过网络上报。 ## 开启遥测后哪些使用情况信息会被收集? From 608b46d2783233dc6b02a1273a853948ae70d413 Mon Sep 17 00:00:00 2001 From: Hangjie Mo <mohangjie1995@gmail.com> Date: Tue, 8 Jul 2025 22:50:23 +0800 Subject: [PATCH 6/7] Update tidb-configuration-file.md --- tidb-configuration-file.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/tidb-configuration-file.md b/tidb-configuration-file.md index 363a3a96094d..1b4dc8d2bc9d 100644 --- a/tidb-configuration-file.md +++ b/tidb-configuration-file.md @@ -177,7 +177,7 @@ TiDB 配置文件比命令行参数支持更多的选项。你可以在 [config/ > > 从 TiDB v8.1.0 开始,TiDB 已移除遥测功能,该配置项已不再生效。保留该配置项仅用于与之前版本兼容。 > -> 从 TiDB v8.1.3、v8.5.3 和 v9.0.0 起,TiDB 重新引入了遥测功能,并将其行为调整为仅将相关信息输出到日志文件中。 +> 从 TiDB v8.5.3 和 v9.0.0 起,TiDB 重新引入了遥测功能,并将其行为调整为仅将相关信息输出到日志文件中。 + 用于控制是否在 TiDB 实例上开启遥测功能。 + 默认值:false From 5aba9a9dd1da9d6783ad426dc0b556bd86baa4b1 Mon Sep 17 00:00:00 2001 From: Hangjie Mo <mohangjie1995@gmail.com> Date: Tue, 15 Jul 2025 17:00:30 +0800 Subject: [PATCH 7/7] Apply suggestions from code review Co-authored-by: Aolin <aolinz@outlook.com> --- system-variables.md | 10 +++++----- telemetry.md | 4 ++-- tidb-configuration-file.md | 5 ++--- 3 files changed, 9 insertions(+), 10 deletions(-) diff --git a/system-variables.md b/system-variables.md index 13d5413e4ecf..64009d409e34 100644 --- a/system-variables.md +++ b/system-variables.md @@ -2446,16 +2446,16 @@ Query OK, 0 rows affected (0.09 sec) > **警告:** > -> 在 TiDB v8.1.0 之前,TiDB 会定期向 PingCAP 上报遥测信息。 -> -> 从 TiDB v8.5.3 和 v9.0.0 起,TiDB 重新引入了遥测功能,但其行为已调整为仅将遥测相关信息输出到日志文件,不再通过网络上报。 +> - 在 v8.1.0 之前的版本中,TiDB 会定期向 PingCAP 上报遥测信息。 +> - 在 v8.1.0 到 v8.5.1 及其之间的版本中,TiDB 已移除遥测功能,`tidb_enable_telemetry` 变量不再生效。保留该变量仅用于与之前版本兼容。 +> - 从 v8.5.3 开始,TiDB 重新引入遥测功能,但其行为已更改为仅将遥测相关信息输出到日志文件,不再通过网络发送给 PingCAP。 - 作用域:GLOBAL - 是否持久化到集群:是 - 是否受 Hint [SET_VAR](/optimizer-hints.md#set_varvar_namevar_value) 控制:否 - 类型:布尔型 -- 默认值:`ON` -- 该变量用于动态控制 TiDB 遥测功能是否开启。仅当 TiDB 实例的配置项 [`enable-telemetry`](/tidb-configuration-file.md#enable-telemetry-从-v402-版本开始引入) 设置为 `true` 时,该变量才会生效。 +- 默认值:`ON`,从 v8.5.3 开始,默认值由 `OFF` 改为 `ON`。 +- 该变量用于动态控制 TiDB 遥测功能是否开启。从 v8.5.3 开始,该变量仅在 TiDB 实例的配置项 [`enable-telemetry`](/tidb-configuration-file.md#enable-telemetry-从-v402-版本开始引入) 设置为 `true` 时生效。 ### `tidb_enable_tiflash_read_for_write_stmt` <span class="version-mark">从 v6.3.0 版本开始引入</span> diff --git a/telemetry.md b/telemetry.md index ef4d37442f95..415eb39864f6 100644 --- a/telemetry.md +++ b/telemetry.md @@ -12,8 +12,8 @@ aliases: ['/docs-cn/dev/telemetry/','/zh/tidb/dev/sql-statement-admin-show-telem > > - 从 TiUP v1.11.3 起,TiUP 遥测功能默认关闭,即 TiUP 默认不再收集使用情况信息。如果从 v1.11.3 之前的 TiUP 版本升级至 v1.11.3 或更高 TiUP 版本,遥测保持升级前的开启或关闭状态。 > - 从 TiSpark v3.0.3 开始,TiSpark 遥测功能默认关闭,即 TiSpark 默认不收集使用情况信息。 -> - 从 TiDB v8.1.0 起,TiDB 和 TiDB Dashboard 移除了遥测功能。 -> - 从 TiDB v8.5.3 和 v9.0.0 起,TiDB 重新引入了遥测功能,但其行为已调整为仅将遥测相关信息输出到日志文件,不再通过网络上报。 +> - 在 v8.1.0 到 v8.5.1 及其之间的版本中,TiDB 和 TiDB Dashboard 移除了遥测功能。 +> - 从 TiDB v8.5.3 开始,TiDB 重新引入遥测功能,但其行为已更改为仅将遥测相关信息输出到日志文件,不再通过网络发送给 PingCAP。 ## 开启遥测后哪些使用情况信息会被收集? diff --git a/tidb-configuration-file.md b/tidb-configuration-file.md index 1b4dc8d2bc9d..03ddb61e5f3f 100644 --- a/tidb-configuration-file.md +++ b/tidb-configuration-file.md @@ -175,9 +175,8 @@ TiDB 配置文件比命令行参数支持更多的选项。你可以在 [config/ > **警告:** > -> 从 TiDB v8.1.0 开始,TiDB 已移除遥测功能,该配置项已不再生效。保留该配置项仅用于与之前版本兼容。 -> -> 从 TiDB v8.5.3 和 v9.0.0 起,TiDB 重新引入了遥测功能,并将其行为调整为仅将相关信息输出到日志文件中。 +> - 在 v8.1.0 到 v8.5.1 及其之间的版本中,TiDB 已移除遥测功能,该配置项已不再生效。保留该配置项仅用于与之前版本兼容。 +> - 从 v8.5.3 开始,TiDB 重新引入遥测功能,但其行为已更改为仅将遥测相关信息输出到日志文件,不再通过网络发送给 PingCAP。 + 用于控制是否在 TiDB 实例上开启遥测功能。 + 默认值:false