Reference
Telemetry
As of v0.7.5
As of September 2024, this version of Wave Terminal is deprecated. To learn more about our new version (>=v0.8.0), check out www.waveterm.dev. To find documentation for our new version, check out docs.waveterm.dev.
/telemetry:on command and turned off with the /telemetry:off command.
Sending Telemetry
Provided that telemetry is enabled, it is sent 30 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 asUploaded so it will not need to be sent again.
Sending via Manual Command
Telemetry can be sent manually with the/telemetry:send command if telemetry is active. If telemetry is deactivated, it is still possible to manually send it, but it must be done with the /telemetry:send force=1 command instead. This does not reset the usual timer for telemetry sends.
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 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 thesstore.TelemetryData type in the source code.
| Name | Description |
|---|---|
| NumCommands | The number of Waveterm commands run on a given day. |
| 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. |
| ClickShared | See Deprecated Telemetry References |
| HistoryView | The number of times the user has used the History command on a given day. It specifically refers to the history feature located in the sidebar that opens its own gui. |
| BookmarksView | The number of times the user has used the Bookmarks command on a given day. |
| NumConns | The total number of connections created on this Waveterm installation. This count includes connections that have been deleted and includes all of the various ways a user can make a connection. Unlike the other data, this always includes the total number of connections that have been created—not just the ones created each day. |
| NumWorkspaces | The number of workspaces open on a given day. |
| 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. |
| NumAIChatOpen | The number of times AI chat has been opened on a given day. |
| NumHistoryOpen | The number of times the user has used the CmdInput History feature. This is located in the input prompt at the bottom of the screen and opens up the history in a dedicated box above the prompt. |
| ReinitBashErrors | The number of re-initialization errors that have happened in a bash shell on a given day. |
| ReinitZshErrors | The number of re-initialization errors that have happened in a zsh shell on a given day. |
Associated Data
In addition to the telemetry data collected, the following is also reported. It is stored in thesstore.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. |
| DefaultShell | This lists the shell type that Waveterm automatically detects (e.g. bash or zsh). This is a duplicate entry (also in Telemetry Metadata) that will likely be removed in the future. |
| 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 thepcloud.TelemetryInputType in the source code.
| Name | Description |
|---|---|
| UserId | See Deprecated Telemetry References |
| Client Id | This is an anonymous UUID created when Waveterm is first launched. It is used for telemetry and sending prompts to Open AI. |
| CurDay | The current day (in your time zone) when telemetry is sent. It does not include the time of day. |
| DefaultShell | This lists the shell type that Waveterm automatically detects. (e.g. bash or zsh) |
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 thepcloud.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.
Deprecated Telemetry References
| Name | Description |
|---|---|
| WebShareLimit | This piece of telemetry existed for a feature from early development that was deprecated before the initial launch. While it is possible that this feature will come back in the future, there are no plans to bring it back at this time. As such, it is currently unused. |
| ClickShared | The number of times the user has used the Shared command on a given day. While the command still exists, it does not actually do anything, so it is marked as deprecated. |
| UserId | This is an anonymous UUID created when Waveterm is first launched. It is still sent along with the ClientId when sending regular telemetry messages, but is not used when telemetry is turned off. It as marked as deprecated since it is not used and will be removed from the code in a future update. |