Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add Telemetry Docs #3812

Merged
merged 22 commits into from
Jun 30, 2020
Merged

Add Telemetry Docs #3812

Changes from 1 commit
Commits
Show all changes
22 commits
Select commit Hold shift + click to select a range
3740ed3
Add initial contents
breezewish Jun 29, 2020
6b849b2
Supply more docs
breezewish Jun 29, 2020
3d5e18c
update for operator deployment (#3813)
DanielZhangQD Jun 29, 2020
abdc619
Add telemetry notes
breezewish Jun 29, 2020
c1b10da
Merge branch 'telemetry' of github.com:pingcap/docs-cn into telemetry
breezewish Jun 29, 2020
5d7a226
remove TODO
breezewish Jun 29, 2020
b6e20d4
Merge branch 'master' into telemetry
breezewish Jun 29, 2020
1cbda7c
理解和改善产品 -> 理解产品
breezewish Jun 29, 2020
c42d42a
Polish some words
breezewish Jun 29, 2020
5f9c6bc
Reformat
breezewish Jun 29, 2020
c8458b4
Address some comments
breezewish Jun 29, 2020
00f0a0b
Apply suggestions from code review
breezewish Jun 29, 2020
ca76a90
Address some comments
breezewish Jun 29, 2020
5a21adf
Merge branch 'telemetry' of github.com:pingcap/docs-cn into telemetry
breezewish Jun 29, 2020
805b21b
Apply suggestions
breezewish Jun 29, 2020
ad69081
Apply suggestions
breezewish Jun 29, 2020
1253191
Apply suggestions
breezewish Jun 29, 2020
b7bf501
Add missing copyable
breezewish Jun 29, 2020
0c5fd92
Remove doc about telemetry ID
breezewish Jun 29, 2020
9f372f8
Fix copyable
breezewish Jun 29, 2020
15e6f8d
Address comments
breezewish Jun 29, 2020
7ce8400
Merge branch 'master' into telemetry
ti-srebot Jun 30, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Polish some words 
Signed-off-by: Breezewish <me@breeswish.org>
  • Loading branch information
@breezewish
breezewish committed Jun 29, 2020
commit c42d42a2b8356c9a6fea2360ece0e9919540610e
12 changes: 7 additions & 5 deletions telemetry.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,9 +52,9 @@ TIUP_CLUSTER_DEBUG=enable tiup cluster list

## 禁用遥测功能

### 启动 TiDB 前禁用 TiDB 遥测
### 部署 TiDB 时禁用 TiDB 遥测

对于尚未启动的 TiDB 集群，可以为每个 TiDB 配置 [`enable-telemetry = false`](/tidb-configuration-file.md#enable-telemetry) 设置以禁用 TiDB 遥测功能。对于已启动的集群也可以修改该配置，但需要重启 TiDB 后才能生效。
部署 TiDB 集群时，可以为每个 TiDB 配置 [`enable-telemetry = false`](/tidb-configuration-file.md#enable-telemetry) 设置以禁用 TiDB 遥测功能。对于已部署的集群也可以修改该配置，但需要重启 TiDB 后才能生效。
breezewish marked this conversation as resolved.
Show resolved Hide resolved

以下列出了各个部署工具中进行配置修改的具体步骤。
breezewish marked this conversation as resolved.
Show resolved Hide resolved

Expand Down Expand Up @@ -124,13 +124,14 @@ TIUP_CLUSTER_DEBUG=enable tiup cluster list
<details>
<summary>通过 TiDB Operator 在 Kubernetes 部署</summary>
breezewish marked this conversation as resolved.
Show resolved Hide resolved

在 `tidb-cluster.yaml` 中或者 TidbCluster Custom Restource 中配置 `spec.tidb.config.enable-telemetry: false`。
在 `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)。
</details>

### 动态禁用 TiDB 遥测

对于已启动的 TiDB 集群，还可以修改系统全局变量 [`tidb_enable_telemetry`](/tidb-specific-system-variables.md#tidb_enable_telemetry) 动态禁用 TiDB 遥测功能：
对于已部署的 TiDB 集群，还可以修改系统全局变量 [`tidb_enable_telemetry`](/tidb-specific-system-variables.md#tidb_enable_telemetry) 动态禁用 TiDB 遥测功能：

```sql
SET GLOBAL tidb_enable_telemetry = 0;
Expand Down Expand Up @@ -216,7 +217,8 @@ SET GLOBAL tidb_enable_telemetry = 0;
<details>
<summary>通过 TiDB Operator 在 Kubernetes 部署</summary>
breezewish marked this conversation as resolved.
Show resolved Hide resolved

在 `tidb-cluster.yaml` 中或者 TidbCluster Custom Restource 中配置 `spec.pd.config.dashboard.disable-telemetry: true`。
在 `tidb-cluster.yaml` 中或者 TidbCluster Custom Resource 中配置 `spec.pd.config.dashboard.disable-telemetry: true`。

详情参见[在标准 Kubernetes 上部署 TiDB 集群](https://docs.pingcap.com/zh/tidb-in-kubernetes/stable/deploy-on-general-kubernetes)。
</details>

Expand Down