Skip to content

Commit a622eae

Browse files
committed
Add details about information collected by Redpanda Console
1 parent f137bff commit a622eae

2 files changed

Lines changed: 65 additions & 0 deletions

File tree

modules/ROOT/nav.adoc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -198,6 +198,7 @@
198198
*** xref:console:config/deserialization.adoc[Deserialization]
199199
*** xref:console:config/kafka-connect.adoc[Kafka Connect]
200200
*** xref:console:config/topic-documentation.adoc[Topic Documentation]
201+
*** xref:console:config/analytics.adoc[Telemetry]
201202
** xref:manage:recovery-mode.adoc[Recovery Mode]
202203
** xref:manage:rack-awareness.adoc[Rack Awareness]
203204
** xref:manage:monitoring.adoc[]
Lines changed: 64 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
1+
= Redpanda Console Telemetry
2+
:description: Understand what telemetry Redpanda Console collects by default, how it is handled, and how to disable it.
3+
4+
Redpanda Console collects telemetry (analytics) data to improve the product and user experience. This document explains what data is collected, how it is processed, and how you can disable telemetry if desired.
5+
6+
== What is tracked by default
7+
8+
When telemetry is enabled, which is the default behavior, Redpanda Console collects metadata to help improve product functionality and reliability. This data is sent securely to Redpanda.
9+
10+
=== Redpanda Console metadata
11+
12+
The following information is collected from the running instance of Redpanda Console:
13+
14+
- Startup timestamp (when the Redpanda Console process starts)
15+
- Runtime UUID (a unique ID generated per instance)
16+
- Redpanda Console version and build timestamp
17+
- License hash, license type, and license organization
18+
- Kafka configuration hash (anonymized)
19+
- Whether Kafka is connected as `localhost`
20+
21+
=== Redpanda cluster metadata
22+
23+
The following information is collected from the connected Kafka cluster:
24+
25+
- Cluster configuration details (excluding sensitive values)
26+
- Broker log directories
27+
- Topic configurations (settings only, no message contents)
28+
- Consumer group metadata (names and counts only)
29+
- General cluster metadata:
30+
** Number of brokers
31+
** Number of topics
32+
** Number of partitions
33+
34+
=== User tracking
35+
36+
Redpanda Console also tracks individual users for behavior analytics using the following tools:
37+
38+
- link:https://www.heap.io/[Heap]
39+
- link:https://www.hubspot.com/[Hubspot]
40+
41+
Tracking is enabled per unique Redpanda Console user and is used for improving the product experience. No personally identifiable information (PII) is sent.
42+
43+
== How telemetry data is handled
44+
45+
Telemetry data is processed with the following guarantees:
46+
47+
- All telemetry payloads are signed and encoded as JWTs
48+
- Data is sent using HTTPS POST requests to Redpanda's telemetry endpoint
49+
- Data is sent periodically (default interval: every 24 hours)
50+
- Configuration data is anonymized using secure hashes
51+
- No message contents, credentials, or PII are collected or transmitted
52+
53+
== Disable telemetry
54+
55+
To turn off telemetry and user tracking, set the following in your Console configuration file:
56+
57+
[source,yaml]
58+
----
59+
analytics:
60+
enabled: false
61+
----
62+
63+
Restart the Redpanda Console service to apply the change and stop all telemetry and user tracking.
64+

0 commit comments

Comments
 (0)