feat: add doc for telemetry and usage data #4619
Merged
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 telemetry investigation in #3788 led to a couple issues being opened to improve the events we're sending, but one of the comments was that we don't really have this written down anywhere. Some other projects contain a USAGE_DATA.md file, so this is my attempt to both write down what we collect and why for users, but also start some coding notes for committers. Feedback appreciated. Fixes #3788. Signed-off-by: Tim deBoer <git@tdeboer.ca>
deboer-tim
requested review from
jeffmaury and
lstocchi
and removed request for
a team
benoitf
reviewed
Nov 2, 2023
Responded to PR feedback: - Changed setting location to use $HOME. - Added location of anonymous id. - Added info on how to import TelemetryLogger. - Error object was originally meant to be pseudocode but it looks too much like an object, changed to typescript. Signed-off-by: Tim deBoer <git@tdeboer.ca>
benoitf
approved these changes
Nov 6, 2023
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.
What does this PR do?
The telemetry investigation in #3788 led to a couple issues being opened to improve the events we're sending, but one of the comments was that we don't really have this written down anywhere.
Some other projects contain a USAGE_DATA.md file, so this is my attempt to both write down what we collect and why for users, but also start some coding notes for committers. Feedback appreciated.
Screenshot/screencast of this PR
N/A
What issues does this PR fix or reference?
Fixes #3788.
How to test this PR?
N/A