feat: add telemetry documentation by SgtPooki · Pull Request #35 · ipfs-shipyard/ignite-metrics

SgtPooki · 2023-01-05T23:22:24Z

note that i’ve made some changes to the groupings of metric features:

removed groups: “tracking”, “marketing”
moved items: “events” is now in “minimal” metrics
new groups: “UX” (scrolls, clicks, forms), “Feedback” (star-rating, feedback), “location” (location)
removed items: “attribution”, “users”

cc @BigLep @lidel @TinyTb @juliaxbow

Callouts for this PR: This PR is intended to close out #29 & ipfs/ipfs-gui#125

Please bring up any concerns you have that I missed

fixes #29 fixes ipfs/ipfs-gui#125

src/MetricsProvider.ts

whizzzkid

thanks for documenting this, some nits.

docs/telemetry/CollectedData.template.md

docs/telemetry/CollectionPolicy.md

docs/telemetry/FAQs.md

src/MetricsProvider.ts

SgtPooki · 2023-01-07T02:17:47Z

docs/telemetry/CollectedData.template.md

+* https://github.com/ipfs-shipyard/ignite-metrics/blob/feature/metric-library/129/docs/telemetry/CollectionPolicy.md
+* https://github.com/ipfs-shipyard/ignite-metrics/blob/feature/metric-library/129/docs/telemetry/PrivacyPolicy.md
+* https://github.com/ipfs-shipyard/ignite-metrics/blob/feature/metric-library/129/docs/telemetry/FAQs.md


This will need to point to main/ prior to merging

