Skip to content

Commit b038b92

Browse files
killme2008Copilot
andauthored
docs: add null format and uptime telemetry (#1952)
Co-authored-by: Copilot <[email protected]>
1 parent dee04e1 commit b038b92

File tree

4 files changed

+32
-0
lines changed

4 files changed

+32
-0
lines changed

docs/reference/telemetry.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,21 @@ When telemetry is enabled, GreptimeDB will collect the following information eve
2222
- Mode in which GreptimeDB is running(standalone, distributed)
2323
- A randomly generated installation ID
2424
- The number of datanodes in the GreptimeDB cluster
25+
- System uptime, not exact figures, only time ranges like `hours`, `weeks` with no numbers
26+
27+
Sample telemetry data:
28+
```json
29+
{
30+
"os": "linux",
31+
"version": "0.15.1",
32+
"arch": "aarch64",
33+
"mode": "Standalone",
34+
"git_commit": "00d759e828f5e148ec18141904e20cb1cb7577b0",
35+
"nodes": 1,
36+
"uuid": "43717682-baa8-41e0-b126-67b797b66606",
37+
"uptime": "hours"
38+
}
39+
```
2540

2641
## How to disable telemetry?
2742

docs/user-guide/protocols/http.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -176,6 +176,7 @@ http://{{API-host}}/v1/sql
176176
parameters:
177177
- `compression`: `zstd` or `lz4`, default: no compression
178178
- `table`: ASCII table format for console output
179+
- `null`: Concise text-only output of the row count and elapsed time, useful for evaluating query performance.
179180

180181
### Body
181182

i18n/zh/docusaurus-plugin-content-docs/current/reference/telemetry.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,21 @@ description: 介绍 GreptimeDB 的指标收集功能,包括收集的数据类
2222
- GreptimeDB 运行模式(独立、分布式)
2323
- 随机生成的安装 ID
2424
- GreptimeDB 集群中的 datanode 数量
25+
- 系统运行时间,非精确数字,仅为 `hours``weeks` 等时间范围,并且不带数字
26+
27+
数据示例:
28+
```json
29+
{
30+
"os": "linux",
31+
"version": "0.15.1",
32+
"arch": "aarch64",
33+
"mode": "Standalone",
34+
"git_commit": "00d759e828f5e148ec18141904e20cb1cb7577b0",
35+
"nodes": 1,
36+
"uuid": "43717682-baa8-41e0-b126-67b797b66606",
37+
"uptime": "hours"
38+
}
39+
```
2540

2641
## 如何禁用指标收集
2742

i18n/zh/docusaurus-plugin-content-docs/current/user-guide/protocols/http.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -164,6 +164,7 @@ http://{{API-host}}/v1/sql
164164
格式](https://arrow.apache.org/docs/python/feather.html)。附加参数:
165165
- `compression`: `zstd``lz4`,默认:无压缩
166166
- `table`: 控制台输出的 ASCII 表格格式
167+
- `null`: 简洁的纯文本输出,仅显示行数和执行时间,用于评估查询性能。
167168

168169
### Body
169170

0 commit comments

Comments
 (0)