Skip to content

Conversation

@sukantoraymond
Copy link
Contributor

Closes #579

Description

Tracks command count through mixpanel. Events are tracked with name of format {mainCommand}-{subCommand}

e.g. accounts-get


For contributor use:

  • Targeted PR against master branch
  • Linked to Github issue with discussion and accepted design OR link to spec that describes this work
  • Code follows the standards mentioned here
  • Updated relevant documentation
  • Re-reviewed Files changed in the Github PR explorer
  • Added appropriate labels

@devbugging
Copy link
Contributor

We need to implement an option to disable tracking in an opt-out fashion. MIxpanel allows setting such a property as seen here https://developer.mixpanel.com/docs/javascript#opting-users-out-of-tracking.
There needs to be a command and a way to disable tracking. I suggest adding a command to config: flow config disable metrics which then disables any tracking. We also need to add to documentation what we are tracking and how to disable it, I suggest creating a doc page titled "Data Collection" where it's explained that we only track command data and also the Crash report data we track if user agrees. It needs to be stated that no personal information is ever collected and the all data is anonymized. I think we should ping legal as well.

@sukantoraymond sukantoraymond self-assigned this Jul 22, 2022
@sukantoraymond
Copy link
Contributor Author

The closest thing that I find with regards to the opt out on javascript sdk, is to use user properties as stated in https://developer.mixpanel.com/reference/profile-set. This means that we will start referencing each user to an ID, but since we are not linking their distinct id with the events (in this case the commands), we will not be able to see the commands that they call (which is what we want).

Another option if we want to minimize tracking each user is to implement opt in option either in a new json (like settings.json) or implement a new key in flow.json (sth like tracking_enabled: true/false), so that we can have the option locally everytime. Thoughts on which way we should go?

This was referenced Jul 28, 2022
sukantoraymond and others added 4 commits August 3, 2022 11:38
Co-authored-by: Gregor G. <75445744+sideninja@users.noreply.github.com>
Co-authored-by: Gregor G. <75445744+sideninja@users.noreply.github.com>
Copy link
Contributor

@devbugging devbugging left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Left small coments, LGTM

@sukantoraymond sukantoraymond merged commit 8c1b3c4 into master Aug 3, 2022
@sukantoraymond sukantoraymond deleted the feature/event-tracking-mixpanel branch August 3, 2022 20:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Implement logging of commands through mixpanel

3 participants