metrics.yaml (7222B)
1 # This Source Code Form is subject to the terms of the Mozilla Public 2 # License, v. 2.0. If a copy of the MPL was not distributed with this 3 # file, You can obtain one at http://mozilla.org/MPL/2.0/. 4 5 # Adding a new metric? We have docs for that! 6 # https://firefox-source-docs.mozilla.org/toolkit/components/glean/user/new_definitions_file.html 7 8 --- 9 $schema: moz://mozilla.org/schemas/glean/metrics/2-0-0 10 $tags: 11 - 'WebExtensions :: General' 12 13 extensions_button: 14 prefers_hidden_button: 15 type: boolean 16 description: > 17 Records whether the user prefers the Extensions Button to be hidden. 18 Corresponds to the inverse value of the 19 `exceptions.unifiedExtensions.button.always_visible` pref. 20 bugs: 21 - https://bugzilla.mozilla.org/show_bug.cgi?id=1966935 22 data_reviews: 23 - https://bugzilla.mozilla.org/show_bug.cgi?id=1966935 24 data_sensitivity: 25 - technical 26 notification_emails: 27 - addons-dev-internal@mozilla.com 28 - rwu@mozilla.com 29 expires: 150 30 31 toggle_visibility: 32 type: event 33 description: | 34 When a user changes the preferred visibility of the Extensions Button, 35 through the "Remove from Toolbar" or "Always Show in Toolbar" menu items. 36 bugs: 37 - https://bugzilla.mozilla.org/show_bug.cgi?id=1966935 38 data_reviews: 39 - https://bugzilla.mozilla.org/show_bug.cgi?id=1966935 40 data_sensitivity: 41 - interaction 42 notification_emails: 43 - addons-dev-internal@mozilla.com 44 - rwu@mozilla.com 45 expires: 150 46 extra_keys: 47 is_customizing: 48 description: Whether the change was made in Customize Mode. 49 type: boolean 50 is_extensions_panel_empty: 51 description: | 52 Whether the Extensions Panel is unable to show any extensions. 53 type: boolean 54 is_temporarily_shown: 55 description: | 56 Whether the Extensions Button is or was temporarily shown when the 57 user toggled the visibility. 58 59 If is_temporarily_shown is true and should_hide is false, this means 60 that the button stayed visible after the user tried to hide it. 61 62 If is_temporarily_shown is true and should_hide is true, this means 63 that the button was temporarily visible when the user made it 64 permanently visible again. 65 type: boolean 66 should_hide: 67 description: Whether the user wants the button to be hidden. 68 type: boolean 69 70 open_via_app_menu: 71 type: event 72 description: | 73 When the user prefers the Extensions Button to be hidden, the default 74 "Extensions and Themes" item in the Application Menu is replaced with an 75 "Extensions" item, which serves as an alternative trigger for the 76 Extensions Button. 77 78 This event records when the user clicks on this "Extensions" menu item. 79 bugs: 80 - https://bugzilla.mozilla.org/show_bug.cgi?id=1966935 81 data_reviews: 82 - https://bugzilla.mozilla.org/show_bug.cgi?id=1966935 83 data_sensitivity: 84 - interaction 85 notification_emails: 86 - addons-dev-internal@mozilla.com 87 - rwu@mozilla.com 88 expires: 150 89 extra_keys: 90 is_extensions_panel_empty: 91 description: | 92 Whether the Extensions Panel is unable to show any extensions. 93 94 When false, the Extensions Panel is opened. 95 96 When true, about:addons is opened, at least until an empty state is 97 added (https://bugzilla.mozilla.org/show_bug.cgi?id=1814871). When 98 that bug is resolved, the Extensions Panel is always opened. 99 type: boolean 100 is_extensions_button_visible: 101 description: | 102 Whether the Extensions Button is visible. Although the appmenu item 103 is only shown when the user prefers the button to be hidden, it is 104 possible for the button to be shown despite the user's preference if 105 there was a reason to show the button temporarily. 106 107 If true, this could be a sign that the user is confused about the 108 function of the appmenu item, because the Extensions Button offers 109 exactly the same functionality, except in a more visible location 110 (on the toolbar). 111 type: boolean 112 113 temporarily_unhidden: 114 type: labeled_counter 115 description: > 116 Counts how often the hidden Extensions Button is temporarily shown. 117 There are multiple possible triggers for showing the extensions button, 118 only the first that would trigger the transition from hidden to shown is 119 going to be counted. For example, if the button is shown because the 120 "attention" dot is shown, and a permission prompt is shown, then we only 121 count the trigger for the attention dot, not the permission prompt. 122 123 customize is when the user entered Customize Mode, which causes the 124 Extensions Button to show unconditionally until the user exits the mode. 125 126 addon_install_doorhanger covers notifications related to add-on 127 installations, including blocked installations, add-on download progress, 128 and failed installations. Permission prompts are NOT part of this, but 129 covered by extension_permission_prompt. A typical installation flow 130 triggers both addon_install_doorhanger and extension_permission_prompt. 131 132 extension_controlled_setting is when a notification is anchored to the 133 Extensions Button that notifies the user of an extension-triggered change 134 (new tab page, home page, first use of tabs.hide()). This is shown on 135 first use of the relevant feature after the installation of an extension. 136 137 browser_action_open_popup is when the browserAction popup is opened. This 138 is usually user-triggered (shortcut, context menu) or via the 139 `action.openPopup()` API. 140 141 extension_permission_prompt is when an extension permission prompt is 142 shown. This does not distinguish between install-time permission prompts, 143 permission prompts on update or optional permission prompts at runtime. 144 145 extensions_panel_showing is when the Extensions Panel is being shown, 146 for example via the Extensions appmenu item. 147 148 attention_blocklist is when the browser wants to draw attention to the 149 fact that one of the add-ons has been blocklisted. 150 151 attention_permission_denied is when the browser wants to draw attention 152 to the fact that one of the extensions was denied access to the page in 153 the currently displayed tab. The access request is not a strong signal: 154 a MV3 extension with content scripts whose permissions have been revoked 155 by the user could trigger such an attention request on all websites. 156 bugs: 157 - https://bugzilla.mozilla.org/show_bug.cgi?id=1966935 158 data_reviews: 159 - https://bugzilla.mozilla.org/show_bug.cgi?id=1966935 160 data_sensitivity: 161 - interaction 162 notification_emails: 163 - addons-dev-internal@mozilla.com 164 - rwu@mozilla.com 165 expires: 150 166 labels: 167 - customize 168 - addon_install_doorhanger 169 - extension_controlled_setting 170 - extension_permission_prompt 171 - extensions_panel_showing 172 - extension_browser_action_popup 173 - attention_blocklist 174 - attention_permission_denied