mirror of https://github.com/zed-industries/zed.git synced 2024-12-28 20:01:33 +00:00

Don't rely on relative path for docs preprocessor (#16883 )

Reapplies #16700 with a corrected command. Now it no longer relies on a
relative path.

Thanks @maxdeviant for the quick help 🙏 

Release Notes:

- N/A

2024-08-26 11:43:13 -04:00

3.6 KiB

Raw Blame History

Telemetry in Zed

Zed collects anonymous telemetry data to help the team understand how people are using the application and to see what sort of issues they are experiencing.

Configuring Telemetry Settings

You have full control over what data is sent out by Zed. To enable or disable some or all telemetry types, open your settings.json file via {#action zed::OpenSettings}({#kb zed::OpenSettings}) from the command palette.

Insert and tweak the following:

"telemetry": {
    "diagnostics": false,
    "metrics": false
},

The telemetry settings can also be configured via the welcome screen, which can be invoked via the {#action workspace::Welcome} action in the command palette.

Dataflow

Telemetry is sent from the application to our servers. Data is proxied through our servers to enable us to easily switch analytics services. We currently use:

Axiom: Cloud-monitoring service - stores diagnostic events
Clickhouse: Business Intelligence platform - stores both diagnostic and metric events
Metabase: Dashboards - dashboards built around data pulled from Clickhouse

Types of Telemetry

Diagnostics

Diagnostic events include debug information (stack traces) from crash reports. Reports are sent on the first application launch after the crash occurred. We've built dashboards that allow us to visualize the frequency and severity of issues experienced by users. Having these reports sent automatically allows us to begin implementing fixes without the user needing to file a report in our issue tracker. The plots in the dashboards also give us an informal measurement of the stability of Zed.

You can see what data is sent when a panic occurs by inspecting the Panic struct in crates/telemetry_events/src/telemetry_events.rs in the zed repo. You can find additional information in the Debugging Crashes documentation.

Usage Data (Metrics)

To improve Zed and understand how it is being used in the wild, Zed optionally collects usage data like the following:

(a) file extensions of opened files;
(b) features and tools You use within the Editor;
(c) project statistics (e.g., number of files); and
(d) frameworks detected in Your projects

Usage Data does not include any of Your software code or sensitive project details. Metric events are reported over HTTPS, and requests are rate-limited to avoid using significant network bandwidth.

Usage Data is associated with a secure random telemetry ID which may be linked to Your email address. This linkage currently serves two purposes: (1) it allows Zed to analyze usage patterns over time while maintaining Your privacy; and (2) it enables Zed to reach out to specific user groups for feedback and improvement suggestions.

You can audit the metrics data that Zed has reported by running the command {#action zed::OpenTelemetryLog} from the command palette, or clicking Help > View Telemetry Log in the application menu.

You can see the full list of the event types and exactly the data sent for each by inspecting the Event enum and the associated structs in [crates/telemetry_events/src/telemetry_events.rs](https://github.com/zed-industries/zed/blob/main/crates/telemetry_events/src/telemetry_events.rs#L63] in the zed repo.

Concerns and Questions

If you have concerns about telemetry, please feel free to open issues in our Zed repository.

3.6 KiB Raw Blame History