Adds metrics documentation (closes #5). #201
Conversation
|
Thanks. Also asking @rjweiss for review |
docs/metrics.md
Outdated
| ## Analysis | ||
| Data collected by Send will be used to answer the following high-level questions: | ||
|
|
||
| - How do users |
There was a problem hiding this comment.
Is this bullet missing words? Other top level list items are questions, this is... some existential, ominous foreshadowing.
|
|
||
| ### Custom Metrics | ||
| - `cm1` - the size of the file, in bytes. | ||
| - `cm2` - the amount of time it took to complete the file transfer, in milliseconds. Only include if the file completed transferring (ref: `cd2`). |
There was a problem hiding this comment.
What is a "transfer" here? Upload? Download? Both?
There was a problem hiding this comment.
Correct. GA limits the numbers of metrics and dimensions, so it befits you to reuse them in this way.
docs/metrics.md
Outdated
| - `cm7` - the number of files the user has ever downloaded. | ||
|
|
||
| ### Custom Dimensions | ||
| - `cd1` - the method by which the user initiated an upload. One of `drag`, `click` |
docs/metrics.md
Outdated
| ### Custom Dimensions | ||
| - `cd1` - the method by which the user initiated an upload. One of `drag`, `click` | ||
| - `cd2` - the reason that the file transfer stopped. One of `completed`, `errored`, `cancelled`. | ||
| - `cd3` - the destination of a link click. One of `experiment-page`, `download-firefox`, `twitter`, `github`, `cookies`, `terms`, `privacy`, `about`, `legal`, `mozilla`. |
There was a problem hiding this comment.
Not sure if these are 100% accurate for Firefox Send. I don't know if we have outbound links to experiment-page or twitter. Well, technically we don't have any legal footers or other links yet either, but I assume those will land shortly after the UI branch PR. The rest of the links seem generic enough that they'd work for the site.
There was a problem hiding this comment.
Actually, re-looking at the UI spec, it does appear that our designs should have a Twitter icon. No clue where that'd go, i wasn't aware we were going to have a Firefox Send Twitter account, or if we're just redirecting to the TestPilot Twitter acct.
There was a problem hiding this comment.
I got these by inventorying the spec and talking with John.
- The various
Learn Morelinks are to the experiment page. - There is a Twitter and the normal legal footer.
docs/metrics.md
Outdated
| - `cd1` - the method by which the user initiated an upload. One of `drag`, `click` | ||
| - `cd2` - the reason that the file transfer stopped. One of `completed`, `errored`, `cancelled`. | ||
| - `cd3` - the destination of a link click. One of `experiment-page`, `download-firefox`, `twitter`, `github`, `cookies`, `terms`, `privacy`, `about`, `legal`, `mozilla`. | ||
| - `cd4` - from where the URL for a file was copied. One of `finished-screen`, `file-list` |
|
|
||
| - `ec` - `sender` | ||
| - `ea` - `unsupported` | ||
| - `cd7` |
There was a problem hiding this comment.
General thought... I'm not very clever, and metrics is confusing, but by the time I've scrolled down to here, I've already forgotten what a cd7 is.
Not sure how ludicrous it would be to wrap some of these in an <code title="cd 7 -- identifying information about an error. Exclude if there is no error involved.">cd7</code> so you can just hover over the custom dimension to get a description. Markdown+HTML are hard. It appears GFM doesn't support ye olde <abbr> tag.
Example (hover for tooltip):
cd7
There was a problem hiding this comment.
It doesn't read well, agreed. But this is a document largely written for the implementers, so I'm less concerned about the clarity of a narrative. Plus, I'm really uninterested in creating 10 different places to update the spec if a metric's wording is tweaked before implementation.
| - `cm2` - the amount of time it took to complete the file transfer, in milliseconds. Only include if the file completed transferring (ref: `cd2`). | ||
| - `cm3` - the rate of the file transfer, in bytes per second. This is computed by dividing `cm1` by `cm2`, not by monitoring transfer speeds. Only include if the file completed transferring (ref: `cd2`). | ||
| - `cm4` - the amount of time until the file will expire, in milliseconds. | ||
| - `cm5` - the number of files the user has ever uploaded. |
There was a problem hiding this comment.
localStorage, as I understand it. Up to the team on how to persist this data.
ghost
removed the request for review
from 
Here's a first pass on metrics documentation based on the first pass at UX (#169) and metrics acceptance criteria. It's important to read this in context of the Test Pilot Experiment Metrics document, which prescribes standard uses that are not duplicated here.
Read with Markdown parsed
A lot of what is prescribed here is likely not practical or possible; I'll be very happy to discuss easier or alternate possibilities based on reality.
Thanks to @dannycoates and @johngruen for entertaining dozens of questions while I was getting oriented!