Skip to content

Commit 9e4d052

Browse files
ammarioghuntley
authored andcommitted
docs: describe our telemetry
1 parent bf63cc9 commit 9e4d052

File tree

2 files changed

+55
-0
lines changed

2 files changed

+55
-0
lines changed

docs/manifest.json

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -210,6 +210,18 @@
210210
}
211211
]
212212
},
213+
{
214+
"title": "Admin",
215+
"description": "How to install and deploy Coder",
216+
"icon_path": "./images/icons/cog.svg",
217+
"children": [
218+
{
219+
"title": "Telemetry",
220+
"description": "Learn what usage telemetry Coder collects",
221+
"path": "./admin/telemetry.md"
222+
}
223+
]
224+
},
213225
{
214226
"title": "Contributing",
215227
"description": "Learn how to contribute to Coder",

docs/telemetry.md

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
# Telemetry
2+
3+
Coder collects telemetry data from all free installations. Our users have the right to know what we collect, why we collect it, and how we use the data.
4+
5+
## What we collect
6+
7+
First of all, we do not collect any information that could threaten the security of your
8+
installation. For example, we do not collect parameters,
9+
environment variables, or passwords.
10+
11+
You can find a full list of the data we collect in the source code [here](https://github.com/coder/coder/blob/main/coderd/telemetry/telemetry.go).
12+
13+
We offer three levels of telemetry that can be configured with the
14+
`CODER_TELEMETRY=x` environment variable. For example, telemetry level 1 can
15+
be configured with `CODER_TELEMETRY=1`.
16+
17+
`CODER_TELEMETRY=2` is our default level. It includes user email and
18+
IP addresses. This information is used in aggregate to understand where our
19+
users are and general demographic information. We may reach out to the
20+
deployment admin, but will never use these emails for outbound marketing.
21+
22+
`CODER_TELEMETRY=1` is our lightweight telemetry setting. It excludes
23+
email and IP addresses, but everything else in the aforementioned source
24+
code is still sent out. In this level, it is nearly impossible for Coder
25+
to associate an installation to specific organizations or users.
26+
27+
`CODER_TELEMETRY=0` disables telemetry altogether. We reserve this setting
28+
for our enterprise customers. You can also reach out to contact@coder.com if
29+
you need a zero-telemetry license due to security policy requirements.
30+
31+
## How we use telemetry
32+
33+
We use telemetry to build product better and faster. Without telemetry, we don't
34+
know which features are most useful, we don't know where users are dropping
35+
off in our funnel, and we don't know if our roadmap is aligned with the
36+
demographics that really use Coder.
37+
38+
Typical SaaS companies collect far more than what we do with little transparency
39+
and configurability. It's hard to imagine our favorite products today existing
40+
without their backers having good intelligence.
41+
42+
We've decided the only way we can make our product open-source _and_ build
43+
at a fast pace is by collecting usage data as well.

0 commit comments

Comments
 (0)