blallo
/
fenix
1
0
Fork 0
Code Releases Activity
fenix/docs/metrics.md

481 lines
14 KiB
Markdown
Raw Normal View History

For #3351 - Create metrics.md
2019-06-11 03:40:30 +02:00
# Pings
## Events
<pre>
<table style="width: 100%">
<tr>
<th>key</th>
<th>type</th>
<th>description</th>
<th>data deview</th>
<th>extras</th>
<th>expires</th>
</tr>
<tr>
<td>app_opened</td>
<td>event</td>
<td>A user opened the app</td>
<td><a href="https://github.com/mozilla-mobile/fenix/pull/1067#issuecomment-474598673">link</a></td>
<td>
<table>
<tr><td>source</td><td>The method used to open Fenix. Possible values are: `app_icon`, `custom_tab` or `link`</td></tr>
</table>
</td>
<td>2020-03-01</td>
</tr>
<tr>
<td>search_bar_tapped</td>
<td>event</td>
<td>A user tapped the search bar</td>
<td><a href="https://github.com/mozilla-mobile/fenix/pull/1067#issuecomment-474598673">link</a></td>
<td>
<table>
<tr><td>source</td><td>The view the user was on when they initiated the search (For example: `Home` or `Browser`)</td></tr>
</table>
</td>
<td>2020-03-01</td>
</tr>
<tr>
<td>entered_url</td>
<td>event</td>
<td>A user entered a url</td>
<td><a href="https://github.com/mozilla-mobile/fenix/pull/1067#issuecomment-474598673">link</a></td>
<td>
<table>
<tr><td>autocomplete</td><td>A boolean that tells us whether the URL was autofilled by an Autocomplete suggestion</td></tr>
</table>
</td>
<td>2020-03-01</td>
</tr>
<tr>
<td>performed_search</td>
<td>event</td>
<td>A user performed a search</td>
<td><a href="https://github.com/mozilla-mobile/fenix/pull/1677">link</a></td>
<td>
<table>
<tr>
<td>description</td>
<td>
<p>A string that tells us how the user performed the search. Possible values are:</p>
<ul>
<li>default.action</li>
<li>default.suggestion</li>
<li>shortcut.action</li>
<li>shortcut.suggestion</li>
</ul>
</td>
</tr>
</table>
</td>
<td>2020-03-01</td>
</tr>
<tr>
<td>browser_menu_action</td>
<td>event</td>
<td>A browser menu item was tapped</td>
<td><a href="https://github.com/mozilla-mobile/fenix/pull/1214#issue-264756708">link</a></td>
<td>
<table>
<tr><td>item</td><td>A string containing the name of the item the user tapped. These items include:
Settings, Library, Help, Desktop Site toggle on/off, Find in Page, New Tab,
Private Tab, Share, Report Site Issue, Back/Forward button, Reload Button</td></tr>
</table>
</td>
<td>2020-03-01</td>
</tr>
<tr>
<td>ss_menu_opened</td>
<td>event</td>
<td>A user opened the search shortcut menu in the search view by pressing the shortcuts button</td>
<td><a href="https://github.com/mozilla-mobile/fenix/pull/1202#issuecomment-476870449">link</a></td>
<td></td>
<td>2020-03-01</td>
</tr>
<tr>
<td>ss_menu_closed</td>
<td>event</td>
<td> A user closed the search shortcut menu in the search view by pressing the shortcuts button</td>
<td><a href="https://github.com/mozilla-mobile/fenix/pull/1202#issuecomment-476870449">link</a></td>
<td></td>
<td>2020-03-01</td>
</tr>
<tr>
<td>ss_selected</td>
<td>event</td>
<td>A user selected a search shortcut engine to use</td>
<td><a href="https://github.com/mozilla-mobile/fenix/pull/1202#issuecomment-476870449">link</a></td>
<td>
<table>
<tr><td>engine</td><td>The name of the built-in search engine the user selected as a string</td></tr>
</table>
</td>
<td>2020-03-01</td>
</tr>
<tr>
<td>total_uri_count</td>
<td>counter</td>
<td>A counter of URIs visited by the user in the current session, including page reloads. This does not include background page requests and URIs from embedded pages or private browsing.</td>
<td><a href="https://github.com/mozilla-mobile/fenix/pull/1785">link</a></td>
<td></td>
<td>2020-03-01</td>
</tr>
<tr>
<td>preference_toggled</td>
<td>event</td>
<td>A user toggled a preference switch in settings</td>
<td><a href="https://github.com/mozilla-mobile/fenix/pull/1896">link</a></td>
<td>
<table>
<tr><td>preference_key</td><td>The preference key for the switch preference the user toggled. We currently track: leakcanary,
make_default_browser, show_search_suggestions, show_visited_sites_bookmarks, remote_debugging, telemetry,
tracking_protection</td>
</tr>
<tr><td>enabled</td><td>Whether or not the preference is <b>now</b> enabled</td></tr>
</table>
</td>
<td>2020-03-01</td>
</tr>
</table>
</pre>
For #3351 - Adds crash_reporter docs
2019-06-11 03:46:11 +02:00
## crash_reporter
<pre>
<table style="width: 100%">
<tr>
<th>key</th>
<th>type</th>
<th>description</th>
<th>data deview</th>
<th>extras</th>
<th>expires</th>
</tr>
<tr>
<td>opened</td>
<td>event</td>
<td>The crash reporter was displayed</td>
<td><a href="https://github.com/mozilla-mobile/fenix/pull/1214#issue-264756708">link</a></td>
<td></td>
<td>2020-03-01</td>
</tr>
<tr>
<td>closed</td>
<td>event</td>
<td>The crash reporter was closed</td>
<td><a href="https://github.com/mozilla-mobile/fenix/pull/1067#issuecomment-474598673">link</a></td>
<td>
<table>
<tr><td>crash_submitted</td><td>A boolean that tells us whether or not the user submitted a crash report</td></tr>
</table>
</td>
<td>2020-03-01</td>
</tr>
</table>
</pre>
For #3351 - Create metrics.md
2019-06-11 03:40:30 +02:00
For #3351 - Adds context_menu docs
2019-06-11 03:49:03 +02:00
## context_menu
<pre>
<table style="width: 100%">
<tr>
<th>key</th>
<th>type</th>
<th>description</th>
<th>data deview</th>
<th>extras</th>
<th>expires</th>
</tr>
<tr>
<td>item_tapped</td>
<td>event</td>
<td>A user tapped an item in the browsers context menu</td>
<td><a href="https://github.com/mozilla-mobile/fenix/pull/1344#issuecomment-479285010">link</a></td>
<td>
<table>
<tr><td>named</td><td> The name of the item that was tapped. Available items are
```
open_in_new_tab, open_in_private_tab, open_image_in_new_tab,
save_image, share_link, copy_link, copy_image_location
```</td></tr>
</table>
</td>
<td>2020-03-01</td>
</tr>
</table>
</pre>
For #3351 - Adds find_in_page metrics
2019-06-11 03:53:52 +02:00
## find_in_page
<pre>
<table style="width: 100%">
<tr>
<th>key</th>
<th>type</th>
<th>description</th>
<th>data deview</th>
<th>extras</th>
<th>expires</th>
</tr>
<tr>
<td>opened</td>
<td>event</td>
<td>A user opened the find in page UI</td>
<td><a href="https://github.com/mozilla-mobile/fenix/pull/1344#issuecomment-479285010">link</a></td>
<td>
</td>
<td>2020-03-01</td>
</tr>
<tr>
<td>closed</td>
<td>event</td>
<td>A user closed the find in page UI</td>
<td><a href="https://github.com/mozilla-mobile/fenix/pull/1344#issuecomment-479285010">link</a></td>
<td></td>
<td>2020-03-01</td>
</tr>
<tr>
<td>next_result</td>
<td>event</td>
<td>A user clicked the "next result" button</td>
<td><a href="https://github.com/mozilla-mobile/fenix/pull/1344#issuecomment-479285010">link</a></td>
<td></td>
<td>2020-03-01</td>
</tr>
<tr>
<td>previous_result</td>
<td>event</td>
<td>A user clicked the "previous result" button</td>
<td><a href="https://github.com/mozilla-mobile/fenix/pull/1344#issuecomment-479285010">link</a></td>
<td></td>
<td>2020-03-01</td>
</tr>
<tr>
<td>searched_page</td>
<td>event</td>
<td>A user searched the page</td>
<td><a href="https://github.com/mozilla-mobile/fenix/pull/1344#issuecomment-479285010">link</a></td>
<td></td>
<td>2020-03-01</td>
</tr>
</table>
</pre>
For #3351 - Adds QAB documentation
2019-06-11 03:57:50 +02:00
## quick_action_sheet
<pre>
<table style="width: 100%">
<tr>
<th>key</th>
<th>type</th>
<th>description</th>
<th>data deview</th>
<th>extras</th>
<th>expires</th>
</tr>
<tr>
<td>opened</td>
<td>event</td>
<td>A user opened the quick action sheet UI</td>
<td><a href="https://github.com/mozilla-mobile/fenix/pull/1362#issuecomment-479668466">link</a></td>
<td></td>
<td>2020-03-01</td>
</tr>
<tr>
<td>closed</td>
<td>event</td>
<td>A user closed the quick action sheet UI</td>
<td><a href="https://github.com/mozilla-mobile/fenix/pull/1362#issuecomment-479668466">link</a></td>
<td></td>
<td>2020-03-01</td>
</tr>
<tr>
<td>share_tapped</td>
<td>event</td>
<td>A user tapped the share button</td>
<td><a href="https://github.com/mozilla-mobile/fenix/pull/1362#issuecomment-479668466">link</a></td>
<td></td>
<td>2020-03-01</td>
</tr>
<tr>
<td>bookmark_tapped</td>
<td>event</td>
<td>A user tapped the bookmark button</td>
<td><a href="https://github.com/mozilla-mobile/fenix/pull/1362#issuecomment-479668466">link</a></td>
<td></td>
<td>2020-03-01</td>
</tr>
<tr>
<td>download_tapped</td>
<td>event</td>
<td>A user tapped the download button</td>
<td><a href="https://github.com/mozilla-mobile/fenix/pull/1362#issuecomment-479668466">link</a></td>
<td></td>
<td>2020-03-01</td>
</tr>
<tr>
<td>read_tapped</td>
<td>event</td>
<td>A user tapped the read button</td>
<td><a href="https://github.com/mozilla-mobile/fenix/pull/1362#issuecomment-479668466">link</a></td>
<td></td>
<td>2020-03-01</td>
</tr>
</table>
</pre>
For #3351 - Adds bookmark management documentation
2019-06-11 04:05:02 +02:00
## bookmarks_management
<pre>
<table style="width: 100%">
<tr>
<th>key</th>
<th>type</th>
<th>description</th>
<th>data deview</th>
<th>extras</th>
<th>expires</th>
</tr>
<tr>
<td>open_in_new_tab</td>
<td>event</td>
<td>A user opened a bookmark in a new tab.</td>
<td> <a href="https://github.com/mozilla-mobile/fenix/pull/1708">link</a></td>
<td></td>
<td>2020-03-01</td>
</tr>
<tr>
<td>open_in_new_tabs</td>
<td>event</td>
<td>A user opened multiple bookmarks at once in new tabs.</td>
<td> <a href="https://github.com/mozilla-mobile/fenix/pull/1708">link</a></td>
<td></td>
<td>2020-03-01</td>
</tr>
<tr>
<td>open_in_private_tab</td>
<td>event</td>
<td>A user opened a bookmark in a new private tab.</td>
<td> <a href="https://github.com/mozilla-mobile/fenix/pull/1708">link</a></td>
<td></td>
<td>2020-03-01</td>
</tr>
<tr>
<td>open_in_private_tabs</td>
<td>event</td>
<td>A user opened multiple bookmarks at once in new private tabs.</td>
<td> <a href="https://github.com/mozilla-mobile/fenix/pull/1708">link</a></td>
<td></td>
<td>2020-03-01</td>
</tr>
<tr>
<td>edited</td>
<td>event</td>
<td>A user edited the title and/or URL of an existing bookmark.</td>
<td> <a href="https://github.com/mozilla-mobile/fenix/pull/1708">link</a></td>
<td></td>
<td>2020-03-01</td>
</tr>
<tr>
<td>moved</td>
<td>event</td>
<td>A user moved an existing bookmark or folder to another folder.</td>
<td> <a href="https://github.com/mozilla-mobile/fenix/pull/1708">link</a></td>
<td></td>
<td>2020-03-01</td>
</tr>
<tr>
<td>removed</td>
<td>event</td>
<td>A user removed a bookmark item.</td>
<td> <a href="https://github.com/mozilla-mobile/fenix/pull/1708">link</a></td>
<td></td>
<td>2020-03-01</td>
</tr>
<tr>
<td>multi_removed</td>
<td>event</td>
<td>A user removed multiple bookmarks at once.</td>
<td> <a href="https://github.com/mozilla-mobile/fenix/pull/1708">link</a></td>
<td></td>
<td>2020-03-01</td>
</tr>
<tr>
<td>shared</td>
<td>event</td>
<td>A user shared a bookmark.</td>
<td> <a href="https://github.com/mozilla-mobile/fenix/pull/1708">link</a></td>
<td></td>
<td>2020-03-01</td>
</tr>
<tr>
<td>copied</td>
<td>event</td>
<td>A user copied a bookmark.</td>
<td> <a href="https://github.com/mozilla-mobile/fenix/pull/1708">link</a></td>
<td></td>
<td>2020-03-01</td>
</tr>
<tr>
<td>folder_add</td>
<td>event</td>
<td>A user added a new bookmark folder.</td>
<td> <a href="https://github.com/mozilla-mobile/fenix/pull/1708">link</a></td>
<td></td>
<td>2020-03-01</td>
</tr>
</table>
</pre>
For #3351 - Adds custom tab telemetry docs
2019-06-11 18:16:21 +02:00
## custom_tab
<pre>
<table style="width: 100%">
<tr>
<th>key</th>
<th>type</th>
<th>description</th>
<th>data deview</th>
<th>extras</th>
<th>expires</th>
</tr>
<tr>
<td>closed</td>
<td>event</td>
<td>A user closed the custom tab</td>
<td><a href="https://github.com/mozilla-mobile/fenix/pull/1697">link</a></td>
<td></td>
<td>2020-03-01</td>
</tr>
<tr>
<td>action_button</td>
<td>event</td>
<td>A user pressed the action button provided by the launching app</td>
<td><a href="https://github.com/mozilla-mobile/fenix/pull/1697">link</a></td>
<td></td>
<td>2020-03-01</td>
</tr>
<tr>
<td>menu</td>
<td>event</td>
<td>A user opened the custom tabs menu</td>
<td><a href="https://github.com/mozilla-mobile/fenix/pull/1697">link</a></td>
<td></td>
<td>2020-03-01</td>
</tr>
</table>
</pre>
For #3351 - Create metrics.md
2019-06-11 03:40:30 +02:00
## Metrics