The term telemetry refers to the collection of certain usage data to help improve the quality of a piece of software. Prisma 2 uses telemetry in the context of error reports. This page describes the overall telemetry approach for Prisma 2, what kind of data is collected and how to opt-out of data collection.
During the Preview period, upon an unexpected error you will always be prompted whether you want to submit an error report in order to help improve the quality of the Prisma 2 tools. Error reports are never sent without your explicit consent and never contain personal or other sensitive information. The exclusive purpose of this data collection is to accelerate the development of Prisma 2 towards a General Availability release.
The exclusive purpose of telemetry is to improve the quality of the Prisma 2 tools: Photon, Lift, and Studio. Therefore, the only data that is being tracked relates to the actual usage of these tools and not to any personal or other sensitive information!
Here's a list of information that is contained in an error report:
- Operating system
- Versions of Prisma tools
- Project metadata
Project metadata includes your Prisma schema, used CLI commands or usage of certain features in the Photon API. Note that the connection details of any of your data sources will be obscured in the error report.
Here's a list of information that is never contained in an error report:
- User credentials (keys, secrets, passwords, ...)
- Database connection details (IP, port, database name, ...)
The exclusive purpose of telemetry is to improve the quality of the Prisma 2 tools: Photon, Lift, and Studio. By sharing information about what went wrong in any of the Prisma 2 tools, you can make an easy, yet extremely helpful, contribution to the development of Prisma 2.
During the Preview period, data is potentially collected upon:
- a crash in the CLI
- a crash or an unexpected error in Prisma Studio
Before an error report is submitted, there will always be a prompt asking you to confirm or deny the submission of the error report! Error reports are never submitted without your explicit consent!
During the Preview period, you can opt-out of data collection by responding to the interactive prompt with no.
The way how telemetry is used during the Preview period differs from the way it'll be used after the General Availability release. This page will be continuously updated to reflect the future plans for telemetry.