mirror of
https://github.com/fork-maintainers/iceraven-browser
synced 2024-11-15 18:12:54 +00:00
d6b448eeaa
As per documentation, this ping is intended to provide metrics that are managed by the library itself, and not explicitly set by the application or included in the application's metrics.yaml file.
47 KiB
47 KiB
Metrics
This document enumerates the metrics collected by this project. This project may depend on other projects which also collect metrics. This means you might have to go searching through the dependency tree to get a full picture of everything collected by this project.
Pings
activation
This ping is intended to provide a measure of the activation of mobile products. It's generated when Fenix starts, right after Glean is initialized. It doesn't include the client_id, since it might be reporting an hashed version of the Google Advertising ID.
Data reviews for this ping:
Bugs related to this ping:
- 1538011
- 1501822
The following metrics are added to the ping:
| Name | Type | Description | Data reviews | Extras | Expiration |
|---|---|---|---|---|---|
| activation.activation_id | uuid | An alternate identifier, not correlated with the client_id, generated once and only sent with the activation ping. | 1 | 2020-09-01 | |
| activation.identifier | string | A hashed and salted version of the Google Advertising ID from the device. This will never be sent in a ping that also contains the client_id. | 1 | 2020-09-01 |
events
This is a built-in ping that is assembled out of the box by the Glean SDK.
See the Glean SDK documentation for the events ping.
The following metrics are added to the ping:
| Name | Type | Description | Data reviews | Extras | Expiration |
|---|---|---|---|---|---|
| about_page.libraries_tapped | event | A user tapped on "Libraries that we use" item from About page | 1 | 2020-09-01 | |
| about_page.licensing_tapped | event | A user tapped on "Licensing information" item from About page | 1 | 2020-09-01 | |
| about_page.privacy_notice_tapped | event | A user tapped on "Privacy notice" item from About page | 1 | 2020-09-01 | |
| about_page.rights_tapped | event | A user tapped on "Know your rights" item from About page | 1 | 2020-09-01 | |
| about_page.support_tapped | event | A user tapped on "Support" item from About page | 1 | 2020-09-01 | |
| addons.open_addon_in_toolbar_menu | event | A user interacted with an installed add-on in the toolbar menu | 1 | 2020-09-01 | |
| addons.open_addons_in_settings | event | A user accessed "Add-ons" from the Settings | 1 | 2020-09-01 | |
| app_theme.dark_theme_selected | event | A user selected Dark Theme | 1 |
|
2020-09-01 |
| bookmarks_management.copied | event | A user copied a bookmark. | 1 | 2020-09-01 | |
| bookmarks_management.edited | event | A user edited the title and/or URL of an existing bookmark. | 1 | 2020-09-01 | |
| bookmarks_management.folder_add | event | A user added a new bookmark folder. | 1 | 2020-09-01 | |
| bookmarks_management.folder_remove | event | A user removed a bookmark folder. | 1 | 2020-09-01 | |
| bookmarks_management.moved | event | A user moved an existing bookmark or folder to another folder. | 1 | 2020-09-01 | |
| bookmarks_management.multi_removed | event | A user removed multiple bookmarks at once. | 1 | 2020-09-01 | |
| bookmarks_management.open_in_new_tab | event | A user opened a bookmark in a new tab. | 1 | 2020-09-01 | |
| bookmarks_management.open_in_new_tabs | event | A user opened multiple bookmarks at once in new tabs. | 1 | 2020-09-01 | |
| bookmarks_management.open_in_private_tab | event | A user opened a bookmark in a new private tab. | 1 | 2020-09-01 | |
| bookmarks_management.open_in_private_tabs | event | A user opened multiple bookmarks at once in new private tabs. | 1 | 2020-09-01 | |
| bookmarks_management.removed | event | A user removed a bookmark item. | 1 | 2020-09-01 | |
| bookmarks_management.shared | event | A user shared a bookmark. | 1 | 2020-09-01 | |
| collections.add_tab_button | event | A user tapped the "add tab" button in the three dot menu of collections | 1 | 2020-09-01 | |
| collections.all_tabs_restored | event | A user tapped "open tabs" from collection menu | 1 | 2020-09-01 | |
| collections.long_press | event | A user long pressed on a tab, triggering the collection creation screen | 1 | 2020-09-01 | |
| collections.removed | event | A user tapped delete collection from collection menu | 1 | 2020-09-01 | |
| collections.rename_button | event | A user pressed the "rename collection" button in the three dot menu | 1 | 2020-09-01 | |
| collections.renamed | event | A user renamed a collection | 1 | 2020-09-01 | |
| collections.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) | 1 |
|
2020-09-01 |
| collections.saved | event | A user saved a list of tabs to a new collection | 1 |
|
2020-09-01 |
| collections.shared | event | A user tapped share collection | 1 | 2020-09-01 | |
| collections.tab_removed | event | A user tapped remove tab from collection tab list | 1 | 2020-09-01 | |
| collections.tab_restored | event | A user restored a tab from collection tab list | 1 | 2020-09-01 | |
| collections.tab_select_opened | event | A user opened the select tabs screen (the first step of the collection creation flow) | 1 | 2020-09-01 | |
| collections.tabs_added | event | A user saved a list of tabs to an existing collection | 1 |
|
2020-09-01 |
| context_menu.item_tapped | event | A user tapped an item in the browsers context menu | 1 |
|
2020-09-01 |
| crash_reporter.closed | event | The crash reporter was closed | 1 |
|
2020-09-01 |
| crash_reporter.opened | event | The crash reporter was displayed | 1 | 2020-09-01 | |
| custom_tab.action_button | event | A user pressed the action button provided by the launching app | 1 | 2020-09-01 | |
| custom_tab.closed | event | A user closed the custom tab | 1 | 2020-09-01 | |
| custom_tab.menu | event | A user opened the custom tabs menu | 1 | 2020-09-01 | |
| download_notification.cancel | event | A user cancelled a download in the download notification | 1 | 2020-09-01 | |
| download_notification.in_app_open | event | A user opened a downloaded file in the in-app notification link | 1 | 2020-09-01 | |
| download_notification.in_app_try_again | event | A user tapped on try again when a download fails in the in-app notification link | 1 | 2020-09-01 | |
| download_notification.open | event | A user opened a downloaded file in the download notification | 1 | 2020-09-01 | |
| download_notification.pause | event | A user paused a download in the download notification | 1 | 2020-09-01 | |
| download_notification.resume | event | A user resumed a download in the download notification | 1 | 2020-09-01 | |
| download_notification.try_again | event | A user tapped on try again when a download fails in the download notification | 1 | 2020-09-01 | |
| error_page.visited_error | event | A user encountered an error page | 1 |
|
2020-09-01 |
| events.app_opened | event | A user opened the app | 1 |
|
2020-09-01 |
| events.browser_menu_action | event | A browser menu item was tapped | 1, 2, 3 |
|
2020-09-01 |
| events.entered_url | event | A user entered a url | 1 |
|
2020-09-01 |
| events.opened_link | event | A user opened a link with Fenix | 1 |
|
2020-09-01 |
| events.performed_search | event | A user performed a search | 1, 2 |
|
2020-09-01 |
| events.preference_toggled | event | A user toggled a boolean preference in settings | 1, 2, 3, 4, 5, 6, 7 |
|
2020-09-01 |
| events.search_bar_tapped | event | A user tapped the search bar | 1 |
|
2020-09-01 |
| events.whats_new_tapped | event | A user opened the "what's new" page button | 1 | 2020-09-01 | |
| find_in_page.closed | event | A user closed the find in page UI | 1 | 2020-09-01 | |
| find_in_page.opened | event | A user opened the find in page UI | 1 | 2020-09-01 | |
| find_in_page.searched_page | event | A user searched the page | 1 | 2020-09-01 | |
| history.opened | event | A user opened the history screen | 1 | 2020-09-01 | |
| history.opened_item | event | A user opened a history item | 1 | 2020-09-01 | |
| history.removed | event | A user removed a history item | 1 | 2020-09-01 | |
| history.removed_all | event | A user removed all history items | 1 | 2020-09-01 | |
| history.shared | event | A user shared a history item | 1 | 2020-09-01 | |
| logins.copy_login | event | A user copied a piece of a login in saved logins | 1 | 2020-09-01 | |
| logins.open_individual_login | event | A user accessed an individual login in saved logins | 1 | 2020-09-01 | |
| logins.open_logins | event | A user accessed Logins in Settings | 1 | 2020-09-01 | |
| logins.save_logins_setting_changed | event | A user changed their setting for asking to save logins | 1 |
|
2020-09-01 |
| logins.view_password_login | event | A user viewed a password in an individual saved login | 1 | 2020-09-01 | |
| media_notification.pause | event | A user pressed the pause icon on the media notification | 1 | 2020-09-01 | |
| media_notification.play | event | A user pressed the play icon on the media notification | 1 | 2020-09-01 | |
| media_state.pause | event | Media playback was paused. | 1 | 2020-09-01 | |
| media_state.play | event | Media started playing. | 1 | 2020-09-01 | |
| media_state.stop | event | Media playback has ended. | 1 | 2020-09-01 | |
| pocket.pocket_top_site_clicked | event | A user clicked on the trending Pocket top site | 1 | 2020-09-01 | |
| pocket.pocket_top_site_removed | event | A user removed the trending Pocket top site | 1 | 2020-09-01 | |
| private_browsing_mode.garbage_icon | event | A user pressed the garbage can icon on the private browsing home page, deleting all private tabs. | 1 | 2020-09-01 | |
| private_browsing_mode.notification_delete | event | A user pressed the private browsing mode notification's "Delete and Open" button. | 1 | 2020-09-01 | |
| private_browsing_mode.notification_open | event | A user pressed the private browsing mode notification's "Open" button. | 1 | 2020-09-01 | |
| private_browsing_mode.notification_tapped | event | A user pressed the private browsing mode notification itself. | 1 | 2020-09-01 | |
| private_browsing_mode.snackbar_undo | event | A user pressed the "undo" button in the snackbar that is shown when the garbage icon is tapped. | 1 | 2020-09-01 | |
| private_browsing_shortcut.cfr_add_shortcut | event | A user pressed the "Add shortcut" button when the contextual feature recommender appeared. | 1 | 2020-09-01 | |
| private_browsing_shortcut.cfr_cancel | event | A user pressed the "No thanks" button when the contextual feature recommender appeared. | 1 | 2020-09-01 | |
| private_browsing_shortcut.create_shortcut | event | A user pressed the "Add private browsing shortcut" button in settings. | 1 | 2020-09-01 | |
| private_browsing_shortcut.pinned_shortcut_priv | event | A user pressed the pinned private shortcut in Android home screen, opening up a new private search. | 1 | 2020-09-01 | |
| private_browsing_shortcut.static_shortcut_priv | event | A user pressed the long-press shortcut "Open new private tab", opening up a new private search. | 1 | 2020-09-01 | |
| private_browsing_shortcut.static_shortcut_tab | event | A user pressed the long-press shortcut "Open new tab", opening up a new search. | 1 | 2020-09-01 | |
| qr_scanner.navigation_allowed | event | A user tapped "allow" on the prompt, directing the user to the website scanned | 1 | 2020-09-01 | |
| qr_scanner.navigation_denied | event | A user tapped "deny" on the prompt, putting the user back to the scanning view | 1 | 2020-09-01 | |
| qr_scanner.opened | event | A user opened the QR scanner | 1 | 2020-09-01 | |
| qr_scanner.prompt_displayed | event | A user scanned a QR code, causing a confirmation prompt to display asking if they want to navigate to the page | 1 | 2020-09-01 | |
| reader_mode.appearance | event | A user tapped the appearance button | 1 | 2020-09-01 | |
| reader_mode.available | event | Reader mode is available for the current page | 1 | 2020-09-01 | |
| reader_mode.closed | event | A user closed reader mode | 1 | 2020-09-01 | |
| reader_mode.opened | event | A user opened reader mode | 1 | 2020-09-01 | |
| search_shortcuts.selected | event | A user selected a search shortcut engine to use | 1 |
|
2020-09-01 |
| search_suggestions.enable_in_private | event | A user enabled receiving search suggestions in private sessions | 1 | 2020-09-01 | |
| search_widget.new_tab_button | event | A user pressed anywhere from the Firefox logo until the start of the microphone icon, opening a new tab search screen. | 1 | 2020-09-01 | |
| search_widget.voice_button | event | A user pressed the microphone icon, opening a new voice search screen. | 1 | 2020-09-01 | |
| sync_account.closed | event | A user closed the sync account page | 1 | 2020-09-01 | |
| sync_account.opened | event | A user opened the sync account page | 1 | 2020-09-01 | |
| sync_account.send_tab | event | A user sent the current tab to another FxA device | 1 | 2020-09-01 | |
| sync_account.sign_in_to_send_tab | event | A user pressed the "sign in to send tab" button inside the share tab menu | 1 | 2020-09-01 | |
| sync_account.sync_now | event | A user pressed the sync now button on the sync account page | 1 | 2020-09-01 | |
| sync_auth.auto_login | event | User signed into FxA via an account shared from another locally installed Mozilla application (e.g. Fennec) | 1 | 2020-09-01 | |
| sync_auth.closed | event | A user closed the sync page | 1 | 2020-09-01 | |
| sync_auth.opened | event | A user opened the sync authentication page | 1 | 2020-09-01 | |
| sync_auth.other_external | event | User authenticated via FxA using an unknown mechanism. "Known" mechanisms are currently sign-in, sign-up and pairing | 1 | 2020-09-01 | |
| sync_auth.paired | event | User signed into FxA by pairing with a different Firefox browser, using a QR code | 1 | 2020-09-01 | |
| sync_auth.recovered | event | Account manager automatically recovered FxA authentication state without direct user involvement | 1 | 2020-09-01 | |
| sync_auth.scan_pairing | event | A user pressed the scan pairing button on the sync authentication page | 1 | 2020-09-01 | |
| sync_auth.sign_in | event | A user pressed the sign in button on the sync authentication page and was successfully signed in to FxA | 1 | 2020-09-01 | |
| sync_auth.sign_out | event | A user pressed the sign out button on the sync account page and was successfully signed out of FxA | 1 | 2020-09-01 | |
| sync_auth.sign_up | event | User registered a new Firefox Account, and was signed into it | 1 | 2020-09-01 | |
| sync_auth.use_email | event | A user chose to use their email to sign in instead of scanning a QR code, counterpart to "scan_pairing" | 1 | 2020-09-01 | |
| sync_auth.use_email_problem | event | A user chose to use their email to sign in after an account problem | 1 | 2020-09-01 | |
| tab.media_pause | event | A user pressed the pause icon on a tab from the home screen | 1 | 2020-09-01 | |
| tab.media_play | event | A user pressed the play icon on a tab from the home screen | 1 | 2020-09-01 | |
| tip.closed | event | The tip was closed | 1 |
|
2020-09-01 |
| tip.displayed | event | The tip was displayed | 1 |
|
2020-09-01 |
| tip.pressed | event | The tip's button was pressed | 1 |
|
2020-09-01 |
| toolbar_settings.changed_position | event | The user selected a new position for the toolbar | 1 |
|
2020-09-01 |
| top_sites.open_in_new_tab | event | A user opens a new tab based on a top site item | 1 | 2020-09-01 | |
| top_sites.open_in_private_tab | event | A user opens a new private tab based on a top site item | 1 | 2020-09-01 | |
| top_sites.remove | event | A user removes a top site item | 1 | 2020-09-01 | |
| tracking_protection.etp_setting_changed | event | A user changed their tracking protection level setting to either strict or standard. | 1 |
|
2020-09-01 |
| tracking_protection.etp_settings | event | A user opened tracking protection settings through settings. | 1 | 2020-09-01 | |
| tracking_protection.etp_shield | event | A user pressed the tracking protection shield icon in toolbar. | 1 | 2020-09-01 | |
| tracking_protection.etp_tracker_list | event | A user pressed into a list of categorized trackers in tracking protection panel. | 1 | 2020-09-01 | |
| tracking_protection.exception_added | event | A user added a tracking protection exception through the TP toggle in the panel. | 1 | 2020-09-01 | |
| tracking_protection.panel_settings | event | A user opened tracking protection settings from the panel. | 1 | 2020-09-01 | |
| user_specified_search_engines.custom_engine_added | event | A user added a new custom search engine | 1 | 2020-09-01 | |
| user_specified_search_engines.custom_engine_deleted | event | A user deleted a custom search engine | 1 | 2020-09-01 |
installation
This ping is intended to capture the source of the installation
This ping includes the client id.
Data reviews for this ping:
Bugs related to this ping:
The following metrics are added to the ping:
| Name | Type | Description | Data reviews | Extras | Expiration |
|---|---|---|---|---|---|
| installation.adgroup | string | The name of the AdGroup that was used to source this installation. | 1 | 2020-09-01 | |
| installation.campaign | string | The name of the campaign that is responsible for this installation. | 1 | 2020-09-01 | |
| installation.creative | string | The identifier of the creative material that the user interacted with. | 1 | 2020-09-01 | |
| installation.network | string | The name of the Network that sourced this installation. | 1 | 2020-09-01 | |
| installation.timestamp | datetime | The date and time of the installation. | 1 | 2020-09-01 |
metrics
This is a built-in ping that is assembled out of the box by the Glean SDK.
See the Glean SDK documentation for the metrics ping.
The following metrics are added to the ping:
| Name | Type | Description | Data reviews | Extras | Expiration |
|---|---|---|---|---|---|
| addons.has_enabled_addons | boolean | Whether or not the user has enabled add-ons on the device. | 1 | 2020-09-01 | |
| addons.has_installed_addons | boolean | Whether or not the user has installed add-ons on the device. | 1 | 2020-09-01 | |
| browser.search.ad_clicks | labeled_counter | Records clicks of adverts on SERP pages. The key format is ‘’. | 1 | 2020-09-01 | |
| browser.search.in_content | labeled_counter | Records the type of interaction a user has on SERP pages. | 1 | 2020-09-01 | |
| browser.search.with_ads | labeled_counter | Records counts of SERP pages with adverts displayed. The key format is ‘’. | 1 | 2020-09-01 | |
| events.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 but may be incremented without user interaction by website scripts that programmatically redirect to a new location. | 1, 2 | 2020-09-01 | |
| metrics.adjust_ad_group | string | A string containing the Adjust ad group ID from which the user installed Fenix. This will not send on the first session the user runs. If the install is organic, this will be empty. | 1 | 2020-09-01 | |
| metrics.adjust_campaign | string | A string containing the Adjust campaign ID from which the user installed Fenix. This will not send on the first session the user runs. If the install is organic, this will be empty. | 1 | 2020-09-01 | |
| metrics.adjust_creative | string | A string containing the Adjust creative ID from which the user installed Fenix. This will not send on the first session the user runs. If the install is organic, this will be empty. | 1 | 2020-09-01 | |
| metrics.adjust_network | string | A string containing the Adjust network ID from which the user installed Fenix. This will not send on the first session the user runs. If the install is organic, this will be empty. | 1 | 2020-09-01 | |
| metrics.default_browser | boolean | Is Fenix the default browser? | 1 | 2020-09-01 | |
| metrics.default_moz_browser | string | The name of the default browser on device if and only if it's a Mozilla owned product | 1, 2 | 2020-09-01 | |
| metrics.has_top_sites | boolean | A boolean that indicates if the user has top sites | 1 | 2020-09-01 | |
| metrics.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. | 1, 2 | 2020-09-01 | |
| metrics.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 be: action, suggestion, widget or shortcut (depending on the source from which the search started). Also added the other option for the source but it should never enter on this case. |
1, 2, 3 | 2020-09-01 | |
| metrics.toolbar_position | string | A string that indicates the new position of the toolbar TOP or BOTTOM | 1 | 2020-09-01 | |
| metrics.top_sites_count | counter | A counter that indicates how many top sites a user has | 1 | 2020-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" | 1, 2 | 2020-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" | 1, 2 | 2020-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" | 1, 2 | 2020-09-01 |
startup-timeline
This ping is intended to provide an understanding of startup performance.
The ping is intended to be captured by performance testing automation to report results there, in addition to user telemetry. We place these metrics into their own ping in order to isolate them and make this process easier.
Data reviews for this ping:
Bugs related to this ping:
The following metrics are added to the ping:
| Name | Type | Description | Data reviews | Extras | Expiration |
|---|---|---|---|---|---|
| startup.timeline.clock_ticks_per_second | counter | The number of clock tick time units that occur in one second on this particular device. This value is expected to be used in conjunction with the framework_start metric. |
1 | 2020-07-15 | |
| startup.timeline.framework_start | timespan | The duration the Android framework takes to start before letting us run code in *Application.init. This is calculated from appInitTimestamp - processStartTimestamp. processStartTimestamp is derived from the clock tick time unit, which is expected to be less granular than nanoseconds. Therefore, we convert and round our timestamps to clock ticks before computing the difference and convert back to nanoseconds to report. For debugging purposes, clock_ticks_per_second, which may vary between devices, is also reported as a metric |
1 | 2020-07-15 | |
| startup.timeline.framework_start_error | boolean | An error when attempting to record framework_start - the application init timestamp returned a negative value - which is likely indicative of a bug in the implementation. |
1 | 2020-07-15 |