add more details on what's collected

[edublancas]

we're missing details on what we use telemetry for. we should add a section detailing what's collected and why. and also a changelog to indicate any changes.

to answer your question, @machow. we log an anonymous event when certain calls happen, a call to %sql, %%sql, and some methods like in the plotting module (e.g., results.bar()), this allows us to estimate the number of users. we also log error types and messages, we do this to prioritize fixes (if many people have the same error, we probably have a user experience issue there). We do not log the line/cell magic arguments as they might contain sensitive information.

this is optional and you can turn it off: inside ~/.ploomber/stats/config.yaml, change stats_enabled to False

[machow]

Thanks for opening this issue, and the helpful context! Is it possible to disable telemetry using an environment variable? It feels bit rough having a framework adding a global config file, for a largely unrelated task. In any event, I appreciate all the work y'all have put into jupysql and am excited to use it!

[edublancas]

Thanks for your feedback! We set a global config file because this controls telemetry on all our projects; this allows users to shut it down globally.

I just realized we haven't documented it, but yes:

export PLOOMBER_STATS_ENABLED=false

[edublancas]

please don't hesitate to reach out if you have any concerns. telemetry helps us understand usage but it comes second after user experience!