Skip to content

Commit 963d0a8

Browse files
peterbarnett03peterbarnett03
committed
docs: add usage telemetry documentation
1 parent 2247ab5 commit 963d0a8

File tree

3 files changed

+133
-0
lines changed

3 files changed

+133
-0
lines changed

‎content/influxdb3/core/reference/telemetry.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
---
2+
title: Usage telemetry
3+
seotitle: InfluxDB Core usage telemetry
4+
description: >
5+
InfluxDB Core can collect and send usage telemetry data to help improve the
6+
product.
7+
menu:
8+
influxdb3_core:
9+
parent: Reference
10+
weight: 108
11+
influxdb3/core/tags: [telemetry, monitoring, metrics, observability]
12+
source: /shared/influxdb3-admin/telemetry.md
13+
---
14+
15+
<!--
16+
The content of this file is located at
17+
content/shared/influxdb3-admin/telemetry.md
18+
-->

‎content/influxdb3/enterprise/reference/telemetry.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
---
2+
title: Usage telemetry
3+
seotitle: InfluxDB Enterprise usage telemetry
4+
description: >
5+
InfluxDB Enterprise can collect and send usage telemetry data to help improve the
6+
product.
7+
menu:
8+
influxdb3_enterprise:
9+
parent: Reference
10+
weight: 108
11+
influxdb3/enterprise/tags: [telemetry, monitoring, metrics, observability]
12+
source: /shared/influxdb3-admin/telemetry.md
13+
---
14+
15+
<!--
16+
The content of this file is located at
17+
content/shared/influxdb3-admin/telemetry.md
18+
-->

‎content/shared/influxdb3-admin/telemetry.md

Lines changed: 97 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,97 @@
1+
InfluxDB 3 can collect and send usage telemetry data to help improve the product. This page describes what telemetry data is collected, when it's collected, how it's transmitted, and how to disable it.
2+
3+
## What data is collected
4+
5+
{{< product-name >}} collects the following telemetry data:
6+
7+
### System metrics
8+
9+
- **CPU utilization**: Process-specific CPU usage (min, max, average)
10+
- **Memory usage**: Process memory consumption in MB (min, max, average)
11+
- **Cores**: Number of CPU cores in use
12+
- **OS**: Operating system information
13+
- **Version**: {{< product-name >}} version
14+
- **Uptime**: Server uptime in seconds
15+
16+
### Write metrics
17+
18+
- **Write requests**: Number of write operations (min, max, average, hourly sum)
19+
- **Write lines**: Number of lines written (min, max, average, hourly sum)
20+
- **Write bytes**: Amount of data written in MB (min, max, average, hourly sum)
21+
22+
### Query metrics
23+
24+
- **Query requests**: Number of query operations (min, max, average, hourly sum)
25+
26+
### Storage metrics
27+
28+
- **Parquet file count**: Number of Parquet files (when available)
29+
- **Parquet file size**: Total size of Parquet files in MB (when available)
30+
- **Parquet row count**: Total number of rows in Parquet files (when available)
31+
32+
### Processing engine metrics
33+
34+
- **WAL triggers**: Write-Ahead Log trigger counts (when available)
35+
- **Schedule triggers**: Scheduled processing trigger counts (when available)
36+
- **Request triggers**: Request-based processing trigger counts (when available)
37+
38+
### Instance information
39+
40+
- **Instance ID**: Unique identifier for the server instance
41+
- **Cluster UUID**: Unique identifier for the cluster (same as catalog UUID)
42+
- **Storage type**: Type of object storage being used
43+
{{% show-in "core" %}}
44+
- **Product type**: "Core"
45+
{{% /show-in %}}
46+
{{% show-in "enterprise" %}}
47+
- **Product type**: "Enterprise"
48+
{{% /show-in %}}
49+
50+
## Collection frequency
51+
52+
- **System metrics** (CPU, memory): Collected every 60 seconds
53+
- **Write and query metrics**: Collected per operation, rolled up every 60 seconds
54+
- **Storage and processing engine metrics**: Collected at snapshot time (when available)
55+
- **Instance information**: Static data collected once
56+
57+
Telemetry data is transmitted once per hour.
58+
59+
## Disable telemetry
60+
61+
Disables sending telemetry data to InfluxData.
62+
63+
**Default:** `false`
64+
65+
| influxdb3 flag | Environment variable |
66+
| :------------- | :------------------- |
67+
| `--disable-telemetry-upload` | `INFLUXDB3_TELEMETRY_DISABLE_UPLOAD` |
68+
69+
#### Command line flag
70+
```sh
71+
influxdb3 serve --disable-telemetry-upload
72+
```
73+
74+
#### Environment variable
75+
```sh
76+
export INFLUXDB3_TELEMETRY_DISABLE_UPLOAD=true
77+
```
78+
79+
When telemetry is disabled, no usage data is collected or transmitted.
80+
81+
## Data handling
82+
83+
The telemetry data is used by InfluxData to:
84+
85+
- Understand product usage patterns
86+
- Improve product performance and reliability
87+
- Prioritize feature development
88+
- Identify and resolve issues
89+
90+
No personally identifiable information (PII) is collected.
91+
92+
## Privacy and security
93+
94+
- All telemetry data is transmitted securely via HTTPS
95+
- No database contents, queries, or user data is collected
96+
- Only operational metrics and system information is transmitted
97+
- Data collection follows InfluxData's privacy policy

0 commit comments

Comments
 (0)