diff --git a/app/build.gradle b/app/build.gradle
index 865ce8728..11f5774be 100644
--- a/app/build.gradle
+++ b/app/build.gradle
@@ -561,6 +561,9 @@ def glean_android_components_tag = (
'v' + Versions.mozilla_android_components
)
+// Generate markdown docs for the collected metrics.
+ext.gleanGenerateMarkdownDocs = true
+ext.gleanDocsDirectory = "$rootDir/docs"
apply from: 'https://github.com/mozilla-mobile/android-components/raw/' + glean_android_components_tag + '/components/service/glean/scripts/sdk_generator.gradle'
// For production builds, the native code for all `org.mozilla.appservices` dependencies gets compiled together
diff --git a/docs/metrics.md b/docs/metrics.md
index 70744f4d7..095b79241 100644
--- a/docs/metrics.md
+++ b/docs/metrics.md
@@ -1,1231 +1,156 @@
-# Pings
-
-## Events
-
-
-
- key |
- type |
- description |
- data review |
- extras |
- expires |
-
-
- app_opened |
- event |
- A user opened the app |
- link |
-
-
- source | The method used to open Fenix. Possible values are: `app_icon`, `custom_tab` or `link` |
-
- |
- 2020-03-01 |
-
-
- search_bar_tapped |
- event |
- A user tapped the search bar |
- link |
-
-
- source | The view the user was on when they initiated the search (For example: `Home` or `Browser`) |
-
- |
- 2020-03-01 |
-
-
- entered_url |
- event |
- A user entered a url |
- link |
-
-
- autocomplete | A boolean that tells us whether the URL was autofilled by an Autocomplete suggestion |
-
- |
- 2020-03-01 |
-
-
- performed_search |
- event |
- A user performed a search |
- link |
-
-
-
- description |
-
- A string that tells us how the user performed the search. Possible values are:
-
- - default.action
- - default.suggestion
- - shortcut.action
- - shortcut.suggestion
-
- |
-
-
- |
- 2020-03-01 |
-
-
- browser_menu_action |
- event |
- A browser menu item was tapped |
- link |
- link |
-
-
- item | 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, Quit |
-
- |
- 2020-03-01 |
-
-
- total_uri_count |
- counter |
- 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. |
- link |
- |
- 2020-03-01 |
-
-
- preference_toggled |
- event |
- A user toggled a preference switch in settings |
- link |
-
-
- preference_key | The preference key for the switch preference the user toggled. We currently track: leakcanary,
-make_default_browser, show_search_suggestions, remote_debugging, telemetry,
-tracking_protection |
-
- enabled | Whether or not the preference is now enabled |
-
- |
- 2020-03-01 |
-
-
- whats_new_tapped |
- event |
- A user opened the "what's new" page button |
- link |
-
-
- source | The location from which the user selected the what's new button. Either 'about' or 'home' |
-
-
- |
- 2020-03-01 |
-
-
-
-
-## search_shortcuts
-
-
- key |
- type |
- description |
- data deview |
- extras |
- expires |
-
-
- open_in_new_tab |
- event |
- A user opened a bookmark in a new tab. |
- link |
- |
- 2020-03-01 |
-
-
-
- open_in_new_tabs |
- event |
- A user opened multiple bookmarks at once in new tabs. |
- link |
- |
- 2020-03-01 |
-
-
-
- open_in_private_tab |
- event |
- A user opened a bookmark in a new private tab. |
- link |
- |
- 2020-03-01 |
-
-
-
- open_in_private_tabs |
- event |
- A user opened multiple bookmarks at once in new private tabs. |
- link |
- |
- 2020-03-01 |
-
-
-
- edited |
- event |
- A user edited the title and/or URL of an existing bookmark. |
- link |
- |
- 2020-03-01 |
-
-
-
- moved |
- event |
- A user moved an existing bookmark or folder to another folder. |
- link |
- |
- 2020-03-01 |
-
-
-
- removed |
- event |
- A user removed a bookmark item. |
- link |
- |
- 2020-03-01 |
-
-
-
- multi_removed |
- event |
- A user removed multiple bookmarks at once. |
- link |
- |
- 2020-03-01 |
-
-
-
- shared |
- event |
- A user shared a bookmark. |
- link |
- |
- 2020-03-01 |
-
-
-
- copied |
- event |
- A user copied a bookmark. |
- link |
- |
- 2020-03-01 |
-
-
-
- folder_add |
- event |
- A user added a new bookmark folder. |
- link |
- |
- 2020-03-01 |
-
-
-
- folder_remove |
- event |
- A user removed a bookmark folder. |
- link |
- |
- 2020-03-01 |
-
-
-
-
-## custom_tab
-
-
-
- key |
- type |
- description |
- data deview |
- extras |
- expires |
-
-
- renamed |
- event |
- A user renamed a collection |
- link |
- |
- 2020-03-01 |
-
-
- tab_restored |
- event |
- A user restored a tab from collection tab list |
- link |
- |
- 2020-03-01 |
-
-
- all_tabs_restored |
- event |
- A user tapped "open tabs" from collection menu |
- link |
- |
- 2020-03-01 |
-
-
- tab_removed |
- event |
- A user tapped remove tab from collection tab list |
- link |
- |
- 2020-03-01 |
-
-
- shared |
- event |
- A user tapped share collection |
- link |
- |
- 2020-03-01 |
-
-
- removed |
- event |
- A user tapped delete collection from collection menu |
- link |
- |
- 2020-03-01 |
-
-
- saved |
- event |
- A user saved a list of tabs to a new collection |
- link |
- tabs_open: The number of tabs open in the current session
-tabs_selected: The number of tabs added to the collection
- |
- 2020-03-01 |
-
-
- tabs_added |
- event |
- A user saved a list of tabs to an existing collection |
- link |
- tabs_open: The number of tabs open in the current session
-tabs_selected: The number of tabs added to the collection
- |
- 2020-03-01 |
-
-
- tab_select_opened |
- event |
- A user opened the select tabs screen (the first step of the collection creation flow) |
- link |
- |
- 2020-03-01 |
-
-
- add_tab_button |
- event |
- A user tapped the "add tab" button in the three dot menu of collections |
- link |
- |
- 2020-03-01 |
-
-
- long_press |
- event |
- A user long pressed on a tab, triggering the collection creation screen |
- link |
- |
- 2020-03-01 |
-
-
- save_button |
- event |
- A user pressed the "save to collection" button on either the home or browser screen, triggering the
- collection creation screen to open (tab_select_opened) |
- link |
- from_screen: A string representing the screen from which the user pressed the save button. Either `browser` or `home`
- |
- 2020-03-01 |
-
-
- rename_button |
- event |
- A user pressed the "rename collection" button in the three dot menu |
- link |
- |
- 2020-03-01 |
-
-
-
-
-
-## Metrics
-
-Items that are added to the metrics ping
-
-
-
- key |
- type |
- description |
- data deview |
- extras |
- expires |
-
-
- default_browser |
- boolean |
- Is Fenix the default browser? |
- link |
- |
- 2020-03-01 |
-
-
- search_count |
- labeled_counter |
- The labels for this counter are `[search-engine-name].[source]`.
-
- If the search engine is bundled with Fenix `search-engine-name` will be the name of the search engine. If it's a
- custom search engine (defined: https://github.com/mozilla-mobile/fenix/issues/1607) the value will be `custom`.
-
- `source` will either be `action` or `suggestion` |
- link |
- |
- 2019-09-01 |
-
-
- mozilla_products |
- string_list |
- A list of all the Mozilla products installed on device. We currently scan for: Firefox, Firefox Beta,
- Firefox Aurora, Firefox Nightly, Firefox Fdroid, Firefox Lite, Reference Browser, Reference Browser Debug,
- Fenix, Focus, and Lockwise. |
- link |
- |
- 2019-09-01 |
-
-
- default_moz_browser |
- string |
- The name of the default browser on device if and only if it's a Mozilla owned product, otherwise empty string |
- link |
- |
- 2019-09-01 |
-
-
- search.default_engine.code |
- string |
- If the search engine is pre-loaded with Fenix this value
- will be the search engine identifier. If it's a custom search engine
- (defined: https://github.com/mozilla-mobile/fenix/issues/1607) the
- value will be "custom" |
- link |
- |
- 2019-09-01 |
-
-
- search.default_engine.name |
- string |
- If the search engine is pre-loaded with Fenix this value
- will be the search engine name. If it's a custom search engine
- (defined: https://github.com/mozilla-mobile/fenix/issues/1607) the
- value will be "custom" |
- link |
- |
- 2019-09-01 |
-
-
- search.default_engine.submission_url |
- string |
- If the search engine is pre-loaded with Fenix this value
- will be he base URL we use to build the search query for the search engine.
- For example: https://mysearchengine.com/?query=%s. If it's a custom search engine
- (defined: https://github.com/mozilla-mobile/fenix/issues/1607) the
- value will be "custom" |
- link |
- |
- 2019-09-01 |
-
-
-
-
-
-## Activation
-
-Data that is sent in the activation ping
-
-