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.

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
Changes from 1 commit
Commits
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
Fix copyable
  • Loading branch information
breezewish committed Jun 29, 2020
commit 9f372f89df036ee5cc0ebe64bd26afd1488e7077
22 changes: 5 additions & 17 deletions telemetry.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ ADMIN SHOW TELEMETRY;

使用 TiUP 时,可通过设置 `TIUP_CLUSTER_DEBUG=enable` 环境变量输出执行命令时收集的使用情况信息,例如:

breezewish marked this conversation as resolved.
Show resolved Hide resolved
{{< copyable "shell" >}}
{{< copyable "shell-regular" >}}

```bash
TIUP_CLUSTER_DEBUG=enable tiup cluster list
Expand All @@ -70,8 +70,6 @@ TIUP_CLUSTER_DEBUG=enable tiup cluster list

创建配置文件 `tidb_config.toml` 包含如下内容:

{{< copyable "toml" >}}

```toml
enable-telemetry = false
```
Expand All @@ -87,15 +85,13 @@ enable-telemetry = false

创建配置文件 `tidb_config.toml` 包含如下内容:

{{< copyable "toml" >}}

```toml
enable-telemetry = false
```

启动 TiUP Playground 时,指定命令行参数 `--db.config tidb_config.toml` 使得该配置生效,如:

{{< copyable "shell" >}}
{{< copyable "shell-regular" >}}

```bash
tiup playground --db.config tidb_config.toml
Expand All @@ -110,8 +106,6 @@ tiup playground --db.config tidb_config.toml

修改部署拓扑文件 `topology.yaml`,新增(或在现有项中添加)以下内容:

{{< copyable "yaml" >}}

```yaml
server_configs:
tidb:
Expand Down Expand Up @@ -171,8 +165,6 @@ SET GLOBAL tidb_enable_telemetry = 0;

创建配置文件 `pd_config.toml` 包含如下内容:

{{< copyable "toml" >}}

```toml
[dashboard]
disable-telemetry = true
Expand All @@ -189,16 +181,14 @@ disable-telemetry = true

创建配置文件 `pd_config.toml` 包含如下内容:

{{< copyable "toml" >}}

```toml
[dashboard]
disable-telemetry = true
```

启动 TiUP Playground 时,指定命令行参数 `--pd.config pd_config.toml` 使得该配置生效,如:

{{< copyable "shell" >}}
{{< copyable "shell-regular" >}}

```bash
tiup playground --pd.config pd_config.toml
Expand All @@ -213,8 +203,6 @@ tiup playground --pd.config pd_config.toml

修改部署拓扑文件 `topology.yaml`,新增(或在现有项中添加)以下内容:

{{< copyable "yaml" >}}

```yaml
server_configs:
pd:
Expand Down Expand Up @@ -259,7 +247,7 @@ dashboard:

可通过执行以下命令禁用 TiUP 遥测功能:

{{< copyable "shell" >}}
{{< copyable "shell-regular" >}}

```bash
tiup telemetry disable
Expand All @@ -279,7 +267,7 @@ ADMIN SHOW TELEMETRY;

对于 TiUP 遥测,可通过执行以下命令查看遥测状态:

{{< copyable "shell" >}}
{{< copyable "shell-regular" >}}

```bash
tiup telemetry status
Expand Down