docs: mention quickinstall telemetry collection in --help and README
#1890
Conversation
These changes describe the usage statistics collected when the `quickinstall` strategy is used by default, according to the discussion and details brought forward on #1884. Both the project README and the CLI long help contain clear disclosures of such statistics collection now. Signed-off-by: Alejandro González <[email protected]>
README.md
Outdated
| ## Telemetry collection | ||
|
|
||
| Some crate installation strategies may collect anonymized usage statistics by default. | ||
| Currently, only the name of the crate to be installed, its version, and the target platform triple are sent to endpoints under the `https://warehouse-clerk-tmp.vercel.app/api/crate` URL when the `quickinstall` artifact host is used. |
There was a problem hiding this comment.
Yeah, this url makes me really sad, but I think it is correct.
I should really finish that work to switch onto fly.io+influxdb at some point (or use cloud flare/whatever). At the moment my head is deep in python/js/vr/robotics labs though, so realistically it's not going to happen unless someone steps up to do it.
|
cc @alsuren I have a few questions on quickinstall (asked by @AlexTMjugador )
I think https://warehouse-clerk-tmp.vercel.app/api/stats is publicly accessible.
I honestly don't know, though if the data access is public, then I would essentially say it is permanently saved. |
Yup. If you hammer it too hard then vercel and the redis provider start sending me emails about rate limiting, and everyone's
Yup. At some point I did a slight change to the redis schema and wiped out the stats before that point, but I think I did a dump before that, so l could probably give you those old stats if you want them. It's possible that other people have also scraped the stats. The stats collected aren't much different from the download stats that are collected on crates.io for https://crates.io/crates?sort=downloads , but with the addition of the architecture triple and the user agent version (which version of cargo-quickinstall or cargo-binstall are you using to do the download?). Code for the stats server lives at https://github.com/alsuren/warehouse-clerk-tmp/tree/master/pages/api . It's a basic vercel app (using the nextjs router for its api routes) that reports to redis. It also forwards things onto a fly.io server which sends stats on to influxdb cloud (this is made of cargo-bins/cargo-quickinstall#165 , which is still running - I just checked my influx dashboard and it has data in it from today). |
|
Many thanks @alsuren , cc @AlexTMjugador does that answer your questions? |
|
Yup, all clear now! Thank you both for answering my questions. I've just pushed a commit to add some interesting extra details to the |
Signed-off-by: Alejandro González <[email protected]>
|
Thank you! Merging this in... |
These changes describe the usage statistics collected when the
quickinstallstrategy is used by default, according to the discussion and details brought forward on #1884. Both the project README and the CLI long help contain clear disclosures of such statistics collection now.