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

[Update] Add TiSpark telemetry (#9659) #9910

Merged
Merged
Changes from all commits
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
20 changes: 20 additions & 0 deletions telemetry.md
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,22 @@ ADMIN SHOW TELEMETRY;
TIUP_CLUSTER_DEBUG=enable tiup cluster list
```

### TiSpark

当 TiSpark 遥测功能开启时,Spark 在使用 TiSpark 时会发送会将使用情况信息分享给 PingCAP,包括(但不限于):

- 随机生成的遥测标示符
- TiSpark 的部分配置信息,如读取引擎、是否开启流式读取等
- 用户集群部署情况,包括 TiSpark 所在节点的机器硬件信息、操作系统信息和组件版本号等

使用 TiSpark 时,可以通过查看 Spark 日志来了解 TiSpark 收集的使用情况,可将 Spark 日志级别调至 INFO 或更低,例如:

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

```shell
cat {spark.log} | grep Telemetry report | tail -n 1
```

## 禁用遥测功能

### 部署 TiDB 时禁用 TiDB 遥测
Expand Down Expand Up @@ -233,6 +249,10 @@ server_configs:
tiup telemetry disable
```

### 禁用 TiSpark 遥测

可以通过在 Spark 配置文件设置 `spark.tispark.telemetry.enable = false` 来禁用 TiSpark 的遥测功能。

## 查看遥测启用状态

对于 TiDB 遥测,可通过执行以下 SQL 语句查看遥测状态:
Expand Down