docs: document how and why we collect data when using Unleash #4020
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
daveleek
reviewed
Jun 20, 2023
daveleek
reviewed
Jun 20, 2023
daveleek
requested changes
Jun 20, 2023
thomasheartman
approved these changes
Jun 20, 2023
| ## Managing data collection settings {#managing-data-collection-settings} | ||
| We understand that privacy preferences may vary among our users. While the data collected by Unleash is limited and anonymous, we provide options to manage data collection settings: | ||
|
|
||
| **Disabling All Telemetry**: If you have previously disabled the version telemetry by setting the environment variable `CHECK_VERSION` to anything other than "true," both the version telemetry and the feature telemetry will be disabled. This respects your choice to opt out of all telemetry data if you had previously disabled it. |
There was a problem hiding this comment.
Just wondering: is the env variable case sensitive? That is, will "True" also collect metrics? We should probably be clear about that.
There was a problem hiding this comment.
Ah, that was a great a question. So I went and looked. In practise this actually does 3 checks: a case sensitive check for "true", a case sensitive check for "t" and a case sensitive check for the string "1". I've updated the docs here to reflect this
…ct and expand on the variables for disabling it
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This adds documentation for how we collect data in Unleash. Previously this had been a very small amount of data but it was quite hidden in our docs in terms of what it did and why. This makes this extremely explicit, with guidelines on how to disable it and confirmation that previously disabling data collection will continue to work as expected