Skip to content

Commit 01c9735

Browse files
committed
revive telemetry documentation and expose under /admin
1 parent 2aae1ac commit 01c9735

File tree

3 files changed

+26
-36
lines changed

3 files changed

+26
-36
lines changed

docs/admin/telemetry.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
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 installation. For example, we do not collect parameters, environment variables, or passwords.
8+
9+
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).
10+
11+
Telemetry can be configured with the `CODER_TELEMETRY=x` environment variable.
12+
13+
For example, telemetry can be disabled with `CODER_TELEMETRY=false`.
14+
15+
`CODER_TELEMETRY=true` is our default level. It includes user email and IP addresses. This information is used in aggregate to understand where our users are and general demographic information. We may reach out to the deployment admin, but will never use these emails for outbound marketing.
16+
17+
`CODER_TELEMETRY=false` disables telemetry altogether.
18+
19+
## How we use telemetry
20+
21+
We use telemetry to build product better and faster. Without telemetry, we don't know which features are most useful, we don't know where users are dropping off in our funnel, and we don't know if our roadmap is aligned with the demographics that really use Coder.
22+
23+
Typical SaaS companies collect far more than what we do with little transparency and configurability. It's hard to imagine our favorite products today existing without their backers having good intelligence.
24+
25+
We've decided the only way we can make our product open-source _and_ build at a fast pace is by collecting usage data as well.

docs/manifest.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -136,7 +136,7 @@
136136
},
137137
{
138138
"title": "Admin",
139-
"description": "How to install and deploy Coder",
139+
"description": "How to administer and manage Coder",
140140
"icon_path": "./images/icons/cog.svg",
141141
"children": [
142142
{

docs/telemetry.md

Lines changed: 0 additions & 35 deletions
This file was deleted.

0 commit comments

Comments
 (0)