Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add optional, opt-in logging #3

Open
1 of 5 tasks
andrewhead opened this issue Dec 29, 2018 · 1 comment
Open
1 of 5 tasks

Add optional, opt-in logging #3

andrewhead opened this issue Dec 29, 2018 · 1 comment
Labels
enhancement New feature or request suggestion Doesn't need to happen, but would be nice
Milestone

Comments

@andrewhead
Copy link
Collaborator

andrewhead commented Dec 29, 2018

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:

  • Fill out relevant institutional paperwork
  • A non-intrusive, easy-to-dismiss popup that appears when someone uses the tool, that asks if folks want to share their usage data with us, with a description of the data that will be collected, anonymization of the data, and research goals
  • Persistent storage of a user's choice. Use this choice to decide whether to report log events
  • A server (e.g., notebooks.berkeley.edu) that receives log events over a secure server

Some of the events we might want to collect are:

  • when code gathering events get invoked, how large are the slices? Where in the notebook do they come from? Are these slices opened in notebooks, scripts, or as cells in existing notebooks?
@andrewhead andrewhead added enhancement New feature or request suggestion Doesn't need to happen, but would be nice labels Dec 29, 2018
@andrewhead andrewhead added this to the release milestone Dec 29, 2018
@andrewhead
Copy link
Collaborator Author

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request suggestion Doesn't need to happen, but would be nice
Projects
None yet
Development

No branches or pull requests

1 participant