- 文档中心
- 关于 TiDB
- 快速上手
- 部署标准集群
- 数据迁移
- 运维操作
- 监控与告警
- 故障诊断
- 性能调优
- 系统调优
- 软件调优
- SQL 性能调优
- SQL 性能调优概览
- 理解 TiDB 执行计划
- SQL 优化流程
- 控制执行计划
- 教程
- 同城多中心部署
- 两地三中心部署
- 同城两中心部署
- 读取历史数据
- 使用 Stale Read 功能读取历史数据(推荐)
- 使用系统变量
tidb_snapshot
读取历史数据
- 最佳实践
- Placement Rules 使用文档
- Load Base Split 使用文档
- Store Limit 使用文档
- TiDB 工具
- 功能概览
- 适用场景
- 工具下载
- TiUP
- 文档地图
- 概览
- 术语及核心概念
- TiUP 组件管理
- FAQ
- 故障排查
- TiUP 命令参考手册
- 命令概览
- TiUP 命令
- TiUP Cluster 命令
- TiUP Cluster 命令概览
- tiup cluster audit
- tiup cluster check
- tiup cluster clean
- tiup cluster deploy
- tiup cluster destroy
- tiup cluster disable
- tiup cluster display
- tiup cluster edit-config
- tiup cluster enable
- tiup cluster help
- tiup cluster import
- tiup cluster list
- tiup cluster patch
- tiup cluster prune
- tiup cluster reload
- tiup cluster rename
- tiup cluster replay
- tiup cluster restart
- tiup cluster scale-in
- tiup cluster scale-out
- tiup cluster start
- tiup cluster stop
- tiup cluster template
- tiup cluster upgrade
- TiUP DM 命令
- TiUP DM 命令概览
- tiup dm audit
- tiup dm deploy
- tiup dm destroy
- tiup dm disable
- tiup dm display
- tiup dm edit-config
- tiup dm enable
- tiup dm help
- tiup dm import
- tiup dm list
- tiup dm patch
- tiup dm prune
- tiup dm reload
- tiup dm replay
- tiup dm restart
- tiup dm scale-in
- tiup dm scale-out
- tiup dm start
- tiup dm stop
- tiup dm template
- tiup dm upgrade
- TiDB 集群拓扑文件配置
- DM 集群拓扑文件配置
- TiUP 镜像参考指南
- TiUP 组件文档
- TiDB Operator
- Dumpling
- TiDB Lightning
- TiDB Data Migration
- Backup & Restore (BR)
- TiDB Binlog
- TiCDC
- TiUniManager
- sync-diff-inspector
- TiSpark
- 参考指南
- 架构
- 监控指标
- 安全加固
- 权限
- SQL
- SQL 语言结构和语法
- SQL 语句
ADD COLUMN
ADD INDEX
ADMIN
ADMIN CANCEL DDL
ADMIN CHECKSUM TABLE
ADMIN CHECK [TABLE|INDEX]
ADMIN SHOW DDL [JOBS|QUERIES]
ADMIN SHOW TELEMETRY
ALTER DATABASE
ALTER INDEX
ALTER INSTANCE
ALTER PLACEMENT POLICY
ALTER TABLE
ALTER USER
ANALYZE TABLE
BACKUP
BEGIN
CHANGE COLUMN
CHANGE DRAINER
CHANGE PUMP
COMMIT
CREATE [GLOBAL|SESSION] BINDING
CREATE DATABASE
CREATE INDEX
CREATE PLACEMENT POLICY
CREATE ROLE
CREATE SEQUENCE
CREATE TABLE LIKE
CREATE TABLE
CREATE USER
CREATE VIEW
DEALLOCATE
DELETE
DESC
DESCRIBE
DO
DROP [GLOBAL|SESSION] BINDING
DROP COLUMN
DROP DATABASE
DROP INDEX
DROP PLACEMENT POLICY
DROP ROLE
DROP SEQUENCE
DROP STATS
DROP TABLE
DROP USER
DROP VIEW
EXECUTE
EXPLAIN ANALYZE
EXPLAIN
FLASHBACK TABLE
FLUSH PRIVILEGES
FLUSH STATUS
FLUSH TABLES
GRANT <privileges>
GRANT <role>
INSERT
KILL [TIDB]
LOAD DATA
LOAD STATS
MODIFY COLUMN
PREPARE
RECOVER TABLE
RENAME INDEX
RENAME TABLE
RENAME USER
REPLACE
RESTORE
REVOKE <privileges>
REVOKE <role>
ROLLBACK
SELECT
SET DEFAULT ROLE
SET [NAMES|CHARACTER SET]
SET PASSWORD
SET ROLE
SET TRANSACTION
SET [GLOBAL|SESSION] <variable>
SHOW [BACKUPS|RESTORES]
SHOW ANALYZE STATUS
SHOW [GLOBAL|SESSION] BINDINGS
SHOW BUILTINS
SHOW CHARACTER SET
SHOW COLLATION
SHOW [FULL] COLUMNS FROM
SHOW CONFIG
SHOW CREATE PLACEMENT POLICY
SHOW CREATE SEQUENCE
SHOW CREATE TABLE
SHOW CREATE USER
SHOW DATABASES
SHOW DRAINER STATUS
SHOW ENGINES
SHOW ERRORS
SHOW [FULL] FIELDS FROM
SHOW GRANTS
SHOW INDEX [FROM|IN]
SHOW INDEXES [FROM|IN]
SHOW KEYS [FROM|IN]
SHOW MASTER STATUS
SHOW PLACEMENT
SHOW PLACEMENT FOR
SHOW PLACEMENT LABELS
SHOW PLUGINS
SHOW PRIVILEGES
SHOW [FULL] PROCESSSLIST
SHOW PROFILES
SHOW PUMP STATUS
SHOW SCHEMAS
SHOW STATS_HEALTHY
SHOW STATS_HISTOGRAMS
SHOW STATS_META
SHOW STATUS
SHOW TABLE NEXT_ROW_ID
SHOW TABLE REGIONS
SHOW TABLE STATUS
SHOW [FULL] TABLES
SHOW [GLOBAL|SESSION] VARIABLES
SHOW WARNINGS
SHUTDOWN
SPLIT REGION
START TRANSACTION
TABLE
TRACE
TRUNCATE
UPDATE
USE
WITH
- 数据类型
- 函数与操作符
- 聚簇索引
- 约束
- 生成列
- SQL 模式
- 表属性
- 事务
- 垃圾回收 (GC)
- 视图
- 分区表
- 临时表
- 字符集和排序
- Placement Rules in SQL
- 系统表
mysql
- INFORMATION_SCHEMA
- Overview
ANALYZE_STATUS
CLIENT_ERRORS_SUMMARY_BY_HOST
CLIENT_ERRORS_SUMMARY_BY_USER
CLIENT_ERRORS_SUMMARY_GLOBAL
CHARACTER_SETS
CLUSTER_CONFIG
CLUSTER_HARDWARE
CLUSTER_INFO
CLUSTER_LOAD
CLUSTER_LOG
CLUSTER_SYSTEMINFO
COLLATIONS
COLLATION_CHARACTER_SET_APPLICABILITY
COLUMNS
DATA_LOCK_WAITS
DDL_JOBS
DEADLOCKS
ENGINES
INSPECTION_RESULT
INSPECTION_RULES
INSPECTION_SUMMARY
KEY_COLUMN_USAGE
METRICS_SUMMARY
METRICS_TABLES
PARTITIONS
PLACEMENT_RULES
PROCESSLIST
REFERENTIAL_CONSTRAINTS
SCHEMATA
SEQUENCES
SESSION_VARIABLES
SLOW_QUERY
STATISTICS
TABLES
TABLE_CONSTRAINTS
TABLE_STORAGE_STATS
TIDB_HOT_REGIONS
TIDB_HOT_REGIONS_HISTORY
TIDB_INDEXES
TIDB_SERVERS_INFO
TIDB_TRX
TIFLASH_REPLICA
TIKV_REGION_PEERS
TIKV_REGION_STATUS
TIKV_STORE_STATUS
USER_PRIVILEGES
VIEWS
METRICS_SCHEMA
- UI
- CLI
- 命令行参数
- 配置文件参数
- 系统变量
- 存储引擎
- 遥测
- 错误码
- 通过拓扑 label 进行副本调度
- 常见问题解答 (FAQ)
- 版本发布历史
- 术语表
你正在查看 TiDB 数据库的较旧版本 (TiDB v5.4) 的文档。
遥测
TiDB、TiUP 及 TiDB Dashboard 默认会收集使用情况信息,并将这些信息分享给 PingCAP 用于改善产品,例如,通过这些使用信息,PingCAP 可以了解常见的 TiDB 集群操作,从而确定新功能优先级。
哪些使用情况信息会被收集?
以下章节具体描述了各个组件收集并分享的使用情况信息。若收集的使用情况信息有变化,将在版本更新说明中告知。
在任何情况下,集群中用户存储的数据都不会被收集。另请参阅 PingCAP 隐私声明。
TiDB
当 TiDB 遥测功能开启时,TiDB 集群将会以 6 小时为周期收集使用情况信息并分享给 PingCAP,包括(但不限于):
- 随机生成的遥测标示符
- 集群的部署情况,包括各个组件所在的硬件信息(CPU、内存、磁盘)、组件版本号、操作系统版本号等
- 系统的查询请求状态,例如查询请求次数、持续时长等
- 系统组件的使用情况,例如 Async Commit 功能是否有被使用
可以通过执行以下 SQL 语句查看 TiDB 收集的使用情况信息内容:
ADMIN SHOW TELEMETRY;
TiDB Dashboard
当 TiDB Dashboard 遥测功能开启时,用户在 TiDB Dashboard 网页界面上进行操作时会将使用情况信息分享给 PingCAP,包括(但不限于):
- 随机生成的遥测标示符
- 界面访问情况,如访问的 TiDB Dashboard 功能页面名称
- 用户浏览器及操作系统信息,如浏览器名称和版本号、操作系统名称、屏幕分辨率等
可以使用 Chrome 开发者工具的网络功能或 Firefox 开发者工具的网络监视器功能查看 TiDB Dashboard 发送的使用情况信息内容。
TiUP
当 TiUP 遥测功能开启时,执行 TiUP 命令时会将使用情况信息分享给 PingCAP,包括(但不限于):
- 随机生成的遥测标示符
- TiUP 命令的执行情况,如命令执行是否成功、命令执行耗时等
- 使用 TiUP 进行部署的情况,如部署的目标机器硬件信息、组件版本号、修改过的部署配置名称等
使用 TiUP 时,可通过设置 TIUP_CLUSTER_DEBUG=enable
环境变量输出执行命令时收集的使用情况信息,例如:
TIUP_CLUSTER_DEBUG=enable tiup cluster list
禁用遥测功能
部署 TiDB 时禁用 TiDB 遥测
部署 TiDB 集群时,可以为每个 TiDB 集群设置 enable-telemetry = false
以禁用 TiDB 遥测功能。也可以在已部署的 TiDB 集群上修改该配置项,但需要重启集群后才能生效。
以下是在各个部署工具中修改遥测配置的具体步骤。
通过二进制手工部署
创建配置文件 tidb_config.toml
包含如下内容:
enable-telemetry = false
启动 TiDB 时指定命令行参数 --config=tidb_config.toml
使得该配置生效。
详情参见 TiDB 配置参数、TiDB 配置文件描述。
通过 TiUP Playground 试用
创建配置文件 tidb_config.toml
包含如下内容:
enable-telemetry = false
启动 TiUP Playground 时,指定命令行参数 --db.config tidb_config.toml
使得该配置生效,如:
tiup playground --db.config tidb_config.toml
详情参见 TiUP - 本地快速部署 TiDB 集群。
通过 TiUP Cluster 部署
修改部署拓扑文件 topology.yaml
,新增(或在现有项中添加)以下内容:
server_configs:
tidb:
enable-telemetry: false
通过 TiDB Operator 在 Kubernetes 上部署
在 tidb-cluster.yaml
中或者 TidbCluster Custom Resource 中配置 spec.tidb.config.enable-telemetry: false
。
详情参见在标准 Kubernetes 上部署 TiDB 集群。
该配置需使用 TiDB Operator v1.1.3 或更高版本才能生效。
动态禁用 TiDB 遥测
对于已部署的 TiDB 集群,还可以修改系统全局变量 tidb_enable_telemetry
动态禁用 TiDB 遥测功能:
SET GLOBAL tidb_enable_telemetry = 0;
配置文件的禁用优先级高于全局变量。若通过配置文件禁用了遥测功能,则全局变量的配置将不起作用,遥测功能总是处于关闭状态。
禁用 TiDB Dashboard 遥测
可以修改 PD 配置中 dashboard.enable-telemetry = false
禁用 TiDB Dashboard 遥测功能。对于已启动的集群,该配置需要重启后才能生效。
以下列出在各个部署工具中修改遥测配置的具体步骤。
通过二进制手工部署
创建配置文件 pd_config.toml
包含如下内容:
[dashboard]
enable-telemetry = false
启动 PD 时指定命令行参数 --config=pd_config.toml
使得该配置生效。
通过 TiUP Playground 试用
创建配置文件 pd_config.toml
包含如下内容:
[dashboard]
enable-telemetry = false
启动 TiUP Playground 时,指定命令行参数 --pd.config pd_config.toml
使得该配置生效,如:
tiup playground --pd.config pd_config.toml
详情参见 TiUP - 本地快速部署 TiDB 集群。
通过 TiUP Cluster 部署
修改部署拓扑文件 topology.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 集群。
该配置需使用 TiDB Operator v1.1.3 或更高版本才能生效。
禁用 TiUP 遥测
可通过执行以下命令禁用 TiUP 遥测功能:
tiup telemetry disable
查看遥测启用状态
对于 TiDB 遥测,可通过执行以下 SQL 语句查看遥测状态:
ADMIN SHOW TELEMETRY;
若 DATA_PREVIEW
列为空,说明遥测没有开启,否则说明遥测已开启。还可以从 LAST_STATUS
列了解上次分享使用情况信息的时间、是否成功等。
对于 TiUP 遥测,可通过执行以下命令查看遥测状态:
tiup telemetry status
使用情况信息合规性
为了满足不同国家或地区对于此类信息的合规性要求,使用情况信息会按照不同的操作者 IP 地址发送到位于不同国家的服务器,具体如下:
- 若为中国大陆 IP 地址,使用情况信息将会发送并存储于中国大陆境内的公有云服务器。
- 若为中国大陆以外 IP 地址,使用情况信息将会发送并存储于美国的公有云服务器。
可参阅 PingCAP 隐私声明了解详情。