Telemetry

docs/index.mdx

@@ -16,6 +16,7 @@ References:
 
 * [Key Bindings](./keybindings)
 * [Configuration](./config)
+* [Telemetry](./telemetry)
 
 ## Features
 

docs/telemetry.mdx

@@ -0,0 +1,88 @@
+---
+sidebar_position: 3
+id: "telemetry"
+title: "Telemetry"
+---
+
+Wave Terminal collects telemetry data to help us track feature use, direct future product efforts, and generate aggregate metrics on Wave's popularity and usage.  We do not collect or store any PII (personal identifiable information) and all metric data is only associated with and aggregated using your randomly generated _ClientId_.  You may opt out of collection at any time.
+
+If you would like to turn telemetry on or off, the first opportunity is a button on the initial welcome page. After this, it can be turned off by adding `"telemetry:enabled": false` to the `config/settings.json` file. It can alternatively be turned on by adding `"telemetry:enabled": true` to the `config/settings.json` file.
+
+---
+
+## Sending Telemetry
+Provided that telemetry is enabled, it is sent 10 seconds after Waveterm is first booted and then again every 4 hours thereafter. It can also be sent in response to a few special cases listed below. When telemetry is sent, it is grouped into individual days as determined by your time zone. Any data from a previous day is marked as `Uploaded` so it will not need to be sent again.
+
+### Sending Once Telemetry is Enabled
+As soon as telemetry is enabled, a telemetry update is sent regardless of how long it has been since the last send. This does not reset the usual timer for telemetry sends.
+
+### Notifying that Telemetry is Disabled
+As soon as telemetry is disabled, Waveterm sends a special update that notifies us of this change. See [When Telemetry is Turned Off](#when-telemetry-is-turned-off) for more info. The timer still runs in the background but no data is sent.
+
+
+### When Waveterm is Closed
+Provided that telemetry is enabled, it will be sent when Waveterm is closed.
+
+---
+
+## Telemetry Data
+
+When telemetry is active, we collect the following data. It is stored in the `telemetry.TelemetryData` type in the source code.
+
+| Name | Description |
+|------|-------------|
+| ActiveMinutes | The number of minutes that the user has actively used Waveterm on a given day. This requires the terminal window to be in focus while the user is actively interacting with it. |
+| FgMinutes | The number of minutes that Waveterm has been in the foreground on a given day. This requires the terminal window to be in focus regardless of user interaction.|
+| OpenMinutes |The number of minutes that Waveterm has been open on a given day. This only requires that the terminal is open, even if the window is out of focus.|
+| NumTabs | The number of existing tabs open on a given day. |
+| NewTab | The number of new tabs opened on a given day. |
+| NumStartup | The number of times waveterm has been started on a given day. |
+| NumShutdown | The number of times waveterm has been shut down on a given day. |
+| Renderers | The number of new block views of each type are open on a given day. |
+
+## Associated Data
+In addition to the telemetry data collected, the following is also reported. It is stored in the `telemetry.ActivityType` type in the source code.
+
+| Name | Description |
+|------|-------------|
+| Day | The date the telemetry is associated with. It does not include the time. |
+| Uploaded | A boolean that indicates if the telemetry for this day is finalized. It is false during the day the telemetry is associated with, but gets set true at the first telemetry upload after that. Once it is true, the data for that particular day will not be sent up with the telemetry any more. |
+| TzName | The code for the timezone the user's OS is reporting (e.g. PST, GMT, JST) |
+| TzOffset | The offset for the timezone the user's OS is reporting (e.g. -08:00, +00:00, +09:00) |
+| ClientVersion | Which version of Waveterm is installed. |
+| ClientArch | This includes the user's operating system (e.g. linux or darwin) and architecture (e.g. x86_64 or arm64). It does not include data for any Connections at this time. |
+| BuildTime | This serves as a more accurate version number that keeps track of when we built the version. It has no bearing on when that version was installed by you.|
+| OSRelease | This lists the version of the operating system the user has installed. |
+
+## Telemetry Metadata
+Lastly, some data is sent along with the telemetry that describes how to classify it. It is stored in the `wcloud.TelemetryInputType` in the source code.
+
+| Name | Description |
+|------|-------------|
+| UserId | Currently Unused. This is an anonymous UUID intended for use in future features. |
+| ClientId | This is an anonymous UUID created when Waveterm is first launched. It is used for telemetry and sending prompts to Open AI.
+| AppType | This is used to differentiate the current version of waveterm from the legacy app. |
+| AutoUpdateEnabled | Whether or not auto update is turned on. |
+| AutoUpdateChannel | The type of auto update in use. This specifically refers to whether a stable or beta channel is selected. |
+| CurDay | The current day (in your time zone) when telemetry is sent. It does not include the time of day.
+
+---
+
+## When Telemetry is Turned Off
+
+When a user disables telemetry, Waveterm sends a notification that their anonymous _ClientId_ has had its telemetry disabled. This is done with the `wcloud.NoTelemetryInputType` type in the source code. Beyond that, no further information is sent unless telemetry is turned on again. If it is turned on again, the previous 30 days of telemetry will be sent.
+
+---
+
+## A Note on IP Addresses
+Telemetry is uploaded via https, which means your IP address is known to the telemetry server.  We **do not** store your IP address in our telemetry table and **do not** associate it with your _ClientId_.
+
+---
+
+## Previously Collected Telemetry Data
+While we believe the data we collect with telemetry is fairly minimal, we cannot make that decision for every user. If you ever change your mind about what has been collected previously, you may request that your data be deleted by emailing us at [[email protected]](mailto:[email protected]). If you do, we will need your _ClientId_ to remove it.
+
+---
+
+## Privacy Policy
+For a summary of the above, you can take a look at our [Privacy Policy](https://www.waveterm.dev/privacy).

docusaurus.config.ts

@@ -55,7 +55,7 @@ const config: Config = {
             logo: {
                 src: "img/logo/wave-light.png",
                 srcDark: "img/logo/wave-dark.png",
-                href: "https://beta.waveterm.dev/",
+                href: "https://waveterm.dev/",
             },
             hideOnScroll: true,
             items: [

sidebars.ts

@@ -17,6 +17,11 @@ const sidebars: SidebarsConfig = {
             id: "config",
             label: "Configuration",
         },
+        {
+            type: "doc",
+            id: "telemetry",
+            label: "Telemetry",
+        },
     ],
 };