Telemetry
Overview
Section titled “Overview”Runbooks collects anonymous telemetry data to help us understand how the tool is used and prioritize improvements. We’ve designed our telemetry with privacy in mind: it’s minimal, anonymous, and easy to disable.
Telemetry is enabled by default, but you can opt out at any time using the methods described below.
What We Collect
Section titled “What We Collect”We collect the following anonymous data:
| Category | Data Points | Purpose |
|---|---|---|
| Commands | open, watch invocations | Understand which commands are most used |
| Platform | Operating system, architecture | Ensure compatibility across platforms |
| Version | Runbooks version | Track adoption of new versions |
| Blocks | Block types in runbooks (Command, Check, Template, Inputs) | Prioritize feature development |
| Errors | Error types (not messages or content) | Improve reliability |
What We Do NOT Collect
Section titled “What We Do NOT Collect”We take your privacy seriously. We never collect:
- Runbook content - Your runbook text, scripts, or commands
- File paths - The location of your runbooks on disk
- Variable values - Any input values you enter
- Script output - The results of running commands
- Personal identifiable information - No names, emails, or usernames
- IP addresses - We configure our analytics provider to discard IPs
How We Anonymize Data
Section titled “How We Anonymize Data”We generate an anonymous identifier for each user based on a SHA-256 hash of your machine’s hostname and username. This means:
- Stable: The same ID is used across sessions on your machine
- Anonymous: The hash cannot be reversed to identify you
- Unique: Different machines/users have different IDs
We cannot determine who you are from this identifier.
How to Disable Telemetry
Section titled “How to Disable Telemetry”Environment Variable
Section titled “Environment Variable”Set the RUNBOOKS_TELEMETRY_DISABLE environment variable to 1:
# Add to your shell profile (~/.bashrc, ~/.zshrc, etc.) for permanent opt-outexport RUNBOOKS_TELEMETRY_DISABLE=1App Setting
Section titled “App Setting”You can also disable telemetry from within the Runbooks app via the Settings panel.
Telemetry Notice
Section titled “Telemetry Notice”When telemetry is enabled, Runbooks displays a notice in the app settings indicating that telemetry is active. You can disable it directly from there, or set the RUNBOOKS_TELEMETRY_DISABLE=1 environment variable. When you disable telemetry, the notice will no longer appear.
Learn more: https://runbooks.gruntwork.io/security/telemetry/
Data Storage and Retention
Section titled “Data Storage and Retention”Telemetry data is sent to Mixpanel, a third-party analytics service. Data is:
- Transmitted securely over HTTPS
- Stored according to Mixpanel’s data retention policies
- Accessible only to the Gruntwork team
Open Source Transparency
Section titled “Open Source Transparency”Runbooks is open source, and our telemetry implementation is fully visible in the codebase:
- Main process:
src/telemetry.ts - Frontend:
web/src/contexts/IpcTelemetryContext.tsx
You can review exactly what data is collected and how it’s sent.
Why We Collect Telemetry
Section titled “Why We Collect Telemetry”As an open source project, telemetry helps us:
- Prioritize features - Understand which capabilities matter most to users
- Fix bugs faster - Identify and address the most impactful issues
- Support platforms - Know which operating systems and architectures to prioritize
- Measure adoption - Track how new versions are being adopted
We’re committed to building Runbooks in the open and respecting user privacy. If you have questions or concerns about our telemetry practices, please open an issue on GitHub.