(just an idea for the future)
We could replace these with aliases at ipfs.fyi (https://github.com/ipfs/ipfs.fyi):

/telemetry-collection-policy https://github.com...CollectionPolicy.md /telemetry-privacy-policy https://github.com...PrivacyPolicy.md /telemetry-faq https://github.com...FAQs.md

(just an idea for the future) We could replace these with aliases at ipfs.fyi (https://github.com/ipfs/ipfs.fyi):

/telemetry-collection-policy https://github.com...CollectionPolicy.md /telemetry-privacy-policy https://github.com...PrivacyPolicy.md /telemetry-faq https://github.com...FAQs.md

I love the idea but I'm not sure exactly how this works and there doesn't seem to be enough info in the readme. Are we supposed to create a _redirects file in each repo, or just in this repo?

Co-authored-by: Nishant Arora <1895906+whizzzkid@users.noreply.github.com>

docs/telemetry/CollectedData.template.md

Co-authored-by: Nishant Arora <1895906+whizzzkid@users.noreply.github.com>

BigLep · 2023-01-07T06:17:23Z

I got to talk with @SgtPooki and @juliaxbow on 2023-01-06 and relay my mental model of:

reducing complexity for implementation/testing/maintenance
generally maximizing the amount of cases where we're collecting data (so we can be knowledgable about usage) while also not obsessing over it
be able to look at user in the face and feel good about the decisions that are being made

More of my specific comments were captured in that verbal conversation and in https://www.notion.so/pl-strflt/Telemetry-b005d4f217f44db3986902c67d922cf4

I expect to be fully tied up the week of 2023-01-09 and I don't want this work to block on me. I believe I got my perspective across verbally and at this point the only "sign off" I want to make sure we have is from @lidel . (I'd encourage a sync chat the week of 2023-01-09 so can close out on decisions quickly.). I( didn't read this PR - only https://www.notion.so/pl-strflt/Telemetry-b005d4f217f44db3986902c67d922cf4 )

Summary: I'm not a blocking reviewer, but I would like @lidel to be.

Thanks all for navigating here.

Co-authored-by: Nishant Arora <1895906+whizzzkid@users.noreply.github.com>

lidel

We've discussed this plan during a call today, and the proposed telemetry gathering focused on feature usage metrics is sensible. As noted before, I am okay with opt-out telemetry (like Firefox) as long we have a Privacy Policy and 👍 from Legal.

Fine to merge this PR as documentation to unblock things like ipfs/ipfs-companion#1117

Noting the small caveat I mentioned during the call:

We can't ship telemetry enabled by default in webui/desktop without having a privacy policy document first.
- 👉 Right now docs/telemetry/PrivacyPolicy.md is missing, and you refer to https://protocol.ai/legal/#privacy-policy which contains no privacy policy 🙃 🤷 (not blocking this PR, just flagging)

README.md

docs/telemetry/CollectionPolicy.md

docs/telemetry/FAQs.md

docs/telemetry/PrivacyPolicy.md

docs/telemetry/CollectedData.template.md

lidel · 2023-01-11T01:16:15Z

docs/telemetry/CollectedData.template.md

+* https://github.com/ipfs-shipyard/ignite-metrics/blob/feature/metric-library/129/docs/telemetry/CollectionPolicy.md
+* https://github.com/ipfs-shipyard/ignite-metrics/blob/feature/metric-library/129/docs/telemetry/PrivacyPolicy.md
+* https://github.com/ipfs-shipyard/ignite-metrics/blob/feature/metric-library/129/docs/telemetry/FAQs.md


(just an idea for the future)
We could replace these with aliases at ipfs.fyi (https://github.com/ipfs/ipfs.fyi):

/telemetry-collection-policy https://github.com...CollectionPolicy.md /telemetry-privacy-policy https://github.com...PrivacyPolicy.md /telemetry-faq https://github.com...FAQs.md

docs/telemetry/CollectionPolicy.md

SgtPooki · 2023-01-11T17:43:15Z

@lidel

We've discussed this plan during a call today, and the proposed telemetry gathering focused on feature usage metrics is sensible. As noted before, I am okay with opt-out telemetry (like Firefox) as long we have a Privacy Policy and 👍 from Legal.

We got the 👍 from legal to proceed with opt-out metrics for all projects. We will have a privacy policy from legal but do not have one yet (ETA was 1-2 weeks last week)

Fine to merge this PR as documentation to unblock things like ipfs/ipfs-companion#1117

Noting the small caveat I mentioned during the call:

We can't ship telemetry enabled by default in webui/desktop without having a privacy policy document first.

I must have misheard during the call. Where is this constraint coming from? Legal explicitly told us gathering app metrics is not blocked by having a privacy policy.

👉 Right now docs/telemetry/PrivacyPolicy.md is missing, and you refer to https://protocol.ai/legal/#privacy-policy which contains no privacy policy 🙃 🤷 (not blocking this PR, just flagging)

I want to unblock the work required for webui & desktop. How would you recommend I update the content so that the following constraints are met:

Telemetry changes intended for webui & desktop are unblocked
PrivacyPolicy is an obvious placeholder until we get one from Legal

Two potential options:

Referencing the PrivacyPolicy in ipfs-companion (since Legal gave the go-ahead on changes to ipfs-companion without an update to its privacy policy)
Copying the PrivacyPolicy from ipfs-companion, with a note at the top mentioning that it was copied and will be updated soon.

lidel · 2023-01-11T18:46:00Z

We can't ship telemetry enabled by default in webui/desktop without having a privacy policy document first.
Where is this constraint coming from? Legal explicitly told us gathering app metrics is not blocked by having a privacy policy.

I was under the impression that we will link to Privacy Policy and Telemetry Collection Policy documents on the Settings screen near the opt-out button, so the user can read them before deciding to opt-out.

If Legal said shipping without a Privacy Policy is fine, and a proper PP document will land eventually, then a placeholder referencing companion policy for now should be good enough 👍 , but please remove reference to the nonsense protocol.ai/legal/#privacy-policy 😆

Co-authored-by: Marcin Rataj <lidel@lidel.org>

see ipfs-shipyard/ignite-metrics#35

SgtPooki · 2023-01-13T00:42:28Z

I was under the impression that we will link to Privacy Policy and Telemetry Collection Policy documents on the Settings screen near the opt-out button, so the user can read them before deciding to opt-out.

@lidel cc @juliaxbow @whizzzkid

We can add links to both of those if we feel it's necessary, but I would prefer a single location to direct users to, such as the COLLECTION_POLICY in this repo, which links to the PRIVACY_POLICY. Does it make sense to have a separate landing page for users that's more concise? i.e. ./docs/telemetry/README.md ?

ninjaedit:

I threw together a quick demo of what a README.md would allow us to do.. link to https://github.com/ipfs-shipyard/ignite-metrics/tree/feature/telemetry-documentation-landing-page/docs/telemetry

the link would be https://github.com/ipfs-shipyard/ignite-metrics/tree/main/docs/telemetry once merged

## [1.0.2](v1.0.1...v1.0.2) (2023-01-13) ### Documentation * add telemetry documentation ([#35](#35)) ([4cb35ba](4cb35ba))

github-actions · 2023-01-13T01:30:06Z

🎉 This PR is included in version 1.0.2 🎉

The release is available on:

Your semantic-release bot 📦🚀

* feat: add types for state * tmp * feat: ipfs-companion tracks views and sessions * Update add-on/src/lib/telemetry.js Co-authored-by: Nishant Arora <1895906+whizzzkid@users.noreply.github.com> * Update add-on/src/lib/telemetry.js Co-authored-by: Nishant Arora <1895906+whizzzkid@users.noreply.github.com> * Update add-on/src/lib/telemetry.js Co-authored-by: Nishant Arora <1895906+whizzzkid@users.noreply.github.com> * Update add-on/_locales/en/messages.json Co-authored-by: Marcin Rataj <lidel@lidel.org> * Update add-on/_locales/en/messages.json Co-authored-by: Marcin Rataj <lidel@lidel.org> * Update add-on/_locales/en/messages.json Co-authored-by: Marcin Rataj <lidel@lidel.org> * Update add-on/_locales/en/messages.json Co-authored-by: Marcin Rataj <lidel@lidel.org> * chore: fix options and state typings * chore: use debug logger * fix(lint): remove unused method * fix(lint): run 'npm run fix:lint' * chore: build and lint success * chore(types): fix type errors * chore: add docs/telemetry/COLLECTED_DATA.md see ipfs-shipyard/ignite-metrics#35 * chore: update old metric group names in logConsent * chore: clean up UI * chore: use ignite-metrics from npm * chore: update ignite-metrics and some types * fix(tests): tests dont fail on countly-sdk-web import * fix: build * chore: temporarily use updated ignite-metrics * chore: use deployed ignite-metrics version * chore: address PR comments * use latest ignite-metrics library * don't use singleton function for grabbing metricsProvider * ensure metrics initialize and update properly * chore: pin ignite-metrics dependency * chore(lint): fix lint errors * fix: use browser.runtime.sendMessage * Telemetry messages are passed between contexts using browser.runtime * Upgraded to @ipfs-shipyard/ignite-metrics@1.3.0 * Updated consent handling from state to be more explicit --------- Co-authored-by: Nishant Arora <1895906+whizzzkid@users.noreply.github.com> Co-authored-by: Marcin Rataj <lidel@lidel.org>

feat: add telemetry documentation

9e0ce60

fixes #29 fixes ipfs/ipfs-gui#125

SgtPooki requested review from BigLep and whizzzkid January 5, 2023 23:24

SgtPooki self-assigned this Jan 5, 2023

docs: fix markdown link to FAQs document

41a2dbe

SgtPooki marked this pull request as ready for review January 5, 2023 23:26

SgtPooki requested a review from 0xDanomite January 5, 2023 23:26

docs: add FAQ for turning telemetry completely off

7695322

SgtPooki mentioned this pull request Jan 5, 2023

docs: update metrics documentation #29

Closed

12 tasks

0xDanomite reviewed Jan 6, 2023

View reviewed changes

src/MetricsProvider.ts Outdated Show resolved Hide resolved

SgtPooki mentioned this pull request Jan 6, 2023

feat: finalize metrics modal and icon ipfs/public-gateway-checker#340

Closed

ipfs-shipyard deleted a comment from welcome bot Jan 6, 2023

SgtPooki added 3 commits January 5, 2023 19:02

docs: minor updates about user data

1f1acc7

docs: add UI examples and steps for adding telemetry to repo

ce7d99c

docs: reordering and rephrasing

788b34f

whizzzkid approved these changes Jan 6, 2023

View reviewed changes

Update CollectedData.template.md

70e88fc

SgtPooki commented Jan 7, 2023

View reviewed changes

Update docs/telemetry/CollectionPolicy.md

d19132a

Co-authored-by: Nishant Arora <1895906+whizzzkid@users.noreply.github.com>

SgtPooki commented Jan 7, 2023

View reviewed changes

docs/telemetry/CollectedData.template.md Outdated Show resolved Hide resolved

SgtPooki and others added 3 commits January 6, 2023 18:20

Update docs/telemetry/CollectionPolicy.md

02d9f7f

Co-authored-by: Nishant Arora <1895906+whizzzkid@users.noreply.github.com>

Update docs/telemetry/CollectionPolicy.md

1570b54

Co-authored-by: Nishant Arora <1895906+whizzzkid@users.noreply.github.com>

Update docs/telemetry/CollectionPolicy.md

f2f2b65

Co-authored-by: Nishant Arora <1895906+whizzzkid@users.noreply.github.com>

Update docs/telemetry/CollectionPolicy.md

a3fd171

Co-authored-by: Nishant Arora <1895906+whizzzkid@users.noreply.github.com>

lidel mentioned this pull request Jan 11, 2023

feat: add telemetry to companion ipfs/ipfs-companion#1117

Merged

6 tasks

SgtPooki added 3 commits January 10, 2023 17:24

docs: additional clarifications and updates

1a97fe7

docs: more updates

8aef1e4

Merge branch 'main' into feature/telemetry-documentation

5114692

lidel approved these changes Jan 11, 2023

View reviewed changes

SgtPooki and others added 9 commits January 12, 2023 14:14

Update README.md

1cd8e6d

Co-authored-by: Marcin Rataj <lidel@lidel.org>

Update docs/telemetry/CollectedData.template.md

b682ca7

Co-authored-by: Marcin Rataj <lidel@lidel.org>

Update docs/telemetry/CollectionPolicy.md

c40f691

Co-authored-by: Marcin Rataj <lidel@lidel.org>

Update docs/telemetry/CollectionPolicy.md

ca11b03

Co-authored-by: Marcin Rataj <lidel@lidel.org>

chore: update countly url

d698a85

chore(docs): update collectedData.template links

669bc3c

chore: use UPPER_SNAKE_CASE for telemetry docs

7d0f222

Update docs/telemetry/FAQs.md

9b93a1f

Co-authored-by: Marcin Rataj <lidel@lidel.org>

chore(docs): fix links

3930838

SgtPooki added a commit to ipfs/ipfs-companion that referenced this pull request Jan 12, 2023

chore: add docs/telemetry/COLLECTED_DATA.md

090d700

see ipfs-shipyard/ignite-metrics#35

SgtPooki added 3 commits January 12, 2023 15:18

chore(docs): add ipfs-gui team under lead maintainer

f9ff25a

chore: remove multi-toggle images

02087b7

chore: grammar

94ef59d

SgtPooki mentioned this pull request Jan 13, 2023

Add metrics icon ipfs-shipyard/ipfs-css#67

Open

chore: update example screenshot of ipfs-companion

b119380

SgtPooki mentioned this pull request Jan 13, 2023

"countly.ipfs.tech" should be used instead of "https://countly.ipfs.io" #41

Closed

fix: exports

8181dbb

SgtPooki merged commit 4cb35ba into main Jan 13, 2023

SgtPooki deleted the feature/telemetry-documentation branch January 13, 2023 01:24

github-actions bot pushed a commit that referenced this pull request Jan 13, 2023

chore(release): 1.0.2 [skip ci]

242cfd0

## [1.0.2](v1.0.1...v1.0.2) (2023-01-13) ### Documentation * add telemetry documentation ([#35](#35)) ([4cb35ba](4cb35ba))

github-actions bot added the released label Jan 13, 2023

Conversation

SgtPooki commented Jan 5, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

whizzzkid left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

SgtPooki Jan 7, 2023

Choose a reason for hiding this comment

Uh oh!

lidel Jan 11, 2023

Choose a reason for hiding this comment

Uh oh!

SgtPooki Jan 13, 2023

Choose a reason for hiding this comment

Uh oh!

Uh oh!

BigLep commented Jan 7, 2023

Uh oh!

lidel left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

lidel Jan 11, 2023

Choose a reason for hiding this comment

Uh oh!

Uh oh!

SgtPooki commented Jan 11, 2023

Uh oh!

lidel commented Jan 11, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

SgtPooki commented Jan 13, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

github-actions bot commented Jan 13, 2023

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

SgtPooki commented Jan 5, 2023 •

edited

Loading

lidel commented Jan 11, 2023 •

edited

Loading

SgtPooki commented Jan 13, 2023 •

edited

Loading