toolkit/components/formautofill/metrics.yaml

   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   - 'Toolkit :: Form Autofill'
  12
  13 formautofill.creditcards:
  14   autofill_profiles_count:
  15     type: quantity
  16     unit: credit card autofill profiles
  17     description: >
  18       Count at store time how many credit card autofill profiles the user has.
  19     bugs:
  20       - https://bugzilla.mozilla.org/show_bug.cgi?id=990203
  21       - https://bugzilla.mozilla.org/show_bug.cgi?id=1834571
  22     data_reviews:
  23       - https://bugzilla.mozilla.org/show_bug.cgi?id=1834571#c2
  24     notification_emails:
  25       - autofill@lists.mozilla.org
  26       - passwords-dev@mozilla.org
  27     expires: never
  28     telemetry_mirror: FORMAUTOFILL_CREDITCARDS_AUTOFILL_PROFILES_COUNT
  29
  30   form_detected:
  31       type: event
  32       description: >
  33         Recorded when a form is recognized as a credit card form.
  34         The possible value of cc_* are "autocomplete", "undetected", "regexp" or an integer between 0-100:
  35           - When the value is "autocomplete", the field is identified via autocomplete attribute
  36           - When the value is "undetected", the field is not detected in the form
  37           - When the value is "regexp", then the field is identified by regexp-based heuristic
  38           - When the value is an integer greater than 0, the value indicates the confidence value from fathom (normalized to 0-100)
  39         The flow id points to an interaction session with a credit card form and is shared across cc_form events .
  40       bugs:
  41         - https://bugzilla.mozilla.org/show_bug.cgi?id=1653162
  42         - https://bugzilla.mozilla.org/show_bug.cgi?id=1653073
  43         - https://bugzilla.mozilla.org/show_bug.cgi?id=1720608
  44         - https://bugzilla.mozilla.org/show_bug.cgi?id=1767907
  45         - https://bugzilla.mozilla.org/show_bug.cgi?id=1757731
  46         - https://bugzilla.mozilla.org/show_bug.cgi?id=1834570
  47       data_reviews:
  48         - https://bugzilla.mozilla.org/show_bug.cgi?id=1653073#c5
  49         - https://bugzilla.mozilla.org/show_bug.cgi?id=1653073#c7
  50         - https://bugzilla.mozilla.org/show_bug.cgi?id=1720608#c5
  51         - https://bugzilla.mozilla.org/show_bug.cgi?id=1757731#c5
  52       notification_emails:
  53         - autofill@lists.mozilla.org
  54         - passwords-dev@mozilla.org
  55       expires: never
  56       extra_keys:
  57         flow_id:
  58           description: Flow id of an interaction session with a credit card form
  59           type: string
  60         cc_name:
  61           description: Credit card cardholder name field result
  62           type: string
  63         cc_number:
  64           description: Credit card number field result
  65           type: string
  66         cc_type:
  67           description: Credit card type result
  68           type: string
  69         cc_exp:
  70           description: Credit card expiration date result
  71           type: string
  72         cc_exp_month:
  73           description: Credit card expiration month result
  74           type: string
  75         cc_exp_year:
  76           description: Credit card expiration year result
  77           type: string
  78         cc_number_multi_parts:
  79           description: The count of input fields for splitting the Credit Card Number
  80           type: quantity
  81
  82   form_popup_shown:
  83     type: event
  84     description: >
  85       Recorded when autofill popup is shown for a credit card form.
  86       The flow id indicates an interaction session with the a form and is shared across cc_form events.
  87       The field_name is used to record the field that triggers this event.
  88     bugs:
  89       - https://bugzilla.mozilla.org/show_bug.cgi?id=1653162
  90       - https://bugzilla.mozilla.org/show_bug.cgi?id=1653073
  91       - https://bugzilla.mozilla.org/show_bug.cgi?id=1720608
  92       - https://bugzilla.mozilla.org/show_bug.cgi?id=1767907
  93       - https://bugzilla.mozilla.org/show_bug.cgi?id=1757731
  94       - https://bugzilla.mozilla.org/show_bug.cgi?id=1834570
  95     data_reviews:
  96       - https://bugzilla.mozilla.org/show_bug.cgi?id=1653073#c5
  97       - https://bugzilla.mozilla.org/show_bug.cgi?id=1653073#c7
  98       - https://bugzilla.mozilla.org/show_bug.cgi?id=1720608#c5
  99       - https://bugzilla.mozilla.org/show_bug.cgi?id=1757731#c5
 100     notification_emails:
 101       - autofill@lists.mozilla.org
 102       - passwords-dev@mozilla.org
 103     expires: never
 104     extra_keys:
 105       flow_id:
 106         description: Flow id of an interaction session with a credit card form
 107         type: string
 108       field_name:
 109         description: Name of the field being affected by the event
 110         type: string
 111
 112   form_filled:
 113     type: event
 114     description: >
 115       Recorded when a credit card form is autofilled.
 116       The flow id indicates an interaction session with the a form and is shared across cc_form events.
 117       The possible value of cc_* are `filled`, `not_filled`, `user_filled` or `unavailable`
 118     bugs:
 119       - https://bugzilla.mozilla.org/show_bug.cgi?id=1653162
 120       - https://bugzilla.mozilla.org/show_bug.cgi?id=1653073
 121       - https://bugzilla.mozilla.org/show_bug.cgi?id=1720608
 122       - https://bugzilla.mozilla.org/show_bug.cgi?id=1767907
 123       - https://bugzilla.mozilla.org/show_bug.cgi?id=1757731
 124       - https://bugzilla.mozilla.org/show_bug.cgi?id=1834570
 125     data_reviews:
 126       - https://bugzilla.mozilla.org/show_bug.cgi?id=1653073#c5
 127       - https://bugzilla.mozilla.org/show_bug.cgi?id=1653073#c7
 128       - https://bugzilla.mozilla.org/show_bug.cgi?id=1720608#c5
 129       - https://bugzilla.mozilla.org/show_bug.cgi?id=1757731#c5
 130     notification_emails:
 131       - autofill@lists.mozilla.org
 132       - passwords-dev@mozilla.org
 133     expires: never
 134     extra_keys:
 135       flow_id:
 136         description: Flow id of an interaction session with a credit card form
 137         type: string
 138       cc_name:
 139         description: Credit card cardholder name field result
 140         type: string
 141       cc_number:
 142         description: Credit card number field result
 143         type: string
 144       cc_type:
 145         description: Credit card type result
 146         type: string
 147       cc_exp:
 148         description: Credit card expiration date result
 149         type: string
 150       cc_exp_month:
 151         description: Credit card expiration month result
 152         type: string
 153       cc_exp_year:
 154         description: Credit card expiration year result
 155         type: string
 156
 157   form_filled_modified:
 158     type: event
 159     description: >
 160       Recorded when a field in a credit card form is autofilled and then modified by the user.
 161       The flow id indicates an interaction session with the a form and is shared across cc_form events.
 162       The field_name is used to record the field that triggers this event.
 163     bugs:
 164       - https://bugzilla.mozilla.org/show_bug.cgi?id=1653162
 165       - https://bugzilla.mozilla.org/show_bug.cgi?id=1653073
 166       - https://bugzilla.mozilla.org/show_bug.cgi?id=1720608
 167       - https://bugzilla.mozilla.org/show_bug.cgi?id=1767907
 168       - https://bugzilla.mozilla.org/show_bug.cgi?id=1757731
 169       - https://bugzilla.mozilla.org/show_bug.cgi?id=1834570
 170     data_reviews:
 171       - https://bugzilla.mozilla.org/show_bug.cgi?id=1653073#c5
 172       - https://bugzilla.mozilla.org/show_bug.cgi?id=1653073#c7
 173       - https://bugzilla.mozilla.org/show_bug.cgi?id=1720608#c5
 174       - https://bugzilla.mozilla.org/show_bug.cgi?id=1757731#c5
 175     notification_emails:
 176       - autofill@lists.mozilla.org
 177       - passwords-dev@mozilla.org
 178     expires: never
 179     extra_keys:
 180       flow_id:
 181         description: Flow id of an interaction session with a credit card form
 182         type: string
 183       field_name:
 184         description: Name of the field being affected by the event
 185         type: string
 186
 187   form_submitted:
 188     type: event
 189     description: >
 190       Recorded when a credit card form is submitted.
 191       The flow id indicates an interaction session with the a form and is shared across cc_form events.
 192       The possible value of cc_* are `autofilled`, `user_filled` or `unavailable`
 193     bugs:
 194       - https://bugzilla.mozilla.org/show_bug.cgi?id=1653162
 195       - https://bugzilla.mozilla.org/show_bug.cgi?id=1653073
 196       - https://bugzilla.mozilla.org/show_bug.cgi?id=1720608
 197       - https://bugzilla.mozilla.org/show_bug.cgi?id=1767907
 198       - https://bugzilla.mozilla.org/show_bug.cgi?id=1757731
 199       - https://bugzilla.mozilla.org/show_bug.cgi?id=1834570
 200     data_reviews:
 201       - https://bugzilla.mozilla.org/show_bug.cgi?id=1653073#c5
 202       - https://bugzilla.mozilla.org/show_bug.cgi?id=1653073#c7
 203       - https://bugzilla.mozilla.org/show_bug.cgi?id=1720608#c5
 204       - https://bugzilla.mozilla.org/show_bug.cgi?id=1757731#c5
 205     notification_emails:
 206       - autofill@lists.mozilla.org
 207       - passwords-dev@mozilla.org
 208     expires: never
 209     extra_keys:
 210       flow_id:
 211         description: Flow id of an interaction session with a credit card form
 212         type: string
 213       cc_name:
 214         description: Credit card cardholder name field result
 215         type: string
 216       cc_number:
 217         description: Credit card number field result
 218         type: string
 219       cc_type:
 220         description: Credit card type result
 221         type: string
 222       cc_exp:
 223         description: Credit card expiration date result
 224         type: string
 225       cc_exp_month:
 226         description: Credit card expiration month result
 227         type: string
 228       cc_exp_year:
 229         description: Credit card expiration year result
 230         type: string
 231
 232   form_cleared:
 233     type: event
 234     description: >
 235       Recorded when a credit card form is cleared .
 236       The flow id indicates an interaction session with the a form and is shared across cc_form events.
 237       The field_name is used to record the field that triggers this event
 238     bugs:
 239       - https://bugzilla.mozilla.org/show_bug.cgi?id=1653162
 240       - https://bugzilla.mozilla.org/show_bug.cgi?id=1653073
 241       - https://bugzilla.mozilla.org/show_bug.cgi?id=1720608
 242       - https://bugzilla.mozilla.org/show_bug.cgi?id=1767907
 243       - https://bugzilla.mozilla.org/show_bug.cgi?id=1757731
 244       - https://bugzilla.mozilla.org/show_bug.cgi?id=1834570
 245     data_reviews:
 246       - https://bugzilla.mozilla.org/show_bug.cgi?id=1653073#c5
 247       - https://bugzilla.mozilla.org/show_bug.cgi?id=1653073#c7
 248       - https://bugzilla.mozilla.org/show_bug.cgi?id=1720608#c5
 249       - https://bugzilla.mozilla.org/show_bug.cgi?id=1757731#c5
 250     notification_emails:
 251       - autofill@lists.mozilla.org
 252       - passwords-dev@mozilla.org
 253     expires: never
 254     extra_keys:
 255       flow_id:
 256         description: Flow id of an interaction session with a credit card form
 257         type: string
 258       field_name:
 259         description: Name of the field being affected by the event
 260         type: string
 261
 262 formautofill:
 263   form_submission_heuristic:
 264     type: labeled_counter
 265     description:
 266       The heuristic that detected the form submission.
 267     labels:
 268       - form-submit-event
 269       - form-removal-after-fetch
 270       - page-navigation
 271       - iframe-pagehide
 272     bugs:
 273       - https://bugzilla.mozilla.org/show_bug.cgi?id=1874829
 274     data_reviews:
 275       - https://bugzilla.mozilla.org/show_bug.cgi?id=1874829#c4
 276     notification_emails:
 277       - autofill@lists.mozilla.org
 278       - passwords-dev@mozilla.org
 279     expires: 130