Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 17 additions & 4 deletions docs/configuration/telemetry.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,15 +4,28 @@ title: Telemetry

# Telemetry

Your privacy is of utmost importance. Runme collects telemetry information, all of which is pseudo-anonymized (no PII). Runme respects both [VS Code's global "no telemetry"](https://code.visualstudio.com/docs/getstarted/telemetry) (id: `telemetry.telemetryLevel`) setting and the common `DO_NO_TRACK=1` environment variable.
Your privacy is of utmost importance. Runme collects anonymous, coarse telemetry information to help improve the product. Runme does not collect command contents, raw arguments, notebook contents, file paths, working directories, environment values, repository remotes, usernames, hostnames, or executable paths.

Telemetry collected includes:
Runme sends telemetry to `home.runme.dev` using separate routes for different components:

- Buttons clicked & commands triggered
- CLI invocation telemetry is sent to `home.runme.dev/CLI`
- Kernel and server startup telemetry is sent to `home.runme.dev/Kernel`

CLI telemetry includes:

- Event name and component
- Runme version
- Operating system and architecture
- Coarse command and command path
- Best-effort install channel

VS Code extension telemetry includes:

- Buttons clicked and commands triggered
- Total cells and how many are executed
- Extension activation and deactivation
- Notebook opened and saved (incl. metadata; file names are obfuscated)

If you don't wish to participate in telemetry, please deactivate it using the available settings.
In VS Code, Runme respects [VS Code's global "no telemetry"](https://code.visualstudio.com/docs/getstarted/telemetry) setting (id: `telemetry.telemetryLevel`). You can also opt out of Runme telemetry by setting either `DO_NOT_TRACK=true` or `SCARF_NO_ANALYTICS=true`.

For more detailed information on security-related aspects, please visit our [Security Overview](/resources/security).
2 changes: 1 addition & 1 deletion docs/resources/faq.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ You can easily switch between Runme's notebook UI and the standard Markdown text

## Why is the extension connecting to home.runme[.]dev on port 443?

The connection to home.runme.dev:443 is related to telemetry, as documented [here](https://docs.runme.dev/configuration/telemetry). Stateful is open-core, and all telemetry data is free of personally identifiable information (PII). If you'd like to disable telemetry, follow the steps in the documentation.
The connection to home.runme.dev:443 is related to telemetry, as documented [here](https://docs.runme.dev/configuration/telemetry). Stateful is open-core, and Runme's telemetry is anonymous and free of personally identifiable information (PII). If you'd like to disable telemetry, follow the steps in the documentation.

Stateful uses the open-source Runme kernel, and telemetry is implemented similarly to an anonymous tracking pixel.

Expand Down
2 changes: 1 addition & 1 deletion docs/resources/security.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ title: Security

## Telemetry and Connection to home.runme.dev

The connection to `home.runme.dev:443` is part of Runme's telemetry system, which is used to collect anonymous usage data for improving the product. All data collected is free of personally identifiable information (PII), ensuring that user privacy is respected.
The connection to `home.runme.dev:443` is part of Runme's telemetry system, which is used to collect anonymous, coarse usage data for improving the product. Runme uses separate routes for CLI telemetry and Kernel/server startup telemetry. All data collected is free of personally identifiable information (PII), ensuring that user privacy is respected.

The telemetry system is designed similarly to an anonymous tracking pixel, a common method used by many open-source projects to gather basic, non-intrusive metrics. Stateful runs the open-source Runme kernel, and this telemetry is part of maintaining and enhancing the open-core functionality of the platform.

Expand Down