search

cargo-bins / cargo-binstall

Binary installation for rust projects
GNU General Public License v3.0
1.61k stars 58 forks source link

docs: mention `quickinstall` telemetry collection in `--help` and README #1890

Closed AlexTMjugador closed 2 months ago

AlexTMjugador commented 3 months ago

These changes describe the usage statistics collected when the quickinstall strategy is used by default, according to the discussion and details brought forward on https://github.com/cargo-bins/cargo-binstall/issues/1884. Both the project README and the CLI long help contain clear disclosures of such statistics collection now.

NobodyXu commented 2 months ago

cc @alsuren I have a few questions on quickinstall (asked by @AlexTMjugador )

Who will use the telemetry data.

I think https://warehouse-clerk-tmp.vercel.app/api/stats is publicly accessible.

For how long the data will be stored.

I honestly don't know, though if the data access is public, then I would essentially say it is permanently saved.

alsuren commented 2 months ago

cc @alsuren I have a few questions on quickinstall (asked by @AlexTMjugador )

Who will use the telemetry data.

I think https://warehouse-clerk-tmp.vercel.app/api/stats is publicly accessible.

Yup. If you hammer it too hard then vercel and the redis provider start sending me emails about rate limiting, and everyone's cargo-binstall clients will start printing warnings about the stats server being down (the original cargo-quickinstall client doesn't bother though: it lets the stats http request silently fail).

For how long the data will be stored.

I honestly don't know, though if the data access is public, then I would essentially say it is permanently saved.

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 https://github.com/cargo-bins/cargo-quickinstall/pull/165 , which is still running - I just checked my influx dashboard and it has data in it from today).

NobodyXu commented 2 months ago

Many thanks @alsuren , cc @AlexTMjugador does that answer your questions?

AlexTMjugador commented 2 months ago

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 README based on alsuren's insights :+1:

NobodyXu commented 2 months ago

Thank you!

Merging this in...