en, zh: Add telemetry notes (#511)

* Add telemetry notes * 理解和改善产品 -> 改善产品 * Add EN doc * Fix some links * Address comments * Sync changes from CN doc * Sync changes from docs Co-authored-by: DanielZhangQD <[email protected]>
pingcap · Jun 30, 2020 · c8ecf56 · c8ecf56
1 parent e1097d4
commit c8ecf56
Show file tree

Hide file tree

Showing 16 changed files with 62 additions and 7 deletions.
diff --git a/en/access-dashboard.md b/en/access-dashboard.md
@@ -7,7 +7,7 @@ aliases: ['/docs/tidb-in-kubernetes/dev/access-dashboard/']
 
 # Access TiDB Dashboard
 
-TiDB Dashboard is a visualized tool in TiDB 4.0 used to monitor and diagnose the TiDB cluster. For details, see [TiDB Dashboard](https://github.com/pingcap-incubator/tidb-dashboard).
+TiDB Dashboard is a visualized tool in TiDB 4.0 used to monitor and diagnose the TiDB cluster. For details, see [TiDB Dashboard](https://docs.pingcap.com/tidb/stable/dashboard-intro).
 
 This document describes how to access TiDB Dashboard in Kubernetes.
 

diff --git a/en/deploy-on-alibaba-cloud.md b/en/deploy-on-alibaba-cloud.md
@@ -265,6 +265,10 @@ mysql -h ${tidb_lb_ip} -P 4000 -u root
 
 `tidb_lb_ip` is the LoadBalancer IP of the TiDB service.
 
+> **Note:**
+>
+> By default, TiDB (starting from v4.0.2) 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](https://docs.pingcap.com/tidb/stable/telemetry).
+
 ## Monitor
 
 Visit `<monitor-lb>:3000` to view the Grafana dashboards. `monitor-lb` is the LoadBalancer IP of the Monitor service.

diff --git a/en/deploy-on-aws-eks.md b/en/deploy-on-aws-eks.md
@@ -464,6 +464,10 @@ You can interact with the EKS cluster using `kubectl` and `helm` with the kubeco
     helm ls
     ```
 
+> **Note:**
+>
+> By default, TiDB (starting from v4.0.2) 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](https://docs.pingcap.com/tidb/stable/telemetry).
+
 ## Monitor
 
 You can access the `<monitor-lb>:3000` address (printed in outputs) using your web browser to view monitoring metrics.

diff --git a/en/deploy-on-gcp-gke.md b/en/deploy-on-gcp-gke.md
@@ -207,6 +207,10 @@ This section describes how to deploy a TiDB cluster.
     kubectl --kubeconfig credentials/kubeconfig_${gke_name} create -f db-monitor.yaml -n ${namespace}
     ```
 
+> **Note:**
+>
+> By default, TiDB (starting from v4.0.2) 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](https://docs.pingcap.com/tidb/stable/telemetry).
+
 ## Access the TiDB database
 
 After `terraform apply` is successful executed, perform the following steps to access the TiDB cluster. Replace the `${}` section with the output of running `terraform apply` above.

diff --git a/en/deploy-on-general-kubernetes.md b/en/deploy-on-general-kubernetes.md
@@ -59,3 +59,7 @@ Different clusters can be in the same or different `namespace`, which is based o
 ## Initialize TiDB cluster
 
 If you want to initialize your cluster after deployment, refer to [Initialize a TiDB Cluster in Kubernetes](initialize-a-cluster.md).
+
+> **Note:**
+>
+> By default, TiDB (starting from v4.0.2) 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](https://docs.pingcap.com/tidb/stable/telemetry).
diff --git a/en/deploy-tidb-from-kubernetes-gke.md b/en/deploy-tidb-from-kubernetes-gke.md
@@ -187,6 +187,10 @@ SET PASSWORD FOR 'root'@'%' = '<change-to-your-password>';
 
 Congratulations, you are now up and running with a distributed TiDB database compatible with MySQL!
 
+> **Note:**
+>
+> By default, TiDB (starting from v4.0.2) 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](https://docs.pingcap.com/tidb/stable/telemetry).
+
 ## Scale out the TiDB cluster
 
 To scale out the TiDB cluster, modify `spec.pd.replicas`, `spec.tidb.replicas`, and `spec.tikv.replicas` in the `TidbCluster` object of the cluster to your desired value using kubectl.

diff --git a/en/upgrade-tidb-operator.md b/en/upgrade-tidb-operator.md
@@ -48,3 +48,7 @@ This document describes how to upgrade TiDB Operator and Kubernetes.
 ## Upgrade TiDB Operator from v1.0 to v1.1 or later releases
 
 Since TiDB Operator v1.1.0, PingCAP no longer updates or maintains the tidb-cluster chart. The components and features that have been managed using the tidb-cluster chart will be managed by CR (Custom Resource) or dedicated charts in v1.1. For more details, refer to [TiDB Operator v1.1 Notes](notes-tidb-operator-v1.1.md).
+
+> **Note:**
+>
+> By default, TiDB (starting from v4.0.2) 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](https://docs.pingcap.com/tidb/stable/telemetry).
diff --git a/zh/access-dashboard.md b/zh/access-dashboard.md
@@ -6,7 +6,7 @@ category: how-to
 
 # TiDB Dashboard 指南
 
-TiDB Dashboard 是 TiDB 4.0 专门用来帮助观察与诊断整个 TiDB 集群的可视化面板，你可以在 [TiDB Dashboard](https://github.com/pingcap-incubator/tidb-dashboard) 了解详情。本篇文章将介绍如何在 Kubernetes 环境下访问 TiDB Dashboard。
+TiDB Dashboard 是 TiDB 4.0 专门用来帮助观察与诊断整个 TiDB 集群的可视化面板，你可以在 [TiDB Dashboard](https://docs.pingcap.com/zh/tidb/stable/dashboard-intro) 了解详情。本篇文章将介绍如何在 Kubernetes 环境下访问 TiDB Dashboard。
 
 ## 前置条件
 
@@ -26,7 +26,7 @@ spec:
 
 > **注意：**
 >
-> 以下教程仅为演示如何快速访问 TiDB Dashboard，请勿在生产环境中直接使用以下方法。 
+> 以下教程仅为演示如何快速访问 TiDB Dashboard，请勿在生产环境中直接使用以下方法。
 
 `TiDB Dashboard` 目前在 4.0.0 版本及以上中已经内嵌在了 PD 组件中，你可以通过以下的例子在 Kubernetes 环境下快速部署一个 4.0.1 版本的 TiDB 集群。运行 `kubectl apply -f` 命令，将以下 yaml 文件部署到 Kubernetes 集群中。
 
@@ -58,7 +58,6 @@ spec:
     service:
       type: ClusterIP
     config: {}
-
 ```
 
 当集群创建完毕时，你可以通过以下指令将 `TiDB Dashboard` 暴露在本地机器:

diff --git a/zh/deploy-on-alibaba-cloud.md b/zh/deploy-on-alibaba-cloud.md
@@ -259,6 +259,10 @@ mysql -h ${tidb_lb_ip} -P 4000 -u root
 
 `tidb_lb_ip` 为 TiDB Service 的 LoadBalancer IP。
 
+> **注意：**
+>
+> TiDB（v4.0.2 起）默认会定期收集使用情况信息，并将这些信息分享给 PingCAP 用于改善产品。若要了解所收集的信息详情及如何禁用该行为，请参见[遥测](https://docs.pingcap.com/zh/tidb/stable/telemetry)。
+
 ## 监控
 
 你可以通过浏览器访问 `<monitor-lb>:3000` 地址查看 Grafana 监控指标。

diff --git a/zh/deploy-on-aws-eks.md b/zh/deploy-on-aws-eks.md
@@ -1,5 +1,5 @@
 ---
-title: 在 AWS EKS 上部署 TiDB 
+title: 在 AWS EKS 上部署 TiDB
 summary: 介绍如何在 AWS EKS (Elastic Kubernetes Service) 上部署 TiDB 集群。
 category: how-to
 ---
@@ -494,6 +494,10 @@ mysql -h ${tidb_lb} -P 4000 -u root
     helm ls
     ```
 
+> **注意：**
+>
+> TiDB（v4.0.2 起）默认会定期收集使用情况信息，并将这些信息分享给 PingCAP 用于改善产品。若要了解所收集的信息详情及如何禁用该行为，请参见[遥测](https://docs.pingcap.com/zh/tidb/stable/telemetry)。
+
 ## Grafana 监控
 
 你可以通过浏览器访问 `<monitor-lb>:3000` 地址查看 Grafana 监控指标。
@@ -692,7 +696,7 @@ module "tidb-cluster-b" {
   providers = {
     helm = "helm.eks"
   }
-  
+
   cluster_name = "tidb-cluster-b"
   eks          = module.tidb-operator.eks
   ssh_key_name = module.key-pair.key_name

diff --git a/zh/deploy-on-gcp-gke.md b/zh/deploy-on-gcp-gke.md
@@ -206,6 +206,10 @@ Terraform 自动加载和填充匹配 `terraform.tfvars` 或 `*.auto.tfvars` 文
   kubectl --kubeconfig credentials/kubeconfig_${gke_name} create -f db-monitor.yaml -n ${namespace}
   ```
 
+> **注意：**
+>
+> TiDB（v4.0.2 起）默认会定期收集使用情况信息，并将这些信息分享给 PingCAP 用于改善产品。若要了解所收集的信息详情及如何禁用该行为，请参见[遥测](https://docs.pingcap.com/zh/tidb/stable/telemetry)。
+
 ## 访问 TiDB 数据库
 
 `terraform apply` 运行完成后，可执行以下步骤来访问 TiDB 数据库。注意用[部署 TiDB 集群](#部署-tidb-集群)小节的输出信息替换 `${}` 部分的内容。

diff --git a/zh/deploy-on-general-kubernetes.md b/zh/deploy-on-general-kubernetes.md
@@ -204,3 +204,7 @@ TiDB Operator 部署并配置完成后，可以通过下面命令部署 TiDB 集
 ### 初始化 TiDB 集群
 
 如果要在部署完 TiDB 集群后做一些初始化工作，参考 [Kubernetes 上的集群初始化配置](initialize-a-cluster.md)进行配置。
+
+> **注意：**
+>
+> TiDB（v4.0.2 起）默认会定期收集使用情况信息，并将这些信息分享给 PingCAP 用于改善产品。若要了解所收集的信息详情及如何禁用该行为，请参见[遥测](https://docs.pingcap.com/zh/tidb/stable/telemetry)。
diff --git a/zh/deploy-tidb-from-kubernetes-gke.md b/zh/deploy-tidb-from-kubernetes-gke.md
@@ -247,6 +247,10 @@ SET PASSWORD FOR 'root'@'%' = '<change-to-your-password>';
 
 恭喜，你已经启动并运行一个兼容 MySQL 的分布式 TiDB 数据库！
 
+> **注意：**
+>
+> TiDB（v4.0.2 起）默认会定期收集使用情况信息，并将这些信息分享给 PingCAP 用于改善产品。若要了解所收集的信息详情及如何禁用该行为，请参见[遥测](https://docs.pingcap.com/zh/tidb/stable/telemetry)。
+
 ## 扩容 TiDB 集群
 
 使用 kubectl 修改集群所对应的 `TidbCluster` 对象中的 `spec.pd.replicas`、`spec.tidb.replicas`、`spec.tikv.replicas` 至期望值进行水平扩容。

diff --git a/zh/deploy-tidb-from-kubernetes-kind.md b/zh/deploy-tidb-from-kubernetes-kind.md
@@ -38,7 +38,7 @@ chmod +x ./kind
 测试集群是否创建成功：
 
 ```
-kubectl cluster-info 
+kubectl cluster-info
 ```
 
 ## 第 2 步：部署 TiDB Operator
@@ -184,6 +184,10 @@ kubectl -n pingcap get pods
     >
     > 然后，在浏览器中打开 `http://<远程主机 IP>:3000` 访问 Grafana 监控面板。
 
+> **注意：**
+>
+> TiDB（v4.0.2 起）默认会定期收集使用情况信息，并将这些信息分享给 PingCAP 用于改善产品。若要了解所收集的信息详情及如何禁用该行为，请参见[遥测](https://docs.pingcap.com/zh/tidb/stable/telemetry)。
+
 ## 删除 TiDB 集群 与 Kubernetes 集群
 
 要删除 TiDB 集群，执行以下命令：

diff --git a/zh/deploy-tidb-from-kubernetes-minikube.md b/zh/deploy-tidb-from-kubernetes-minikube.md
@@ -212,6 +212,10 @@ kubectl get svc -n demo --watch
     mysql -h 127.0.0.1 -P 4000 -uroot -e 'select tidb_version();'
     ```
 
+> **注意：**
+>
+> TiDB（v4.0.2 起）默认会定期收集使用情况信息，并将这些信息分享给 PingCAP 用于改善产品。若要了解所收集的信息详情及如何禁用该行为，请参见[遥测](https://docs.pingcap.com/zh/tidb/stable/telemetry)。
+
 ## 监控 TiDB 集群
 
 按照以下步骤监控 TiDB 集群状态：

diff --git a/zh/upgrade-a-tidb-cluster.md b/zh/upgrade-a-tidb-cluster.md
@@ -125,3 +125,7 @@ helm upgrade ${release_name} pingcap/tidb-cluster -f values.yaml --version=${cha
 > ```shell
 > kubectl annotate tc ${release_name} -n ${namespace} tidb.pingcap.com/force-upgrade-
 > ```
+
+> **注意：**
+>
+> TiDB（v4.0.2 起）默认会定期收集使用情况信息，并将这些信息分享给 PingCAP 用于改善产品。若要了解所收集的信息详情及如何禁用该行为，请参见[遥测](https://docs.pingcap.com/zh/tidb/stable/telemetry)。