search

ipfs-shipyard / ignite-metrics

Metrics consent and client provider library for ipfs/ipfs-gui team (i.e. IPFS Ignite). See ipfs/ipfs-gui#129 for more details
Other
4 stars 3 forks source link

feat: add telemetry documentation #35

Closed SgtPooki closed 1 year ago

SgtPooki commented 1 year ago

fixes https://github.com/ipfs-shipyard/ignite-metrics/issues/29 fixes https://github.com/ipfs/ipfs-gui/issues/125

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 https://github.com/ipfs-shipyard/ignite-metrics/issues/29 & https://github.com/ipfs/ipfs-gui/issues/125

Please bring up any concerns you have that I missed

BigLep commented 1 year ago

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

  1. reducing complexity for implementation/testing/maintenance
  2. generally maximizing the amount of cases where we're collecting data (so we can be knowledgable about usage) while also not obsessing over it
  3. 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.

SgtPooki commented 1 year ago

@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 :+1: 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.

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:

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

Two potential options:

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

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 :+1: , but please remove reference to the nonsense protocol.ai/legal/#privacy-policy :laughing:

SgtPooki commented 1 year ago

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

github-actions[bot] commented 1 year ago

:tada: This PR is included in version 1.0.2 :tada:

The release is available on:

Your semantic-release bot :package::rocket: