Add Telemetry Docs

TOC.md

@@ -452,6 +452,7 @@
       + [tiup-cluster 部署运维生产集群](/tiup/tiup-cluster.md)
       + [tiup-mirror 定制离线镜像](/tiup/tiup-mirror.md)
       + [tiup-bench 进行 TPCC/TPCH 压力测试](/tiup/tiup-bench.md)
+  + [遥测](/telemetry.md)
   + [错误码](/error-codes.md)
   + [TiCDC 简介](/ticdc/ticdc-overview.md)
   + [TiCDC 开放数据协议](/ticdc/ticdc-open-protocol.md)

dashboard/dashboard-intro.md

@@ -64,3 +64,7 @@ TiDB Dashboard 在 GitHub 上[开源](https://github.com/pingcap-incubator/tidb-
 高级调试功能：无需第三方工具，在线地对各个组件进行性能分析，剖析组件实例在分析时间段内执行的各种内部操作及比例。
 
 参阅[实例性能分析页面](/dashboard/dashboard-profiling.md)了解详情。
+
+> **注意：**
+>
+> TiDB Dashboard 默认会收集使用情况信息，并将其分享给 PingCAP 用于改善产品。若要了解收集的信息详情及如何禁用这个行为，请参见[遥测](/telemetry.md)章节。

offline-deployment-using-ansible.md

@@ -158,3 +158,7 @@ aliases: ['/docs-cn/dev/how-to/deploy/orchestrated/offline-ansible/']
 ## 测试集群
 
 参考[测试集群](/online-deployment-using-ansible.md#测试集群)即可。
+
+> **注意：**
+>
+> TiDB 默认会定期收集使用情况信息，并将其分享给 PingCAP 用于改善产品。若要了解收集的信息详情及如何禁用这个行为，请参见[遥测](/telemetry.md)章节。

online-deployment-using-ansible.md

@@ -24,7 +24,7 @@ Ansible 是一款自动化运维工具，[TiDB Ansible](https://github.com/pingc
 > **警告：**
 >
 > 对于生产环境，推荐[使用 TiUP 部署 TiDB 集群](/production-deployment-using-tiup.md)。从 TiDB 4.0 版本开始，不再推荐使用 TiDB Ansible 部署 TiDB 集群，但可以使用 TiUP 直接支持之前的 Ansible 集群。
-> 
+>
 > 如果只是希望测试 TiDB 或体验 TiDB 特性，可参考 [TiDB 快速上手指南](/quick-start-with-tidb.md)或者[使用 Docker Compose 在单机上快速部署 TiDB 集群](/deploy-test-cluster-using-docker-compose.md)。
 
 ## 准备机器
@@ -706,6 +706,10 @@ TiDB 兼容 MySQL，因此可使用 MySQL 客户端直接连接 TiDB。推荐配
     - 地址：<http://172.16.10.1:3000>
     - 默认帐号与密码：`admin`；`admin`
 
+> **注意：**
+>
+> TiDB 默认会定期收集使用情况信息，并将其分享给 PingCAP 用于改善产品。若要了解收集的信息详情及如何禁用这个行为，请参见[遥测](/telemetry.md)章节。
+
 ## 常见部署问题
 
 本小节介绍使用 TiDB Ansible 部署 TiDB 集群过程中的常见问题与解决方案。

pd-configuration-file.md

@@ -282,3 +282,19 @@ PD 配置文件比命令行参数支持更多的选项。你可以在 [conf/conf
 
 + 拒绝 leader 的 store 带有的 label value。
 + 默认：""
+
+## dashboard
+
+PD 中内置的 [TiDB Dashboard](/dashboard/dashboard-intro.md) 相关配置项。
+
+### `public-path-prefix`
+
++ 通过反向代理访问 TiDB Dashboard 时，配置反向代理提供服务的路径前缀。
++ 默认："/dashboard"
++ 若不通过反向代理访问 TiDB Dashboard，请勿配置该配置项，否则可能导致 TiDB Dashboard 无法正常访问。关于该配置的详细使用场景，参见 [通过反向代理使用 TiDB Dashboard](/dashboard/dashboard-ops-reverse-proxy.md)。
+
+### `disable-telemetry`
+
++ 是否禁用 TiDB Dashboard 遥测功能。
++ 默认：false
++ 参阅[遥测](/telemetry.md)章节了解该功能详情。

production-deployment-using-tiup.md

@@ -202,3 +202,7 @@ mysql -u root -h 10.0.1.4 -P 4000
 
 - [TiCDC 任务管理](/ticdc/manage-ticdc.md)
 - [TiCDC 常见问题](/ticdc/troubleshoot-ticdc.md)
+
+> **注意：**
+>
+> TiDB、TiUP 及 TiDB Dashboard 默认会收集使用情况信息，并将其分享给 PingCAP 用于改善产品。若要了解收集的信息详情及如何禁用这个行为，请参见[遥测](/telemetry.md)章节。

production-offline-deployment-using-tiup.md

@@ -264,3 +264,7 @@ tiup cluster start tidb-test
 预期日志结尾输出会有 ```Deployed cluster `tidb-test` successfully``` 关键词，表示部署成功。
 
 部署完成后，集群相关操作可参考 [cluster 命令](/tiup/tiup-cluster.md)。
+
+> **注意：**
+>
+> TiDB 和 TiUP 默认会收集使用情况信息，并将其分享给 PingCAP 用于改善产品。若要了解收集的信息详情及如何禁用这个行为，请参见[遥测](/telemetry.md)章节。

quick-start-with-tidb.md

@@ -40,7 +40,7 @@ category: how-to
 
     ```shell
     source .bash_profile
-    ``` 
+    ```
 
 3. 在当前 session 执行以下命令启动集群。
 
@@ -63,7 +63,7 @@ category: how-to
         上述命令会在本地下载并启动一个 `v4.0.0` 版本的集群，`--monitor` 表示同时部署监控组件。
         最新版本可以通过执行 `tiup list tidb` 来查看。
         运行结果将显示集群的访问方式：
-        
+
         ```log
         CLUSTER START SUCCESSFULLY, Enjoy it ^-^
         To connect TiDB: mysql --host 127.0.0.1 --port 4000 -u root
@@ -149,7 +149,7 @@ category: how-to
 3. 如果机器已经安装 TiUP cluster，需要更新软件版本：
 
     {{< copyable "shell-regular" >}}
-    
+
     ```shell
     tiup update --self && tiup update cluster
     ```
@@ -160,7 +160,7 @@ category: how-to
     2. 重启 sshd 服务：
 
         {{< copyable "shell-regular" >}}
-        
+
         ```shell
         service sshd restart
         ```
@@ -176,7 +176,7 @@ category: how-to
     配置模板如下：
 
     {{< copyable "shell-regular" >}}
-    
+
     ```yaml
     # # Global variables are applied to all deployments and used as the default value of
     # # the deployments if a specific deployment value is missing.
@@ -185,12 +185,12 @@ category: how-to
      ssh_port: 22
      deploy_dir: "/tidb-deploy"
      data_dir: "/tidb-data"
-     
+
     # # Monitored variables are applied to all the machines.
     monitored:
      node_exporter_port: 9100
      blackbox_exporter_port: 9115
-     
+
     server_configs:
      tidb:
        log.slow-threshold: 300
@@ -201,40 +201,40 @@ category: how-to
        replication.enable-placement-rules: true
      tiflash:
        logger.level: "info"
-     
+
     pd_servers:
      - host: 10.0.1.1
-     
+
     tidb_servers:
      - host: 10.0.1.1
-     
+
     tikv_servers:
      - host: 10.0.1.1
        port: 20160
        status_port: 20180
-     
+
      - host: 10.0.1.1
        port: 20161
        status_port: 20181
-     
+
      - host: 10.0.1.1
        port: 20162
        status_port: 20182
-     
+
     tiflash_servers:
      - host: 10.0.1.1
-     
+
     monitoring_servers:
      - host: 10.0.1.1
-     
+
     grafana_servers:
      - host: 10.0.1.1
     ```
 
 6. 执行集群部署命令：
 
     {{< copyable "shell-regular" >}}
-    
+
     ```shell
     tiup cluster deploy <cluster-name> <tidb-version> ./topo.yaml --user root -p
     ```
@@ -243,7 +243,7 @@ category: how-to
     - 参数 `<tidb-version>` 表示设置集群版本，可以通过 `tiup list tidb` 命令来查看当前支持部署的 TiDB 版本
 
     按照引导，输入”y”及 root 密码，来完成部署：
-    
+
     ```log
     Do you want to continue? [y/N]:  y
     Input SSH password:
@@ -252,7 +252,7 @@ category: how-to
 7. 启动集群：
 
     {{< copyable "shell-regular" >}}
-    
+
     ```shell
     tiup cluster start <cluster-name>
     ```
@@ -266,25 +266,25 @@ category: how-to
         ```
 
     - 访问 TiDB 的 Grafana 监控：
-    
+
         通过 <http://{grafana-ip}:3000> 访问集群 Grafana 监控页面，默认用户名和密码均为 admin。
-    
+
     - 访问 TiDB 的 Dashboard：
-    
+
         通过 <http://{pd-ip}:2379/dashboard> 访问集群 TiDB Dashboard 监控页面，默认用户名为 root，密码为空。
-    
+
     - 执行以下命令确认当前已经部署的集群列表：
 
         ```shell
         tiup cluster list
         ```
-    
+
     - 执行以下命令查看集群的拓扑结构和状态：
 
         ```shell
         tiup cluster display <cluster-name>
         ```
-        
+
 ## 第三种：使用 TiDB-Wasm 一键体验 TiDB 数据库
 
 - 适用场景：初步极速体验 TiDB 数据库的语法、兼容性等基本功能
@@ -307,3 +307,7 @@ TiDB-Wasm 是运行在浏览器中的 TiDB 数据库，打开网页即可使用
     - 在线部署：[使用 TiUP 部署 TiDB 集群](/production-deployment-using-tiup.md)
     - 离线部署：[使用 TiUP 离线部署 TiDB 集群](/production-offline-deployment-using-tiup.md)
     - [使用 TiDB Operator 在云上部署 TiDB](https://docs.pingcap.com/zh/tidb-in-kubernetes/v1.1)
+
+> **注意：**
+>
+> TiDB、TiUP 及 TiDB Dashboard 默认会收集使用情况信息，并将其分享给 PingCAP 用于改善产品。若要了解收集的信息详情及如何禁用这个行为，请参见[遥测](/telemetry.md)章节。