search

joshwcomeau / guppy

šŸ A friendly application manager and task runner for React.js
ISC License
3.27k stars 154 forks source link

add analytics tags to search #365

Closed Haroenv closed 5 years ago

Haroenv commented 5 years ago

Summary:

We add these tags so we can filter the analytics on searches done by Guppy alone. If you have interest in seeing those analytics, please make an Algolia account and let me know!

AWolf81 commented 5 years ago

What is possible with these tags? Can you please add a screenshot of how it looks in Algolia and a brief description what we can do with it? I haven't used these tags before is there a docs section about them on Algolia?

Overall this looks good. I have just two points that would be good to add:

  1. Add the tracking info to PRIVACY.md & mention what it is tracking and that it's another analytics provider we're using - @joshwcomeau could you please help with the privacy text?
  2. Make an opt-out from the Algolia tracking possible. I think we can use the same button to toggle it in File/Preferences... (just if it's a usage tracking) grafik
Haroenv commented 5 years ago

This doesnā€™t add any tracking actually, it just filters the search queries done (anonymously & aggregated). However, turning analytics off altogether can make sense, and is something possible. Iā€™m on mobile now, so I canā€™t make any screenshots, but I will Monday.

Haroenv commented 5 years ago
screenshot 2019-02-20 at 10 05 36 screenshot 2019-02-20 at 10 05 58 screenshot 2019-02-20 at 10 05 49

Here's screenshots of what the analytics looks like. Note that this isn't filtered on Guppy only (also Yarn, Gatsby, codesandbox etc.) because I'd need this PR to be released before being able to pinpoint this to only Guppy usage.

superhawk610 commented 5 years ago

I'll advocate for this PR, as I believe it's important to be good stewards of Algolia's service since they're providing it free of charge. Some services (Reddit's API comes to mind) actually require that you identify yourself in order to make any requests, so I don't think it would be problematic in any way to add this to Guppy's Algolia integration.

If we want to add an opt-out for analytics, that's really outside the scope of this and deserves its own PR.

Since it's only logging the application's ID and nothing specific to each user, I don't think it even really justifies a mention in PRIVACY.md. If anything, we could add a link to Algolia's privacy policy and terms of service.

Haroenv commented 5 years ago

Rebased!

Haroenv commented 5 years ago

Damn it, how did this cause conflicts!