From 9e4d052a0bf909053b0d3b81fee0b91c1112268b Mon Sep 17 00:00:00 2001 From: ammario Date: Fri, 24 Jun 2022 18:32:35 +0000 Subject: [PATCH 1/4] docs: describe our telemetry --- docs/manifest.json | 12 ++++++++++++ docs/telemetry.md | 43 +++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 55 insertions(+) create mode 100644 docs/telemetry.md diff --git a/docs/manifest.json b/docs/manifest.json index 220616e6e46e4..fcad99915599b 100644 --- a/docs/manifest.json +++ b/docs/manifest.json @@ -210,6 +210,18 @@ } ] }, + { + "title": "Admin", + "description": "How to install and deploy Coder", + "icon_path": "./images/icons/cog.svg", + "children": [ + { + "title": "Telemetry", + "description": "Learn what usage telemetry Coder collects", + "path": "./admin/telemetry.md" + } + ] + }, { "title": "Contributing", "description": "Learn how to contribute to Coder", diff --git a/docs/telemetry.md b/docs/telemetry.md new file mode 100644 index 0000000000000..e94174977e66d --- /dev/null +++ b/docs/telemetry.md @@ -0,0 +1,43 @@ +# Telemetry + +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. + +## What we collect + +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. + +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). + +We offer three levels of telemetry that can be configured with the +`CODER_TELEMETRY=x` environment variable. For example, telemetry level 1 can +be configured with `CODER_TELEMETRY=1`. + +`CODER_TELEMETRY=2` 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. + +`CODER_TELEMETRY=1` is our lightweight telemetry setting. It excludes +email and IP addresses, but everything else in the aforementioned source +code is still sent out. In this level, it is nearly impossible for Coder +to associate an installation to specific organizations or users. + +`CODER_TELEMETRY=0` disables telemetry altogether. We reserve this setting +for our enterprise customers. You can also reach out to contact@coder.com if +you need a zero-telemetry license due to security policy requirements. + +## How we use telemetry + +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. + +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. + +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. From 90690984069954675ea4fce23e7570d7776c3684 Mon Sep 17 00:00:00 2001 From: Geoffrey Huntley Date: Wed, 7 Sep 2022 12:19:29 +1000 Subject: [PATCH 2/4] describe the current behaviour Co-authored-by: Ben Potter --- docs/telemetry.md | 16 ++++------------ 1 file changed, 4 insertions(+), 12 deletions(-) diff --git a/docs/telemetry.md b/docs/telemetry.md index e94174977e66d..c8b7230091800 100644 --- a/docs/telemetry.md +++ b/docs/telemetry.md @@ -10,23 +10,15 @@ environment variables, or passwords. 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). -We offer three levels of telemetry that can be configured with the -`CODER_TELEMETRY=x` environment variable. For example, telemetry level 1 can -be configured with `CODER_TELEMETRY=1`. +Telemetry that can be configured with the `CODER_TELEMETRY=x` environment variable. +For example, telemetry can be disabled with `CODER_TELEMETRY=false`. -`CODER_TELEMETRY=2` is our default level. It includes user email and +`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. -`CODER_TELEMETRY=1` is our lightweight telemetry setting. It excludes -email and IP addresses, but everything else in the aforementioned source -code is still sent out. In this level, it is nearly impossible for Coder -to associate an installation to specific organizations or users. - -`CODER_TELEMETRY=0` disables telemetry altogether. We reserve this setting -for our enterprise customers. You can also reach out to contact@coder.com if -you need a zero-telemetry license due to security policy requirements. +`CODER_TELEMETRY=false` disables telemetry altogether. ## How we use telemetry From 59d887de722da5e2dccf46f369d41a45fddc21ed Mon Sep 17 00:00:00 2001 From: Geoffrey Huntley Date: Wed, 7 Sep 2022 02:30:37 +0000 Subject: [PATCH 3/4] revive telemetry documentation and expose under /admin --- docs/admin/telemetry.md | 25 +++++++++++++++++++++++++ docs/manifest.json | 2 +- docs/telemetry.md | 35 ----------------------------------- 3 files changed, 26 insertions(+), 36 deletions(-) create mode 100644 docs/admin/telemetry.md delete mode 100644 docs/telemetry.md diff --git a/docs/admin/telemetry.md b/docs/admin/telemetry.md new file mode 100644 index 0000000000000..72e8b4170239a --- /dev/null +++ b/docs/admin/telemetry.md @@ -0,0 +1,25 @@ +# Telemetry + +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. + +## What we collect + +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. + +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). + +Telemetry can be configured with the `CODER_TELEMETRY=x` environment variable. + +For example, telemetry can be disabled with `CODER_TELEMETRY=false`. + +`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. + +`CODER_TELEMETRY=false` disables telemetry altogether. + +## How we use telemetry + +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. + +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. + +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. diff --git a/docs/manifest.json b/docs/manifest.json index fcad99915599b..ea9f34daf100a 100644 --- a/docs/manifest.json +++ b/docs/manifest.json @@ -212,7 +212,7 @@ }, { "title": "Admin", - "description": "How to install and deploy Coder", + "description": "How to administer and manage Coder", "icon_path": "./images/icons/cog.svg", "children": [ { diff --git a/docs/telemetry.md b/docs/telemetry.md deleted file mode 100644 index c8b7230091800..0000000000000 --- a/docs/telemetry.md +++ /dev/null @@ -1,35 +0,0 @@ -# Telemetry - -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. - -## What we collect - -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. - -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). - -Telemetry that can be configured with the `CODER_TELEMETRY=x` environment variable. -For example, telemetry can be disabled with `CODER_TELEMETRY=false`. - -`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. - -`CODER_TELEMETRY=false` disables telemetry altogether. - -## How we use telemetry - -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. - -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. - -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. From 012c2d05da1103182f4c30c115977910fd856f90 Mon Sep 17 00:00:00 2001 From: Geoffrey Huntley Date: Wed, 7 Sep 2022 02:45:26 +0000 Subject: [PATCH 4/4] add gear.svg from https://coder.com/docs/coder/latest --- docs/images/icons/gear.svg | 1 + docs/manifest.json | 2 +- 2 files changed, 2 insertions(+), 1 deletion(-) create mode 100644 docs/images/icons/gear.svg diff --git a/docs/images/icons/gear.svg b/docs/images/icons/gear.svg new file mode 100644 index 0000000000000..239a11119eeb0 --- /dev/null +++ b/docs/images/icons/gear.svg @@ -0,0 +1 @@ + diff --git a/docs/manifest.json b/docs/manifest.json index ea9f34daf100a..ca4f9cb7eb09c 100644 --- a/docs/manifest.json +++ b/docs/manifest.json @@ -213,7 +213,7 @@ { "title": "Admin", "description": "How to administer and manage Coder", - "icon_path": "./images/icons/cog.svg", + "icon_path": "./images/icons/gear.svg", "children": [ { "title": "Telemetry",