Add telemetry docs (pingcap#3062)

* Add telemetry docs

* Sync changes from CN doc

* Apply suggestions from code review

Co-authored-by: TomShawn <41534398+TomShawn@users.noreply.github.com>

* Apply suggestions

* Opt out -> Disable

* Apply suggestions from code review

Co-authored-by: TomShawn <41534398+TomShawn@users.noreply.github.com>

* Address remaining comments

* Apply suggestions from code review

Co-authored-by: TomShawn <41534398+TomShawn@users.noreply.github.com>
Co-authored-by: ti-srebot <66930949+ti-srebot@users.noreply.github.com>

TOC.md

@@ -414,6 +414,7 @@
       + [tiup-cluster](/tiup/tiup-cluster.md)
       + [tiup-mirror](/tiup/tiup-mirrors.md)
       + [tiup-bench](/tiup/tiup-bench.md)
+  + [Telemetry](/telemetry.md)
   + [Errors Codes](/error-codes.md)
   + [TiCDC Overview](/ticdc/ticdc-overview.md)
   + [TiCDC Open Protocol](/ticdc/ticdc-open-protocol.md)

dashboard/dashboard-intro.md

@@ -7,7 +7,7 @@ aliases: ['/docs/dev/dashboard/dashboard-intro/']
 
 # TiDB Dashboard Introduction
 
-> **Warning:**
+> **Note:**
 >
 > TiDB Dashboard is still an experimental feature. It is **NOT** recommended that you use it in the production environment.
 
@@ -66,3 +66,7 @@ See [Search Logs Page](/dashboard/dashboard-log-search.md) for details.
 This is an advanced debugging feature that lets you profile each instance online and analyze various internal operations an instance performed during the profiling data collection period and the proportion of the operation execution time in this period without third-party tools.
 
 See [Profile Instances Page](/dashboard/dashboard-profiling.md) for details.
+
+> **Note:**
+>
+> By default, TiDB Dashboard shares usage details with PingCAP to help understand how to improve the product. For details about what is shared and how to disable the sharing, see [Telemetry](/telemetry.md).

offline-deployment-using-ansible.md

@@ -175,3 +175,7 @@ See [Edit the `inventory.ini` file to orchestrate the TiDB cluster](/online-depl
 ## Test the TiDB cluster
 
 See [Test the TiDB cluster](/online-deployment-using-ansible.md#test-the-tidb-cluster).
+
+> **Note:**
+>
+> By default, TiDB periodically shares usage details with PingCAP to help understand how to improve the product. For details about what is shared and how to disable the sharing, see [Telemetry](/telemetry.md).

online-deployment-using-ansible.md

@@ -738,6 +738,10 @@ Because TiDB is compatible with MySQL, you must use the MySQL client to connect
     - Address: <http://172.16.10.1:3000>
     - Default account and password: `admin`; `admin`
 
+> **Note:**
+>
+> By default, TiDB periodically shares usage details with PingCAP to help understand how to improve the product. For details about what is shared and how to disable the sharing, see [Telemetry](/telemetry.md).
+
 ## Deployment FAQs
 
 This section lists the common questions about deploying TiDB using TiDB Ansible.

pd-configuration-file.md

@@ -271,3 +271,19 @@ Configuration items related to labels
 
 + The label value for the store that rejected the Leader
 + Default value: `""`
+
+## `dashboard`
+
+Configuration items related to the [TiDB Dashboard](/dashboard/dashboard-intro.md) built in PD.
+
+### `public-path-prefix`
+
++ When TiDB Dashboard is accessed behind a reverse proxy, this item sets the public URL path prefix for all web resources.
++ Default value: `/dashboard`
++ Do **not** modify this configuration item when TiDB Dashboard is accessed not behind a reverse proxy; otherwise, access issues might occur. See [Use TiDB Dashboard behind a Reverse Proxy](/dashboard/dashboard-ops-reverse-proxy.md) for details.
+
+### `disable-telemetry`
+
++ Determines whether to disable the telemetry collection feature in TiDB Dashboard.
++ Default value: `false`
++ See [Telemetry](/telemetry.md) for details.

production-deployment-using-tiup.md

@@ -204,4 +204,8 @@ If you have deployed [TiFlash](/tiflash/tiflash-overview.md) along with the TiDB
 If you have deployed [TiCDC](/ticdc/ticdc-overview.md) along with the TiDB cluster, see the following documents:
 
 - [Manage TiCDC Cluster and Replication Tasks](/ticdc/manage-ticdc.md)
-- [Troubleshoot TiCDC](/ticdc/troubleshoot-ticdc.md)
+- [Troubleshoot TiCDC](/ticdc/troubleshoot-ticdc.md)
+
+> **Note:**
+>
+> By default, TiDB, TiUP and TiDB Dashboard share usage details with PingCAP to help understand how to improve the product. For details about what is shared and how to disable the sharing, see [Telemetry](/telemetry.md).

production-offline-deployment-using-tiup.md

@@ -276,3 +276,7 @@ tiup cluster start tidb-test
 If you see the ``Deployed cluster `tidb-test` successfully`` output at the end of the log, the deployment is successful.
 
 After the deployment, see [Deploy and Maintain TiDB Using TiUP](/tiup/tiup-cluster.md) for the cluster operations.
+
+> **Note:**
+>
+> By default, TiDB and TiUP share usage details with PingCAP to help understand how to improve the product. For details about what is shared and how to disable the sharing, see [Telemetry](/telemetry.md).

quick-start-with-tidb.md

@@ -42,7 +42,7 @@ As a distributed system, a basic TiDB test cluster usually consists of 2 TiDB in
 
     ```shell
     source .bash_profile
-    ``` 
+    ```
 
 3. Start the cluster in the current session:
 
@@ -53,15 +53,15 @@ As a distributed system, a basic TiDB test cluster usually consists of 2 TiDB in
         ```shell
         tiup playground
         ```
-    
+
     - If you want to specify the TiDB version and the number of the instances of each component, run a command like this:
 
         {{< copyable "shell-regular" >}}
 
         ```shell
         tiup playground v4.0.0 --db 2 --pd 3 --kv 3 --monitor
         ```
-    
+
         The command downloads a v4.0.0 cluster to the local machine and starts it. `--monitor` means that the monitoring component is also deployed.
 
         To view the latest version, run `tiup list tidb`.
@@ -188,12 +188,12 @@ Other requirements for the target machine:
      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
@@ -204,32 +204,32 @@ Other requirements for the target machine:
        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
     ```
@@ -273,7 +273,7 @@ Other requirements for the target machine:
         ```shell
         mysql -h 10.0.1.1 -P 4000 -u root
         ```
-    
+
     - Access the Grafana monitoring dashboard at <http://{grafana-ip}:3000>. The default username and password are both `admin`.
 
     - Access the TiDB Dashboard at <http://{pd-ip}:2379/dashboard>. The default username is `root`, and the password is empty.
@@ -285,7 +285,7 @@ Other requirements for the target machine:
         ```shell
         tiup cluster list
         ```
-    
+
     - To view the cluster topology and status:
 
          {{< copyable "shell-regular" >}}
@@ -316,3 +316,7 @@ Click to try TiDB-Wasm playground: <https://tour.tidb.io>. It takes about 10 sec
     - [Deploy TiDB online using TiUP](/production-deployment-using-tiup.md)
     - [Deploy TiDB offline using TiUP](/production-offline-deployment-using-tiup.md)
     - [Deploy TiDB on Cloud using TiDB Operator](https://docs.pingcap.com/tidb-in-kubernetes/v1.1)
+
+> **Note:**
+>
+> By default, TiDB, TiUP and TiDB Dashboard share usage details with PingCAP to help understand how to improve the product. For details about what is shared and how to disable the sharing, see [Telemetry](/telemetry.md).