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
Show file tree
Hide file tree
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
Address comments
  • Loading branch information
breezewish committed Jun 29, 2020
commit 15e6f8dcc8dd540ec683c9725bc446e15be12fe1
2 changes: 1 addition & 1 deletion pd-configuration-file.md
Original file line number Diff line number Diff line change
Expand Up @@ -291,7 +291,7 @@ PD 中内置的 [TiDB Dashboard](/dashboard/dashboard-intro.md) 相关配置项

+ 通过反向代理访问 TiDB Dashboard 时,配置反向代理提供服务的路径前缀。
+ 默认:"/dashboard"
+ 若不通过反向代理访问 TiDB Dashboard,**请勿配置该配置项**,否则可能导致 TiDB Dashboard 无法正常访问。关于该配置的详细使用场景,参见[通过反向代理使用 TiDB Dashboard](/dashboard/dashboard-ops-reverse-proxy.md)。
+ 若不通过反向代理访问 TiDB Dashboard,**请勿配置该项**,否则可能导致 TiDB Dashboard 无法正常访问。关于该配置的详细使用场景,参见[通过反向代理使用 TiDB Dashboard](/dashboard/dashboard-ops-reverse-proxy.md)。

### `disable-telemetry`

Expand Down
24 changes: 18 additions & 6 deletions telemetry.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ TiDB、TiUP 及 TiDB Dashboard 默认会收集使用情况信息,并将这些

## 哪些使用情况信息会被收集?

以下具体描述了各个组件收集并分享的使用情况信息。若收集的使用情况信息有变化,将在版本更新说明中告知。
以下章节具体描述了各个组件收集并分享的使用情况信息。若收集的使用情况信息有变化,将在版本更新说明中告知。

> **注意:**
>
Expand Down Expand Up @@ -53,7 +53,7 @@ ADMIN SHOW TELEMETRY;

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

```bash
```shell
TIUP_CLUSTER_DEBUG=enable tiup cluster list
```

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

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

{{< copyable "" >}}

```toml
enable-telemetry = false
```
Expand All @@ -85,6 +87,8 @@ enable-telemetry = false

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

{{< copyable "" >}}

```toml
enable-telemetry = false
```
Expand All @@ -93,7 +97,7 @@ enable-telemetry = false

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

```bash
```shell
tiup playground --db.config tidb_config.toml
```

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

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

{{< copyable "" >}}

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

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

{{< copyable "" >}}

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

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

{{< copyable "" >}}

```toml
[dashboard]
disable-telemetry = true
Expand All @@ -190,7 +200,7 @@ disable-telemetry = true

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

```bash
```shell
tiup playground --pd.config pd_config.toml
```

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

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

{{< copyable "" >}}

```yaml
server_configs:
pd:
Expand Down Expand Up @@ -249,7 +261,7 @@ dashboard:

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

```bash
```shell
tiup telemetry disable
```

Expand All @@ -269,7 +281,7 @@ ADMIN SHOW TELEMETRY;

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

```bash
```shell
tiup telemetry status
```

Expand Down