diff --git a/docs/pages/connect-your-client/teleport-connect.mdx b/docs/pages/connect-your-client/teleport-connect.mdx index 3baae962acab3..31b17016b2ada 100644 --- a/docs/pages/connect-your-client/teleport-connect.mdx +++ b/docs/pages/connect-your-client/teleport-connect.mdx @@ -151,6 +151,30 @@ installation directory to the `Path` user environment variable. +## Telemetry + +(!docs/pages/includes/teleport-connect-telemetry.mdx!) + +### Disabling telemetry + +If you initially agreed to share telemetry data, but now want to opt out, you need to update the `app_config.json` file: +```json +"usageReporting.enabled": false +``` + + +The Teleport Connect configuration file is located at `~/Library/Application Support/Teleport Connect/app_config.json`. + + +The Teleport Connect configuration file is located at `~/.config/Teleport Connect/app_config.json`. + + +The Teleport Connect configuration file is located at `C:\Users\%UserName%\AppData\Roaming\Teleport Connect\app_config.json`. + + + +The changes will take effect at the next launch. + ## Troubleshooting Logging out of a cluster, closing the app and logging in again resets all app state related to that diff --git a/docs/pages/faq.mdx b/docs/pages/faq.mdx index e82345a213809..8f51a2b85625e 100644 --- a/docs/pages/faq.mdx +++ b/docs/pages/faq.mdx @@ -127,3 +127,9 @@ are exceeding the usage limits of their license. The reporting library code is Reach out to `sales@goteleport.com` if you have questions about the commercial editions of Teleport. + +### Teleport Connect + +(!docs/pages/includes/teleport-connect-telemetry.mdx!) + +If you no longer want to send usage data, see [disabling telemetry](./connect-your-client/teleport-connect.mdx#disabling-telemetry). diff --git a/docs/pages/includes/teleport-connect-telemetry.mdx b/docs/pages/includes/teleport-connect-telemetry.mdx new file mode 100644 index 0000000000000..cef822949144a --- /dev/null +++ b/docs/pages/includes/teleport-connect-telemetry.mdx @@ -0,0 +1,21 @@ +When you first start the app, Teleport Connect asks for permission to collect and send telemetry data. +This includes tracking events such as: +- Logging in to a cluster +- Starting an SSH, database, or Kubernetes session +- File transfer during an SSH session +- Creating an Access Request +- Reviewing an Access Request +- Assuming an Access Request + +On login, we also collect some device-related data: + +- Operating system and its version +- App version +- Processor architecture + +Additionally, we ask for a job role (answer is optional). + +The full list of events and collected data is defined as [protocol buffer messages in the Teleport source](https://github.com/gravitational/teleport/tree/branch/v(=teleport.major_version=)/proto/prehog/v1alpha/connect.proto). +We do not track the details of those events but merely that the given event took place. Each event includes +the cluster name and user name anonymized with HMAC with the internal cluster ID as the key – it’s impossible for us +to resolve that anonymized token back to a particular cluster or user.