metrics.yaml (10137B)
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 - 'Firefox :: Firefox Accounts' 12 13 client_association: 14 uid: 15 type: string 16 description: | 17 The Mozilla Account UID associated with the user. 18 bugs: 19 - https://bugzilla.mozilla.org/show_bug.cgi?id=1889123 20 data_reviews: 21 - https://bugzilla.mozilla.org/show_bug.cgi?id=1889123 22 data_sensitivity: 23 - highly_sensitive 24 notification_emails: 25 - mreid@mozilla.com 26 - mconley@mozilla.com 27 expires: never 28 send_in_pings: 29 - fx-accounts 30 legacy_client_id: 31 type: uuid 32 description: | 33 The legacy Telemetry client ID associated with this user profile. 34 bugs: 35 - https://bugzilla.mozilla.org/show_bug.cgi?id=1889123 36 data_reviews: 37 - https://bugzilla.mozilla.org/show_bug.cgi?id=1889123 38 data_sensitivity: 39 - highly_sensitive 40 notification_emails: 41 - mreid@mozilla.com 42 - mconley@mozilla.com 43 expires: never 44 send_in_pings: 45 - fx-accounts 46 47 fxa: 48 connect_account: 49 type: event 50 description: > 51 Records when a Firefox Account, or a Firefox Account service, is 52 explicitly connected from the browser via an intentional user action. 53 This event was generated to correspond to the Legacy Telemetry event 54 fxa.connect#account. 55 bugs: &fxa_connect_bugs 56 - https://bugzil.la/1595954 57 data_reviews: &fxa_connect_data_reviews 58 - https://bugzil.la/1595954 59 notification_emails: &fxa_connect_emails 60 - sync-dev@mozilla.org 61 expires: never 62 extra_keys: &fxa_connect_extra 63 value: 64 description: > 65 The `value` of the event. Mirrors to the Legacy Telemetry 66 event's `value` parameter. 67 type: string 68 fxa: 69 description: > 70 Whether the account itself was connected or disconnected. 71 type: string 72 sync: 73 description: > 74 Whether sync was connected or disconnected. 75 type: string 76 telemetry_mirror: Fxa_Connect_Account 77 78 disconnect_account: 79 type: event 80 description: > 81 Records when a Firefox Account, or a Firefox Account service, is 82 explicitly disconnected from the browser via an intentional user action. 83 This event was generated to correspond to the Legacy Telemetry event 84 fxa.disconnect#account. 85 bugs: *fxa_connect_bugs 86 data_reviews: *fxa_connect_data_reviews 87 notification_emails: *fxa_connect_emails 88 expires: never 89 extra_keys: *fxa_connect_extra 90 telemetry_mirror: Fxa_Disconnect_Account 91 92 sync_enabled: 93 type: boolean 94 lifetime: application 95 description: | 96 Whether the weave service is present and enabled. 97 Implies `fxa.account_enabled`. 98 bugs: 99 - https://bugzilla.mozilla.org/show_bug.cgi?id=1950399 100 data_reviews: 101 - https://bugzilla.mozilla.org/show_bug.cgi?id=1950399 102 data_sensitivity: 103 - technical 104 notification_emails: 105 - sync-dev@mozilla.org 106 expires: never 107 108 account_enabled: 109 type: boolean 110 lifetime: application 111 description: | 112 Whether the user's logged in to an FxA account. 113 bugs: 114 - https://bugzilla.mozilla.org/show_bug.cgi?id=1950399 115 data_reviews: 116 - https://bugzilla.mozilla.org/show_bug.cgi?id=1950399 117 data_sensitivity: 118 - technical 119 notification_emails: 120 - sync-dev@mozilla.org 121 expires: never 122 123 sendtab_sent: 124 type: event 125 description: | 126 User asked to send a tab to their devices. 127 bugs: 128 - https://bugzilla.mozilla.org/show_bug.cgi?id=1963812 129 data_reviews: 130 - https://bugzilla.mozilla.org/show_bug.cgi?id=1963812 131 data_sensitivity: 132 - technical 133 notification_emails: 134 - sync-dev@mozilla.org 135 expires: never 136 send_in_pings: 137 - sync 138 extra_keys: 139 hashed_device_id: 140 description: | 141 A 64-byte hashed string stable for this device + login. 142 type: string 143 flow_id: 144 description: | 145 A GUID which uniquely identifies this command invocation. 146 This GUID is the same for every device the tab is sent to. 147 type: string 148 stream_id: 149 description: | 150 A GUID which uniquely identifies this command invocation's specific target. 151 This GUID is the same for every device the tab is sent to. 152 type: string 153 server_time: &server_time_extra 154 description: | 155 The most recent unix timestamp sent from the sync server. 156 Arrives in the `X-Weave-Timestamp` header. 157 Omitted in cases where the client has not yet made a request of the 158 server and whenever else it's unavailable. 159 Included to improve flow analysis across multiple clients. 160 type: string 161 162 sendtab_received: 163 type: event 164 description: | 165 We've received a sent tab. 166 bugs: 167 - https://bugzilla.mozilla.org/show_bug.cgi?id=1963812 168 data_reviews: 169 - https://bugzilla.mozilla.org/show_bug.cgi?id=1963812 170 data_sensitivity: 171 - technical 172 notification_emails: 173 - sync-dev@mozilla.org 174 expires: never 175 send_in_pings: 176 - sync 177 extra_keys: 178 hashed_device_id: 179 description: | 180 A 64-byte hashed string stable for the sender's device + login. 181 type: string 182 flow_id: 183 description: | 184 A GUID which uniquely identifies this command invocation. 185 The value for this GUID will be the same as the flowID sent to the client via 186 `fxa.sendtab_sent`. 187 type: string 188 stream_id: 189 description: | 190 A GUID which uniquely identifies this command invocation's specific target. 191 The value for this GUID will be the same as the streamID sent to the client via 192 `fxa.sendtab_sent` 193 type: string 194 reason: 195 description: | 196 Why the command is being processed. One of: 197 - "poll" if part of a fallback polling process 198 - "push-missed" if it's a push command we previously missed 199 - "push" if it's a push command we caught 200 type: string 201 server_time: *server_time_extra 202 203 closetab_sent: 204 type: event 205 description: | 206 User asked to close a tab on their other devices. 207 bugs: 208 - https://bugzilla.mozilla.org/show_bug.cgi?id=1963812 209 data_reviews: 210 - https://bugzilla.mozilla.org/show_bug.cgi?id=1963812 211 data_sensitivity: 212 - technical 213 notification_emails: 214 - sync-dev@mozilla.org 215 expires: never 216 send_in_pings: 217 - sync 218 extra_keys: 219 hashed_device_id: 220 description: | 221 A 64-byte hashed string stable for this device + login. 222 type: string 223 flow_id: 224 description: | 225 A GUID which uniquely identifies this command invocation. 226 This GUID is the same for every device the closetab command is sent to. 227 type: string 228 stream_id: 229 description: | 230 A GUID which uniquely identifies this command invocation's specific target. 231 This GUID is the same for every device the closetab command is sent to. 232 type: string 233 server_time: *server_time_extra 234 235 closetab_received: 236 type: event 237 description: | 238 We've received orders to close a tab. 239 bugs: 240 - https://bugzilla.mozilla.org/show_bug.cgi?id=1963812 241 data_reviews: 242 - https://bugzilla.mozilla.org/show_bug.cgi?id=1963812 243 data_sensitivity: 244 - technical 245 notification_emails: 246 - sync-dev@mozilla.org 247 expires: never 248 send_in_pings: 249 - sync 250 extra_keys: 251 hashed_device_id: 252 description: | 253 A 64-byte hashed string stable for the sender's device + login. 254 type: string 255 flow_id: 256 description: | 257 A GUID which uniquely identifies this command invocation. 258 The value for this GUID will be the same as the flowID sent to the client via 259 `fxa.closetab_sent`. 260 type: string 261 stream_id: 262 description: | 263 A GUID which uniquely identifies this command invocation's specific target. 264 The value for this GUID will be the same as the streamID sent to the client via 265 `fxa.closetab_sent`. 266 type: string 267 reason: 268 description: | 269 Why the command is being processed. One of: 270 - "poll" if part of a fallback polling process 271 - "push-missed" if it's a push command we previously missed 272 - "push" if it's a push command we caught 273 type: string 274 server_time: *server_time_extra 275 276 sync_settings: 277 open_choose_what_to_sync_menu: 278 type: event 279 description: | 280 Records when the user opens the choose what to sync menu. 281 bugs: 282 - https://bugzil.la/1964832 283 data_reviews: 284 - https://bugzil.la/1964832 285 data_sensitivity: 286 - interaction 287 notification_emails: 288 - sync-dev@mozilla.org 289 expires: never 290 extra_keys: 291 why: 292 description: | 293 Records why the user opened the choose what to sync menu. Value is callToAction, setupSync, 294 or manageSyncSettings. 295 type: string 296 297 save: 298 type: event 299 description: | 300 Records when the user clicks the save button after opening the choose what to sync menu. 301 bugs: 302 - https://bugzil.la/1964832 303 data_reviews: 304 - https://bugzil.la/1964832 305 data_sensitivity: 306 - interaction 307 notification_emails: 308 - sync-dev@mozilla.org 309 expires: never 310 extra_keys: 311 enabled_engines: 312 description: | 313 A comma-delimited list of engines that were enabled by the user. 314 type: string 315 disabled_engines: 316 description: | 317 A comma-delimited list of engines that were disabled by the user. 318 type: string