Skip to content

Commit 2d07f6f

Browse files
jstirnamanjstirnaman
authored
Merge pull request #6305 from influxdata/pbarnett/add-telemetry-docs
Add Telemetry docs
2 parents ffe93c7 + f230269 commit 2d07f6f

File tree

3 files changed

+131
-0
lines changed

3 files changed

+131
-0
lines changed

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

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
---
2+
title: Usage telemetry
3+
seotitle: InfluxDB 3 Core usage telemetry
4+
description: >
5+
InfluxData collects telemetry data to help improve the {{< product-name >}}.
6+
Learn what data {{< product-name >}} collects and sends to InfluxData, how it's used, and
7+
how you can opt out.
8+
menu:
9+
influxdb3_core:
10+
parent: Reference
11+
weight: 108
12+
influxdb3/core/tags: [telemetry, monitoring, metrics, observability]
13+
source: /shared/influxdb3-reference/telemetry.md
14+
---
15+
16+
<!--
17+
The content of this file is located at
18+
//SOURCE - content/shared/influxdb3-reference/telemetry.md
19+
-->

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

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
---
2+
title: Usage telemetry
3+
seotitle: InfluxDB 3 Enterprise usage telemetry
4+
description: >
5+
InfluxData collects telemetry data to help improve the {{< product-name >}}.
6+
Learn what data {{< product-name >}} collects and sends to InfluxData, how it's used, and
7+
how you can opt out.
8+
menu:
9+
influxdb3_enterprise:
10+
parent: Reference
11+
weight: 108
12+
influxdb3/enterprise/tags: [telemetry, monitoring, metrics, observability]
13+
source: /shared/influxdb3-reference/telemetry.md
14+
---
15+
16+
<!--
17+
The content of this file is located at
18+
//SOURCE - content/shared/influxdb3-reference/telemetry.md
19+
-->

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

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

0 commit comments

Comments
 (0)