Skip to content

Commit 97a3cd9

Browse files
committed
docs: describe our telemetry
1 parent 46c6b9e commit 97a3cd9

File tree

2 files changed

+49
-0
lines changed

2 files changed

+49
-0
lines changed

docs/manifest.json

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,12 @@
1414
"description": "Learn how Coder works",
1515
"icon": "<svg xmlns=\"http:\/\/www.w3.org\/2000\/svg\" enable-background=\"new 0 0 24 24\" height=\"24\" viewBox=\"0 0 24 24\" width=\"24\"><g><rect fill=\"none\" height=\"24\" width=\"24\"\/><\/g><g><g><path d=\"M6.36,18.78L6.61,21l1.62-1.54l2.77-7.6c-0.68-0.17-1.28-0.51-1.77-0.98L6.36,18.78z\"\/><path d=\"M14.77,10.88c-0.49,0.47-1.1,0.81-1.77,0.98l2.77,7.6L17.39,21l0.26-2.22L14.77,10.88z\"\/><path d=\"M15,8c0-1.3-0.84-2.4-2-2.82V3h-2v2.18C9.84,5.6,9,6.7,9,8c0,1.66,1.34,3,3,3S15,9.66,15,8z M12,9c-0.55,0-1-0.45-1-1 c0-0.55,0.45-1,1-1s1,0.45,1,1C13,8.55,12.55,9,12,9z\"\/><\/g><\/g><\/svg>",
1616
"path": "./architecture.md"
17+
},
18+
{
19+
"title": "Telemetry",
20+
"description": "How we collect and use your data",
21+
"icon": "<svg xmlns=\"http:\/\/www.w3.org\/2000\/svg\" height=\"24\" viewBox=\"0 0 24 24\" width=\"24\"><path d=\"M0 0h24v24H0z\" fill=\"none\"\/><path d=\"M12 4.5C7 4.5 2.73 7.61 1 12c1.73 4.39 6 7.5 11 7.5s9.27-3.11 11-7.5c-1.73-4.39-6-7.5-11-7.5zM12 17c-2.76 0-5-2.24-5-5s2.24-5 5-5 5 2.24 5 5-2.24 5-5 5zm0-8c-1.66 0-3 1.34-3 3s1.34 3 3 3 3-1.34 3-3-1.34-3-3-3z\"\/><\/svg>",
22+
"path": "./telemetry.md"
1723
}
1824
]
1925
},

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)
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy