Skip to main content
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.
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, you can find a similar button by opening the settings menu (located at the bottom of the left sidebar). It can alternatively be turned on with the /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 as Uploaded 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 the sstore.TelemetryData type in the source code.

​
Associated Data

In addition to the telemetry data collected, the following is also reported. It is stored in the sstore.ActivityType type in the source code.

​
Telemetry Metadata

Lastly, some data is sent along with the telemetry that describes how to classify it. It is stored in the pcloud.TelemetryInputType in the source code.

​
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 pcloud.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

​
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]. 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.