Skip to content

Commit 140ef0c

Browse files
authored
Merge pull request #14 from makeplane/telemetry
Telemetry
2 parents ae71ee5 + 4ae6a67 commit 140ef0c

File tree

2 files changed

+39
-22
lines changed

2 files changed

+39
-22
lines changed

images/disable-telemetry.webp

47.1 KB
Loading

self-hosting/telemetry.mdx

Lines changed: 39 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -1,37 +1,54 @@
11
---
2-
title: Anonymous data collection
2+
title: Data collection and usage
33
sidebarTitle: Telemetry
44
---
5-
If you’re self-hosting Plane and you’ve opted in to provide us with anonymous usage data (thank you!), Plane will phone home some data collected via Posthog.
5+
Plane collects anonymized data to enhance your user experience, ensure product stability, and drive continuous improvements. This article talks about what we collect, what we don't, and how we use collected data.
66

7-
We collect the instance admin emails to communicate in crucial scenarios like checkpoint releases or large migrations.
7+
## What Plane collects
88

9-
### The anonymous data we collect
9+
With the exception of the instance admin's email address on self-hosted Plane, we don't collect any personally identifiable information (PII). All usage data is anonymized and isn't connected to individual users.
1010

11-
We don’t collect any other usernames, emails or the issue titles, descriptions details of any kind, or any personally identifiable information (PII).
11+
### Instance admin details
12+
Plane collects just the instance admin's name and email to communicate essential upgrade news, security alerts, and other critical notifications.
1213

13-
The anonymous data helps us understand how people are actually using Plane, which in turn helps us Prioritize what to work on next.
14+
### Instance setup
15+
When an instance is created, Plane collects just the instance ID so we can track upgrades and troubleshoot paid features.
1416

15-
### Examples of the anonymous data we collect and how we use it
17+
### Usage for billing
18+
Plane tracks the number of workspaces, members, and roles to bill you correctly and ensure accurate reporting in your workspace's **Billing and plans** screen and the Prime portal.
1619

17-
We track some basic events in an anonymised way to find opportunities for improving the product and evaluating project outcomes.
20+
### Application data
21+
Plane tracks anonymized workspace activity, including but not limited to the number of projects, issues, cycles, modules, comments, issue types, custom properties, timesheet downloads, active importers, and integrations. This data helps us understand product usage, adoption, and build new features.
1822

19-
We collect events in the product like:
20-
- When you create an issue or filter a view.
21-
- When you add a table block in a page.
22-
- When you invite a user.
23+
### User interaction and behavior
24+
Plane collects anonymized data for how you work with Plane when creating, updating, or deleting Plane entities, including but not restricted to projects, issues, cycles, modules, and others. This data helps us understand user journeys, pain points, and overall behavior.
2325

24-
This anonymous data helps us figure out things like:
25-
- Which features you’re using.
26-
- Where people get stuck.
27-
- How performance for key workflows (like querying or loading) changes over time.
26+
### Performance
27+
Plane collects machine configurations, environment details, OS flavors, network throughput, and stack traces to help troubleshoot and prevent performance hiccups.
2828

29-
### Opting out of anonymous usage data collection for self-hosted Plane instances
29+
## How do we use the data?
3030

31-
If you’re self-hosting Plane, you can opt out of providing us with your anonymous usage data:
32-
1. Login to the god-mode (/god-mode).
33-
2. Click General settings.
34-
3. Toggle off the Telemetry option.
31+
- **Improving product performance**
32+
Analyzing real-world usage helps us identify performance bottlenecks, optimize resource usage, and ensure that Plane runs smoothly across various environments.
3533

36-
If you’re in the process of setting up your Plane, you can also toggle off tracking during the Usage Data Preferences onboarding step. We collect a few anonymous events before that point, but won’t do so anymore if you choose to opt out.
34+
- **Detecting and fixing bugs**
35+
Identifying bugs and errors as they occur enables us to quickly diagnose and fix issues, minimize downtime, and improving product stability.
36+
37+
- **Understanding user behavior**
38+
Collecting data on how users interact with Plane helps us prioritize feature development and make informed decisions about future enhancements to better meet user needs.
39+
40+
- **Enhancing security**
41+
Monitoring for abnormal patterns helps us identify and mitigate potential security threats or vulnerabilities, ensuring the protection of user data and the integrity of the platform.
42+
43+
- **Informing product development**
44+
Aggregated telemetry provides insight into frequently used features, highlighting areas for improvement and aligning the product roadmap with user expectations.
45+
46+
## Disabling telemetry
47+
As much as we'd love to understand your usage better, we agree that you should be in control of your data. If for any reason you don't want to send us that data, you can turn telemetry collection off in three clicks.
48+
49+
1. Go to your instance's God Mode by appending `/god-mode` to the domain you have hosted Plane on.
50+
2. In the **General Settings** pane on the right, disable the **Telemetry** toggle button.
51+
![Disable telemetry](/images/disable-telemetry.webp)
52+
3. Click **Save changes**.
53+
3754

0 commit comments

Comments
 (0)