-
Notifications
You must be signed in to change notification settings - Fork 0
Telemetry
Jen.js may collect telemetry data about your use of the framework as explained below. Telemetry data allows us to monitor and improve Jen.js by collecting anonymous data about its usage and host information. The data may be used to broadly identify, troubleshoot, or respond to issues that impact users.
Collection of telemetry data is optional. If you do not want telemetry data collected, you may opt-out.
Telemetry allows us to accurately gauge Jen.js feature usage, pain points, and customization across all users. This data enables us to better tailor Jen.js to the masses, ensuring its continued growth, relevance, and best-in-class developer experience. Furthermore, this data allows us to verify if improvements are improving the baseline of all applications.
We track general usage information, specifically, we track the following with anonymized telemetry data using random identifiers:
- Command invoked (
dev,build,start,bundle,typecheck, etc.) - Version of
jen.js - General machine information (e.g. number of CPUs, macOS/Windows/Linux, whether or not the command was run within CI)
- Build and server performance metrics (build time, asset count, total bundle size)
- Framework features used (SSG, API routes, middleware, islands, authentication, etc.)
- Node.js and package manager versions
- We DO NOT collect any metrics which may contain sensitive data. This includes, but is not limited to: file paths, file names, environment variables, contents of files, API keys, authentication tokens, or custom application logic.
Note: This list is regularly audited to ensure its accuracy.
You can view exactly what is being collected by setting the following environment variable: DEBUG_TELEMETRY=1.
You may opt out by setting the following environment variable:
TELEMETRY_DISABLED=1Note: DO_NOT_TRACK=1 (Learn more about Console Do Not Track (DNT)) is a standard convention but not currently checked by Jen.js telemetry.
You can check if telemetry is enabled or disabled in your current environment by:
echo $TELEMETRY_DISABLEDIf the environment variable is set to 1, telemetry is disabled. If not set, telemetry is enabled.
Telemetry is enabled by default. To explicitly enable it, unset the environment variables listed above.
All telemetry data is:
- Anonymous: Uses random identifiers, not linked to your identity
- Minimal: Only collects essential usage metrics
- Secure: Transmitted over HTTPS
- Auditable: Full list of events is publicly documented
- Optional: Can be disabled at any time
We take your privacy seriously and do not share individual telemetry data with third parties. Aggregated, anonymized data may be used to improve Jen.js and inform development decisions.
If you have questions about telemetry or privacy, please open an issue on GitHub.