diff --git a/TOC.md b/TOC.md index 4757c3dbb117..1f02017df94d 100644 --- a/TOC.md +++ b/TOC.md @@ -747,7 +747,6 @@ - [`ADMIN RESUME DDL`](/sql-statements/sql-statement-admin-resume-ddl.md) - [`ADMIN [SET|SHOW|UNSET] BDR ROLE`](/sql-statements/sql-statement-admin-bdr-role.md) - [`ADMIN SHOW DDL [JOBS|JOB QUERIES]`](/sql-statements/sql-statement-admin-show-ddl.md) - - [`ADMIN SHOW TELEMETRY`](/sql-statements/sql-statement-admin-show-telemetry.md) - [`ALTER DATABASE`](/sql-statements/sql-statement-alter-database.md) - [`ALTER INSTANCE`](/sql-statements/sql-statement-alter-instance.md) - [`ALTER PLACEMENT POLICY`](/sql-statements/sql-statement-alter-placement-policy.md) diff --git a/keywords.md b/keywords.md index fe2286476f65..29ef17c07695 100644 --- a/keywords.md +++ b/keywords.md @@ -677,8 +677,6 @@ TiDB 从 v7.5.3 和 v7.6.0 开始提供 [`INFORMATION_SCHEMA.KEYWORDS`](/informa - TABLESAMPLE (R) - TABLESPACE - TABLE_CHECKSUM -- TELEMETRY -- TELEMETRY_ID - TEMPORARY - TEMPTABLE - TERMINATED (R) diff --git a/pd-configuration-file.md b/pd-configuration-file.md index 02e789b5b781..5826d70b5c14 100644 --- a/pd-configuration-file.md +++ b/pd-configuration-file.md @@ -478,9 +478,12 @@ PD 中内置的 [TiDB Dashboard](/dashboard/dashboard-intro.md) 相关配置项 ### `enable-telemetry` -+ 是否启用 TiDB Dashboard 遥测功能。 +> **警告：** +> +> 从 TiDB v8.1.0 开始，TiDB Dashboard 已移除遥测功能，该配置项已不再生效。保留该配置项仅用于与之前版本兼容。 + ++ 在 v8.1.0 之前，用于控制是否启用 TiDB Dashboard 遥测功能。 + 默认值：false -+ 参阅[遥测](/telemetry.md)了解该功能详情。 ## `replication-mode` diff --git a/releases/release-6.1.5.md b/releases/release-6.1.5.md index 896c4f382969..0106a3589926 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-版本开始引入) 默认值由 `ON` 修改为 `OFF`。 - - TiDB 配置项 [`enable-telemetry`](/tidb-configuration-file.md#enable-telemetry-从-v402-版本开始引入) 默认值由 `true` 改为 `false`。 + - 系统变量 [`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`。 - 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.5.1.md b/releases/release-6.5.1.md index 5441d8cef9e3..d4e956fa7a98 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-版本开始引入) 默认值由 `ON` 修改为 `OFF`。 - - TiDB 配置项 [`enable-telemetry`](/tidb-configuration-file.md#enable-telemetry-从-v402-版本开始引入) 默认值由 `true` 改为 `false`。 + - 系统变量 [`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`。 - 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 3b9663331e50..5987c0ccef19 100644 --- a/releases/release-6.6.0.md +++ b/releases/release-6.6.0.md @@ -350,7 +350,7 @@ TiDB 版本：6.6.0-[DMR](/releases/versioning.md#开发里程碑版本) | [`tidb_enable_foreign_key`](/system-variables.md#tidb_enable_foreign_key-从-v630-版本开始引入) | 修改 | 用于控制是否开启外键功能。默认值由 `OFF` 修改为 `ON`，表示默认开启外键功能。| | `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_telemetry`](/system-variables.md#tidb_enable_telemetry-从-v402-版本开始引入) | 修改 | 默认值由 `ON` 修改为 `OFF`，表示默认关闭 TiDB 的遥测功能。 | +| [`tidb_enable_telemetry`](/system-variables.md#tidb_enable_telemetry-从-v402-版本开始引入从-v810-版本开始废弃) | 修改 | 默认值由 `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 副本。| @@ -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-版本开始引入) | 修改 | 自 v6.6.0 起，该配置项默认值由 `true` 改为 `false`，表示默认关闭 TiDB 的遥测功能。 | +| TiDB | [`enable-telemetry`](/tidb-configuration-file.md#enable-telemetry-从-v402-版本开始引入从-v810-版本开始废弃) | 修改 | 自 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 3c81677a0be0..b503e051e06b 100644 --- a/releases/release-8.1.0.md +++ b/releases/release-8.1.0.md @@ -173,6 +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_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#任务调度)。 | @@ -181,7 +182,9 @@ 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| [`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` 将在未来版本中废弃。 | | TiDB Lightning | [`conflict.threshold`](/tidb-lightning/tidb-lightning-configuration.md#tidb-lightning-任务配置) | 修改 | 默认值从 `9223372036854775807` 修改为 `10000`，从而迅速中断异常任务，以便用户尽快进行相应调整。这避免了在导入完成后，才发现是因为数据源异常或表结构定义错误导致导入了大量冲突数据，从而节省时间和计算资源。 | | TiCDC | [`security.client-allowed-user`](/ticdc/ticdc-server-config.md#cdc-server-配置文件说明) | 新增 | 指定可用于客户端鉴权的用户名，列表中不存在的用户的鉴权请求将被直接拒绝。默认值为 null。| @@ -192,6 +195,12 @@ 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)。这些变量和配置项的值已不再生效。 + * 移除 `ADMIN SHOW TELEMETRY` 语法。 + * 删除 `TELEMETRY` 和 `TELEMETRY_ID` 关键字。 + * 计划在后续版本重新设计[执行计划绑定的自动演进](/sql-plan-management.md#自动演进绑定-baseline-evolution)，相关的变量和行为会发生变化。 * TiDB Lightning 参数 [`conflict.max-record-rows`](/tidb-lightning/tidb-lightning-configuration.md#tidb-lightning-任务配置) 计划在未来版本中废弃，并在后续版本中删除。该参数将由 `conflict.threshold` 替代，即记录的冲突记录数和单个导入任务允许出现的冲突记录数的上限数保持一致。 * 从 v8.0.0 开始，TiDB Lightning 废弃了物理导入模式下的[旧版冲突检测](/tidb-lightning/tidb-lightning-physical-import-mode-usage.md#旧版冲突检测从-v800-开始已被废弃)策略，支持通过 [`conflict.strategy`](/tidb-lightning/tidb-lightning-configuration.md) 参数统一控制逻辑导入和物理导入模式的冲突检测策略。旧版冲突检测的参数 [`duplicate-resolution`](/tidb-lightning/tidb-lightning-configuration.md) 将在未来版本中被移除。 diff --git a/sql-statements/sql-statement-admin-show-telemetry.md b/sql-statements/sql-statement-admin-show-telemetry.md deleted file mode 100644 index 3281082453e1..000000000000 --- a/sql-statements/sql-statement-admin-show-telemetry.md +++ /dev/null @@ -1,431 +0,0 @@ ---- -title: ADMIN SHOW TELEMETRY -summary: ADMIN SHOW TELEMETRY 语句用于查看通过遥测功能收集到并分享给 PingCAP 的使用信息。该语句是 TiDB 对 MySQL 语法的扩展。可用于查看硬件信息、实例信息、主机额外信息、特性使用情况和慢查询统计等。 ---- - -# ADMIN SHOW TELEMETRY - -`ADMIN SHOW TELEMETRY` 语句用于查看通过[遥测](/telemetry.md)功能收集到并分享给 PingCAP 的使用信息。 - -## 语法图 - -```ebnf+diagram -AdminStmt ::= - 'ADMIN' ( 'SHOW' ( 'DDL' ( 'JOBS' Int64Num? WhereClauseOptional | 'JOB' 'QUERIES' NumList )? | TableName 'NEXT_ROW_ID' | 'SLOW' AdminShowSlow | 'TELEMETRY' ) | 'CHECK' ( 'TABLE' TableNameList | 'INDEX' TableName Identifier ( HandleRange ( ',' HandleRange )* )? ) | 'RECOVER' 'INDEX' TableName Identifier | 'CLEANUP' ( 'INDEX' TableName Identifier | 'TABLE' 'LOCK' TableNameList ) | 'CHECKSUM' 'TABLE' TableNameList | 'CANCEL' 'DDL' 'JOBS' NumList | 'RELOAD' ( 'EXPR_PUSHDOWN_BLACKLIST' | 'OPT_RULE_BLACKLIST' | 'BINDINGS' ) | 'PLUGINS' ( 'ENABLE' | 'DISABLE' ) PluginNameList | 'REPAIR' 'TABLE' TableName CreateTableStmt | ( 'FLUSH' | 'CAPTURE' | 'EVOLVE' ) 'BINDINGS' ) - -``` - -## 示例 - -{{< copyable "sql" >}} - -```sql -ADMIN SHOW TELEMETRY\G -``` - -```sql -*************************** 1. row *************************** - TRACKING_ID: a1ba1d97-b940-4d5b-a9d5-ddb0f2ac29e7 - LAST_STATUS: { - "check_at": "2021-08-11T08:23:38+02:00", - "is_error": false, - "error_msg": "", - "is_request_sent": true -} -DATA_PREVIEW: { - "hardware": [ - { - "instanceType": "tidb", - "listenHostHash": "4b84b15bff6ee5796152495a230e45e3d7e947d9", - "listenPort": "4000", - "cpu": { - "cache": "8192", - "cpuFrequency": "2301.00MHz", - "cpuLogicalCores": "8", - "cpuPhysicalCores": "4" - }, - "memory": { - "capacity": "16410021888" - }, - "disk": { - "ebbca862689fa9fef7c55c3112e375c4ce575fe4": { - "deviceName": "ebbca862689fa9fef7c55c3112e375c4ce575fe4", - "free": "624438726656", - "freePercent": "0.61", - "fstype": "btrfs", - "opts": "bind,rw,relatime", - "path": "fb365c1216b59e1cfc86950425867007a60f4435", - "total": "1022488477696", - "used": "397115568128", - "usedPercent": "0.39" - }, - "nvme0n1p1": { - "deviceName": "nvme0n1p1", - "free": "582250496", - "freePercent": "0.93", - "fstype": "vfat", - "opts": "rw,relatime", - "path": "0fc8c8d71702d81a02e216fb6ef19f4dda4973df", - "total": "627900416", - "used": "45649920", - "usedPercent": "0.07" - }, - "nvme0n1p2": { - "deviceName": "nvme0n1p2", - "free": "701976576", - "freePercent": "0.74", - "fstype": "ext4", - "opts": "rw,relatime", - "path": "/boot", - "total": "1023303680", - "used": "250863616", - "usedPercent": "0.26" - } - } - }, - { - "instanceType": "pd", - "listenHostHash": "4b84b15bff6ee5796152495a230e45e3d7e947d9", - "listenPort": "2379", - "cpu": { - "cache": "8192", - "cpuFrequency": "2301.00MHz", - "cpuLogicalCores": "8", - "cpuPhysicalCores": "4" - }, - "memory": { - "capacity": "16410021888" - }, - "disk": { - "ebbca862689fa9fef7c55c3112e375c4ce575fe4": { - "deviceName": "ebbca862689fa9fef7c55c3112e375c4ce575fe4", - "free": "624438726656", - "freePercent": "0.61", - "fstype": "btrfs", - "opts": "bind,rw,relatime", - "path": "fb365c1216b59e1cfc86950425867007a60f4435", - "total": "1022488477696", - "used": "397115568128", - "usedPercent": "0.39" - }, - "nvme0n1p1": { - "deviceName": "nvme0n1p1", - "free": "582250496", - "freePercent": "0.93", - "fstype": "vfat", - "opts": "rw,relatime", - "path": "0fc8c8d71702d81a02e216fb6ef19f4dda4973df", - "total": "627900416", - "used": "45649920", - "usedPercent": "0.07" - }, - "nvme0n1p2": { - "deviceName": "nvme0n1p2", - "free": "701976576", - "freePercent": "0.74", - "fstype": "ext4", - "opts": "rw,relatime", - "path": "/boot", - "total": "1023303680", - "used": "250863616", - "usedPercent": "0.26" - } - } - }, - { - "instanceType": "tikv", - "listenHostHash": "4b84b15bff6ee5796152495a230e45e3d7e947d9", - "listenPort": "20160", - "cpu": { - "cpuFrequency": "3730MHz", - "cpuLogicalCores": "8", - "cpuPhysicalCores": "4", - "cpuVendorId": "GenuineIntel", - "l1CacheLineSize": "64", - "l1CacheSize": "32768", - "l2CacheLineSize": "64", - "l2CacheSize": "262144", - "l3CacheLineSize": "64", - "l3CacheSize": "8388608" - }, - "memory": { - "capacity": "16803861504" - }, - "disk": { - "36e7dfacbb83843f83075d78aeb4cf850a4882a1": { - "deviceName": "36e7dfacbb83843f83075d78aeb4cf850a4882a1", - "free": "624438726656", - "freePercent": "0.61", - "fstype": "btrfs", - "path": "fb365c1216b59e1cfc86950425867007a60f4435", - "total": "1022488477696", - "used": "398049751040", - "usedPercent": "0.39" - }, - "nvme0n1p1": { - "deviceName": "nvme0n1p1", - "free": "582250496", - "freePercent": "0.93", - "fstype": "vfat", - "path": "0fc8c8d71702d81a02e216fb6ef19f4dda4973df", - "total": "627900416", - "used": "45649920", - "usedPercent": "0.07" - }, - "nvme0n1p2": { - "deviceName": "nvme0n1p2", - "free": "701976576", - "freePercent": "0.69", - "fstype": "ext4", - "path": "/boot", - "total": "1023303680", - "used": "321327104", - "usedPercent": "0.31" - } - } - }, - { - "instanceType": "tiflash", - "listenHostHash": "4b84b15bff6ee5796152495a230e45e3d7e947d9", - "listenPort": "3930", - "cpu": { - "cpuFrequency": "3400MHz", - "cpuLogicalCores": "8", - "cpuPhysicalCores": "4", - "l1CacheLineSize": "64", - "l1CacheSize": "32768", - "l2CacheLineSize": "64", - "l2CacheSize": "262144", - "l3CacheLineSize": "64", - "l3CacheSize": "8388608" - }, - "memory": { - "capacity": "16410021888" - }, - "disk": { - "36e7dfacbb83843f83075d78aeb4cf850a4882a1": { - "deviceName": "36e7dfacbb83843f83075d78aeb4cf850a4882a1", - "free": "624438726656", - "freePercent": "0.61", - "fstype": "btrfs", - "path": "fb365c1216b59e1cfc86950425867007a60f4435", - "total": "1022488477696", - "used": "398049751040", - "usedPercent": "0.39" - } - } - } - ], - "instances": [ - { - "instanceType": "tidb", - "listenHostHash": "4b84b15bff6ee5796152495a230e45e3d7e947d9", - "listenPort": "4000", - "statusHostHash": "4b84b15bff6ee5796152495a230e45e3d7e947d9", - "statusPort": "10080", - "version": "5.1.1", - "gitHash": "797bddd25310ed42f0791c8eccb78be8cce2f502", - "startTime": "2021-08-11T08:23:38+02:00", - "upTime": "22.210217487s" - }, - { - "instanceType": "pd", - "listenHostHash": "4b84b15bff6ee5796152495a230e45e3d7e947d9", - "listenPort": "2379", - "statusHostHash": "4b84b15bff6ee5796152495a230e45e3d7e947d9", - "statusPort": "2379", - "version": "5.1.1", - "gitHash": "7cba1912b317a533e18b16ea2ba9a14ed2891129", - "startTime": "2021-08-11T08:23:32+02:00", - "upTime": "28.210220368s" - }, - { - "instanceType": "tikv", - "listenHostHash": "4b84b15bff6ee5796152495a230e45e3d7e947d9", - "listenPort": "20160", - "statusHostHash": "4b84b15bff6ee5796152495a230e45e3d7e947d9", - "statusPort": "20180", - "version": "5.1.1", - "gitHash": "4705d7c6e9c42d129d3309e05911ec6b08a25a38", - "startTime": "2021-08-11T08:23:33+02:00", - "upTime": "27.210221447s" - }, - { - "instanceType": "tiflash", - "listenHostHash": "4b84b15bff6ee5796152495a230e45e3d7e947d9", - "listenPort": "3930", - "statusHostHash": "4b84b15bff6ee5796152495a230e45e3d7e947d9", - "statusPort": "20292", - "version": "v5.1.1", - "gitHash": "c8fabfb50fe28db17cc5118133a69be255c40efd", - "startTime": "2021-08-11T08:23:40+02:00", - "upTime": "20.210222452s" - } - ], - "hostExtra": { - "cpuFlags": [ - "fpu", - "vme", - "de", - "pse", - "tsc", - "msr", - "pae", - "mce", - "cx8", - "apic", - "sep", - "mtrr", - "pge", - "mca", - "cmov", - "pat", - "pse36", - "clflush", - "dts", - "acpi", - "mmx", - "fxsr", - "sse", - "sse2", - "ss", - "ht", - "tm", - "pbe", - "syscall", - "nx", - "pdpe1gb", - "rdtscp", - "lm", - "constant_tsc", - "art", - "arch_perfmon", - "pebs", - "bts", - "rep_good", - "nopl", - "xtopology", - "nonstop_tsc", - "cpuid", - "aperfmperf", - "pni", - "pclmulqdq", - "dtes64", - "monitor", - "ds_cpl", - "vmx", - "est", - "tm2", - "ssse3", - "sdbg", - "fma", - "cx16", - "xtpr", - "pdcm", - "pcid", - "sse4_1", - "sse4_2", - "x2apic", - "movbe", - "popcnt", - "tsc_deadline_timer", - "aes", - "xsave", - "avx", - "f16c", - "rdrand", - "lahf_lm", - "abm", - "3dnowprefetch", - "cpuid_fault", - "epb", - "invpcid_single", - "ssbd", - "ibrs", - "ibpb", - "stibp", - "ibrs_enhanced", - "tpr_shadow", - "vnmi", - "flexpriority", - "ept", - "vpid", - "ept_ad", - "fsgsbase", - "tsc_adjust", - "sgx", - "bmi1", - "avx2", - "smep", - "bmi2", - "erms", - "invpcid", - "mpx", - "rdseed", - "adx", - "smap", - "clflushopt", - "intel_pt", - "xsaveopt", - "xsavec", - "xgetbv1", - "xsaves", - "dtherm", - "ida", - "arat", - "pln", - "pts", - "hwp", - "hwp_notify", - "hwp_act_window", - "hwp_epp", - "md_clear", - "flush_l1d", - "arch_capabilities" - ], - "cpuModelName": "Intel(R) Core(TM) i7-10510U CPU @ 1.80GHz", - "os": "linux", - "platform": "fedora", - "platformFamily": "fedora", - "platformVersion": "34", - "kernelVersion": "5.13.5-200.fc34.x86_64", - "kernelArch": "x86_64", - "virtualizationSystem": "kvm", - "virtualizationRole": "host" - }, - "reportTimestamp": 1628663040, - "trackingId": "a1ba1d97-b940-4d5b-a9d5-ddb0f2ac29e7", - "featureUsage": { - "txn": { - "asyncCommitUsed": true, - "onePCUsed": true, - "txnCommitCounter": { - "twoPC": 9, - "asyncCommit": 0, - "onePC": 0 - } - }, - "clusterIndex": {}, - "temporaryTable": false, - "cte": { - "nonRecursiveCTEUsed": 0, - "recursiveUsed": 0, - "nonCTEUsed": 13 - } - }, - "windowedStats": [], - "slowQueryStats": { - "slowQueryBucket": {} - } -} -1 row in set (0.0259 sec) -``` - -## MySQL 兼容性 - -`ADMIN` 语句是 TiDB 对 MySQL 语法的扩展。 - -## 另请参阅 - -* [遥测](/telemetry.md) -* [系统变量 `tidb_enable_telemetry`](/system-variables.md#tidb_enable_telemetry-从-v402-版本开始引入) diff --git a/sql-statements/sql-statement-admin.md b/sql-statements/sql-statement-admin.md index b97d10c255e8..59116123e153 100644 --- a/sql-statements/sql-statement-admin.md +++ b/sql-statements/sql-statement-admin.md @@ -24,7 +24,6 @@ summary: TiDB的 `ADMIN` 语句是用于查看TiDB状态和对表数据进行校 | [`ADMIN CHECKSUM TABLE`](/sql-statements/sql-statement-admin-checksum-table.md) | 计算表中所有行和索引的 CRC64 校验和 | | [ADMIN CHECK [TABLE\|INDEX]](/sql-statements/sql-statement-admin-check-table-index.md) | 校验表中数据和对应索引的一致性 | | [ADMIN SHOW DDL [JOBS\|QUERIES]](/sql-statements/sql-statement-admin-show-ddl.md) | 显示有关当前正在运行或最近完成的 DDL 作业的详细信息| -| [ADMIN SHOW TELEMETRY](/sql-statements/sql-statement-admin-show-telemetry.md) | 显示通过[遥测](/telemetry.md)功能收集到并分享给 PingCAP 的使用信息。 | ## `ADMIN RELOAD` 语句 diff --git a/sql-statements/sql-statement-overview.md b/sql-statements/sql-statement-overview.md index e47b62d42375..b8baab5eb7f3 100644 --- a/sql-statements/sql-statement-overview.md +++ b/sql-statements/sql-statement-overview.md @@ -91,7 +91,6 @@ TiDB 使用的 SQL 语句旨在遵循 ISO/IEC SQL 标准，并在必要时对 My | [`ADMIN PAUSE DDL`](/sql-statements/sql-statement-admin-pause-ddl.md) | 暂停 DDL 作业。 | | [`ADMIN RESUME DDL`](/sql-statements/sql-statement-admin-resume-ddl.md) | 恢复 DDL 作业。 | | [`ADMIN SHOW DDL [JOBS\|JOB QUERIES]`](/sql-statements/sql-statement-admin-show-ddl.md) | 显示 DDL 作业信息或 DDL 对应的查询语句。 | -| [`ADMIN SHOW TELEMETRY`](/sql-statements/sql-statement-admin-show-telemetry.md) | 显示遥测数据。 | | [`ADMIN`](/sql-statements/sql-statement-admin.md) | 执行各种管理任务。 | | [`FLUSH TABLES`](/sql-statements/sql-statement-flush-tables.md) | 用于提供 [MySQL 兼容性](/mysql-compatibility.md)，在 TiDB 中没有实际用途。 | | [`SET `](/sql-statements/sql-statement-set-variable.md) | 修改系统变量或用户变量。 | diff --git a/system-variables.md b/system-variables.md index 86a27c9a5874..b8cf3f6a9c9a 100644 --- a/system-variables.md +++ b/system-variables.md @@ -2346,14 +2346,18 @@ Query OK, 0 rows affected (0.09 sec) - `AUTO` 目前作用和 `ON` 一样。 - `OFF` 表示关闭 `TABLE PARTITION` 特性，此时语法还是保持兼容，只是创建的表并不是真正的分区表，而是普通的表。 -### `tidb_enable_telemetry` 从 v4.0.2 版本开始引入 +### `tidb_enable_telemetry` 从 v4.0.2 版本开始引入，从 v8.1.0 版本开始废弃 + +> **警告：** +> +> 从 TiDB v8.1.0 开始，TiDB 已移除遥测功能，该变量已不再生效。保留该变量仅用于与之前版本兼容。 - 作用域：GLOBAL - 是否持久化到集群：是 - 是否受 Hint [SET_VAR](/optimizer-hints.md#set_varvar_namevar_value) 控制：否 - 类型：布尔型 - 默认值：`OFF` -- 这个变量用于动态地控制 TiDB 遥测功能是否开启，当前版本默认关闭 TiDB 的遥测功能。当所有 TiDB 实例都设置配置项 [`enable-telemetry`](/tidb-configuration-file.md#enable-telemetry-从-v402-版本开始引入) 为 `false` 时，将忽略该系统变量，并总是关闭 TiDB 遥测功能。参阅[遥测](/telemetry.md)了解该功能详情。 +- 在 v8.1.0 之前，这个变量用于动态地控制 TiDB 遥测功能是否开启。 ### `tidb_enable_tiflash_read_for_write_stmt` 从 v6.3.0 版本开始引入 diff --git a/telemetry.md b/telemetry.md index 2cfeb6a49064..43bf12f1c3d3 100644 --- a/telemetry.md +++ b/telemetry.md @@ -1,53 +1,27 @@ --- title: 遥测 summary: 介绍遥测的场景，如何禁用功能和查看遥测状态。 +aliases: ['/zh/tidb/v8.2/sql-statement-admin-show-telemetry'] --- # 遥测 -开启遥测后，TiDB、TiUP 及 TiDB Dashboard 会收集使用情况信息，并将这些信息分享给 PingCAP 用于改善产品，例如，通过这些使用信息，PingCAP 可以了解常见的 TiDB 集群操作，从而确定新功能优先级。 +开启遥测后，TiUP 和 TiSpark 会收集使用情况信息，并将这些信息分享给 PingCAP 用于改善产品。 > **注意：** > -> - 自 2023 年 2 月 20 日起，新发布的 TiDB 和 TiDB Dashboard 版本（含 v6.6.0），默认关闭遥测功能，即默认不再收集使用情况信息分享给 PingCAP。如果集群在升级至这些版本前使用默认的遥测配置，则升级后遥测功能处于关闭状态。具体的版本可参考 [TiDB 版本发布时间线](/releases/release-timeline.md)。 -> - 从 v1.11.3 起，新部署的 TiUP 默认关闭遥测功能，即默认不再收集使用情况信息。如果从 v1.11.3 之前的 TiUP 版本升级至 v1.11.3 或更高 TiUP 版本，遥测保持升级前的开启或关闭状态。 +> - 从 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 移除了遥测功能。 -## 哪些使用情况信息会被收集？ +## 开启遥测后哪些使用情况信息会被收集？ -以下章节具体描述了各个组件收集并分享的使用情况信息。若收集的使用情况信息有变化，将在版本更新说明中告知。 +以下章节具体描述了 TiUP 和 TiSpark 收集并分享的使用情况信息。若收集的使用情况信息有变化，将在版本更新说明中告知。 > **注意：** > > 在**任何情况**下，集群中用户存储的数据都**不会**被收集。另请参阅 [PingCAP 隐私声明](https://pingcap.com/zh/privacy-policy/)。 -### TiDB - -当 TiDB 遥测功能开启时，TiDB 集群将会以 6 小时为周期收集使用情况信息并分享给 PingCAP，包括（但不限于）： - -- 随机生成的遥测标示符 -- 集群的部署情况，包括各个组件所在的硬件信息（CPU、内存、磁盘）、组件版本号、操作系统版本号等 -- 系统的查询请求状态，例如查询请求次数、持续时长等 -- 系统组件的使用情况，例如 Async Commit 功能是否有被使用 -- 去识别化处理后的产品遥测数据发送端的 IP 地址 - -可以通过执行以下 SQL 语句查看 TiDB 收集的使用情况信息内容： - -{{< copyable "sql" >}} - -```sql -ADMIN SHOW TELEMETRY; -``` - -### TiDB Dashboard - -当 TiDB Dashboard 遥测功能开启时，用户在 TiDB Dashboard 网页界面上进行操作时会将使用情况信息分享给 PingCAP，包括（但不限于）： - -- 随机生成的遥测标示符 -- 界面访问情况，如访问的 TiDB Dashboard 功能页面名称 -- 用户浏览器及操作系统信息，如浏览器名称和版本号、操作系统名称、屏幕分辨率等 - -可以使用 [Chrome 开发者工具](https://developers.google.com/web/tools/chrome-devtools)的[网络功能](https://developers.google.com/web/tools/chrome-devtools/network)或 [Firefox 开发者工具](https://developer.mozilla.org/zh-CN/docs/Tools)的[网络监视器功能](https://developer.mozilla.org/zh-CN/docs/Tools/Network_Monitor)查看 TiDB Dashboard 发送的使用情况信息内容。 - ### TiUP 当 TiUP 遥测功能开启时，执行 TiUP 命令时会将使用情况信息分享给 PingCAP，包括（但不限于）： @@ -58,18 +32,12 @@ ADMIN SHOW TELEMETRY; 使用 TiUP 时，可通过设置 `TIUP_CLUSTER_DEBUG=enable` 环境变量输出执行命令时收集的使用情况信息，例如： -{{< copyable "shell-regular" >}} - ```shell TIUP_CLUSTER_DEBUG=enable tiup cluster list ``` ### TiSpark -> **注意：** -> -> 从 TiSpark v3.0.3 开始，默认关闭遥测功能，即 TiSpark 默认不收集使用情况信息，不将这些信息分享给 PingCAP 用于改善产品。 - 当 TiSpark 遥测功能开启时，Spark 在使用 TiSpark 时会发送会将使用情况信息分享给 PingCAP，包括（但不限于）： - 随机生成的遥测标示符 @@ -78,184 +46,16 @@ TIUP_CLUSTER_DEBUG=enable tiup cluster list 使用 TiSpark 时，可以通过查看 Spark 日志来了解 TiSpark 收集的使用情况，可将 Spark 日志级别调至 INFO 或更低，例如： -{{< copyable "shell-regular" >}} - ```shell grep "Telemetry report" {spark.log} | tail -n 1 ``` ## 开启遥测功能 -### 开启 TiDB 遥测 - -#### 第 1 步：修改配置文件中的遥测配置 - -在已有 TiDB 集群上开启遥测功能，需要为集群设置 [`enable-telemetry = true`](/tidb-configuration-file.md#enable-telemetry-从-v402-版本开始引入)，但需要重启集群后才能生效。 - -以下是在各个部署工具中修改遥测配置的具体步骤。 - -
- 通过二进制手工部署 - -创建配置文件 `tidb_config.toml` 包含如下内容： - -{{< copyable "" >}} - -```toml -enable-telemetry = true -``` - -启动 TiDB 时指定命令行参数 `--config=tidb_config.toml` 使得该配置生效。 - -详情参见 [TiDB 配置参数](/command-line-flags-for-tidb-configuration.md#--config)、[TiDB 配置文件描述](/tidb-configuration-file.md#enable-telemetry-从-v402-版本开始引入)。 - -
- -
- 通过 TiUP Playground 试用 - -创建配置文件 `tidb_config.toml` 包含如下内容： - -{{< copyable "" >}} - -```toml -enable-telemetry = true -``` - -启动 TiUP Playground 时，指定命令行参数 `--db.config tidb_config.toml` 使得该配置生效，如： - -{{< copyable "shell-regular" >}} - -```shell -tiup playground --db.config tidb_config.toml -``` - -详情参见 [TiUP - 本地快速部署 TiDB 集群](/tiup/tiup-playground.md)。 - -
- -
- 通过 TiUP Cluster 部署 - -修改部署拓扑文件 `topology.yaml`，新增（或在现有项中添加）以下内容： - -{{< copyable "" >}} - -```yaml -server_configs: - tidb: - enable-telemetry: true -``` - -
- -
- 通过 TiDB Operator 在 Kubernetes 上部署 - -在 `tidb-cluster.yaml` 中或者 TidbCluster Custom Resource 中配置 `spec.tidb.config.enable-telemetry: true`。 - -详情参见[在标准 Kubernetes 上部署 TiDB 集群](https://docs.pingcap.com/zh/tidb-in-kubernetes/stable/deploy-on-general-kubernetes)。 - -> **注意：** -> -> 该配置需使用 TiDB Operator v1.1.3 或更高版本才能生效。 - -
- -#### 第 2 步：修改系统全局变量的遥测配置 - -在步骤 1 完成后，还需要修改系统全局变量 [`tidb_enable_telemetry`](/system-variables.md#tidb_enable_telemetry-从-v402-版本开始引入)，才能打开 TiDB 遥测功能： - -{{< copyable "sql" >}} - -```sql -SET GLOBAL tidb_enable_telemetry = 1; -``` - -配置文件和全局变量都开启后，遥测功能才能处于开启状态。 - -### 开启 TiDB Dashboard 遥测 - -可以修改 PD 配置中 [`dashboard.enable-telemetry = true`](/pd-configuration-file.md#enable-telemetry) 启动 TiDB Dashboard 遥测功能。对于已启动的集群，该配置需要重启后才能生效。 - -以下列出在各个部署工具中修改遥测配置的具体步骤。 - -
- 通过二进制手工部署 - -创建配置文件 `pd_config.toml` 包含如下内容： - -{{< copyable "" >}} - -```toml -[dashboard] -enable-telemetry = true -``` - -启动 PD 时指定命令行参数 `--config=pd_config.toml` 使得该配置生效。 - -详情参见 [PD 配置参数](/command-line-flags-for-pd-configuration.md#--config)、[PD 配置文件描述](/pd-configuration-file.md#enable-telemetry)。 - -
- -
- 通过 TiUP Playground 试用 - -创建配置文件 `pd_config.toml` 包含如下内容： - -{{< copyable "" >}} - -```toml -[dashboard] -enable-telemetry = true -``` - -启动 TiUP Playground 时，指定命令行参数 `--pd.config pd_config.toml` 使得该配置生效，如： - -{{< copyable "shell-regular" >}} - -```shell -tiup playground --pd.config pd_config.toml -``` - -详情参见 [TiUP - 本地快速部署 TiDB 集群](/tiup/tiup-playground.md)。 - -
- -
- 通过 TiUP Cluster 部署 - -修改部署拓扑文件 `topology.yaml`，新增（或在现有项中添加）以下内容： - -{{< copyable "" >}} - -```yaml -server_configs: - pd: - dashboard.enable-telemetry: true -``` - -
- -
- 通过 TiDB Operator 在 Kubernetes 上部署 - -在 `tidb-cluster.yaml` 中或者 TidbCluster Custom Resource 中配置 `spec.pd.config.dashboard.enable-telemetry: true`。 - -详情参见[在标准 Kubernetes 上部署 TiDB 集群](https://docs.pingcap.com/zh/tidb-in-kubernetes/stable/deploy-on-general-kubernetes)。 - -> **注意：** -> -> 该配置需使用 TiDB Operator v1.1.3 或更高版本才能生效。 - -
- ### 开启 TiUP 遥测 可通过执行以下命令开启 TiUP 遥测功能： -{{< copyable "shell-regular" >}} - ```shell tiup telemetry enable ``` @@ -266,174 +66,10 @@ tiup telemetry enable ## 禁用遥测功能 -### 部署 TiDB 时禁用 TiDB 遥测 - -在已有 TiDB 集群上开启遥测后，可以为每个集群设置 [`enable-telemetry = false`](/tidb-configuration-file.md#enable-telemetry-从-v402-版本开始引入) 以禁用 TiDB 遥测功能，但需要重启集群后才能生效。 - -以下是在各个部署工具中修改遥测配置的具体步骤。 - -
- 通过二进制手工部署 - -创建配置文件 `tidb_config.toml` 包含如下内容： - -{{< copyable "" >}} - -```toml -enable-telemetry = false -``` - -启动 TiDB 时指定命令行参数 `--config=tidb_config.toml` 使得该配置生效。 - -详情参见 [TiDB 配置参数](/command-line-flags-for-tidb-configuration.md#--config)、[TiDB 配置文件描述](/tidb-configuration-file.md#enable-telemetry-从-v402-版本开始引入)。 - -
- -
- 通过 TiUP Playground 试用 - -创建配置文件 `tidb_config.toml` 包含如下内容： - -{{< copyable "" >}} - -```toml -enable-telemetry = false -``` - -启动 TiUP Playground 时，指定命令行参数 `--db.config tidb_config.toml` 使得该配置生效，如： - -{{< copyable "shell-regular" >}} - -```shell -tiup playground --db.config tidb_config.toml -``` - -详情参见 [TiUP - 本地快速部署 TiDB 集群](/tiup/tiup-playground.md)。 - -
- -
- 通过 TiUP Cluster 部署 - -修改部署拓扑文件 `topology.yaml`，新增（或在现有项中添加）以下内容： - -{{< copyable "" >}} - -```yaml -server_configs: - tidb: - enable-telemetry: false -``` - -
- -
- 通过 TiDB Operator 在 Kubernetes 上部署 - -在 `tidb-cluster.yaml` 中或者 TidbCluster Custom Resource 中配置 `spec.tidb.config.enable-telemetry: false`。 - -详情参见[在标准 Kubernetes 上部署 TiDB 集群](https://docs.pingcap.com/zh/tidb-in-kubernetes/stable/deploy-on-general-kubernetes)。 - -> **注意：** -> -> 该配置需使用 TiDB Operator v1.1.3 或更高版本才能生效。 - -
- -### 动态禁用 TiDB 遥测 - -对于已部署的 TiDB 集群，还可以修改系统全局变量 [`tidb_enable_telemetry`](/system-variables.md#tidb_enable_telemetry-从-v402-版本开始引入) 动态禁用 TiDB 遥测功能： - -{{< copyable "sql" >}} - -```sql -SET GLOBAL tidb_enable_telemetry = 0; -``` - -配置文件的禁用优先级高于全局变量。若通过配置文件禁用了遥测功能，则全局变量的配置将不起作用，遥测功能总是处于关闭状态。 - -### 禁用 TiDB Dashboard 遥测 - -可以修改 PD 配置中 [`dashboard.enable-telemetry = false`](/pd-configuration-file.md#enable-telemetry) 禁用 TiDB Dashboard 遥测功能。对于已启动的集群，该配置需要重启后才能生效。 - -以下列出在各个部署工具中修改遥测配置的具体步骤。 - -
- 通过二进制手工部署 - -创建配置文件 `pd_config.toml` 包含如下内容： - -{{< copyable "" >}} - -```toml -[dashboard] -enable-telemetry = false -``` - -启动 PD 时指定命令行参数 `--config=pd_config.toml` 使得该配置生效。 - -详情参见 [PD 配置参数](/command-line-flags-for-pd-configuration.md#--config)、[PD 配置文件描述](/pd-configuration-file.md#enable-telemetry)。 - -
- -
- 通过 TiUP Playground 试用 - -创建配置文件 `pd_config.toml` 包含如下内容： - -{{< copyable "" >}} - -```toml -[dashboard] -enable-telemetry = false -``` - -启动 TiUP Playground 时，指定命令行参数 `--pd.config pd_config.toml` 使得该配置生效，如： - -{{< copyable "shell-regular" >}} - -```shell -tiup playground --pd.config pd_config.toml -``` - -详情参见 [TiUP - 本地快速部署 TiDB 集群](/tiup/tiup-playground.md)。 - -
- -
- 通过 TiUP Cluster 部署 - -修改部署拓扑文件 `topology.yaml`，新增（或在现有项中添加）以下内容： - -{{< copyable "" >}} - -```yaml -server_configs: - pd: - dashboard.enable-telemetry: false -``` - -
- -
- 通过 TiDB Operator 在 Kubernetes 上部署 - -在 `tidb-cluster.yaml` 中或者 TidbCluster Custom Resource 中配置 `spec.pd.config.dashboard.enable-telemetry: false`。 - -详情参见[在标准 Kubernetes 上部署 TiDB 集群](https://docs.pingcap.com/zh/tidb-in-kubernetes/stable/deploy-on-general-kubernetes)。 - -> **注意：** -> -> 该配置需使用 TiDB Operator v1.1.3 或更高版本才能生效。 - -
- ### 禁用 TiUP 遥测 可通过执行以下命令禁用 TiUP 遥测功能： -{{< copyable "shell-regular" >}} - ```shell tiup telemetry disable ``` @@ -444,20 +80,8 @@ tiup telemetry disable ## 查看遥测启用状态 -对于 TiDB 遥测，可通过执行以下 SQL 语句查看遥测状态： - -{{< copyable "sql" >}} - -```sql -ADMIN SHOW TELEMETRY; -``` - -若 `DATA_PREVIEW` 列为空，说明遥测没有开启，否则说明遥测已开启。还可以从 `LAST_STATUS` 列了解上次分享使用情况信息的时间、是否成功等。 - 对于 TiUP 遥测，可通过执行以下命令查看遥测状态： -{{< copyable "shell-regular" >}} - ```shell tiup telemetry status ``` diff --git a/tidb-configuration-file.md b/tidb-configuration-file.md index d4cd6501c810..4f7fc46f2bb3 100644 --- a/tidb-configuration-file.md +++ b/tidb-configuration-file.md @@ -170,12 +170,14 @@ TiDB 配置文件比命令行参数支持更多的选项。你可以在 [config/ + 默认值：64 + 目前的合法值范围 `[64, 512]`。 -### `enable-telemetry` 从 v4.0.2 版本开始引入 +### `enable-telemetry` 从 v4.0.2 版本开始引入，从 v8.1.0 版本开始废弃 -+ 是否开启 TiDB 遥测功能。 +> **警告：** +> +> 从 TiDB v8.1.0 开始，TiDB 已移除遥测功能，该配置项已不再生效。保留该配置项仅用于与之前版本兼容。 + ++ 在 v8.1.0 之前，用于控制是否在 TiDB 实例上开启遥测功能。 + 默认值：false -+ 如果在 TiDB 实例上该配置项设为 `true`，该 TiDB 实例上将开启遥测功能，且 [`tidb_enable_telemetry`](/system-variables.md#tidb_enable_telemetry-从-v402-版本开始引入) 系统变量生效。 -+ 如果所有 TiDB 实例上该选项都设置为 `false`，那么将完全禁用 TiDB 遥测功能，且忽略 `tidb_enable_telemetry` 系统变量。参阅[遥测](/telemetry.md)了解该功能详情。 ### `deprecate-integer-display-length`