microsoft / gather

Spit shine for Jupyter notebooks 🧽✨
https://microsoft.github.io/gather
MIT License
532 stars 38 forks source link

Add optional, opt-in logging #3

Open andrewhead opened 5 years ago

andrewhead commented 5 years ago

Describe the solution you'd like It would be great if we could collect usage data from people who are using code gathering tools in their work. This could help us decide on future improvements to this tool, and collect data that could be shared other researchers and tool builders build better notebook tools.

Data collection would be strictly opt-in, and would be off by default.

Additional context To do this, we would need the following:

Some of the events we might want to collect are:

andrewhead commented 5 years ago

For an example of a popup in the JupyterLab code, see the "change kernel" popup: https://github.com/jupyterlab/jupyterlab/blob/master/packages/apputils/src/clientsession.tsx#L395. This creates and reads the values set in a Dialog widget.

See here for instructions on persistent state storage for saving a user ID.

May want to add validation for the email field.