dom/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   - 'Core :: DOM: Core & HTML'
  12
  13 perf:
  14   largest_contentful_paint:
  15     type: timing_distribution
  16     time_unit: millisecond
  17     description: >
  18         Time from navigation start to largest contentful paint.
  19     bugs:
  20       - https://bugzilla.mozilla.org/show_bug.cgi?id=1862939
  21     data_reviews:
  22       - https://bugzilla.mozilla.org/show_bug.cgi?id=1862939#c5
  23     notification_emails:
  24       - perf-telemetry-alerts@mozilla.com
  25     expires: never
  26     telemetry_mirror: PERF_LARGEST_CONTENTFUL_PAINT_MS
  27   largest_contentful_paint_from_response_start:
  28     type: timing_distribution
  29     time_unit: millisecond
  30     description: >
  31         Time from response start to largest contentful paint.
  32     bugs:
  33       - https://bugzilla.mozilla.org/show_bug.cgi?id=1862939
  34     data_reviews:
  35       - https://bugzilla.mozilla.org/show_bug.cgi?id=1862939#c5
  36     notification_emails:
  37       - perf-telemetry-alerts@mozilla.com
  38     expires: never
  39     telemetry_mirror: PERF_LARGEST_CONTENTFUL_PAINT_FROM_RESPONSE_START_MS
  40   page_load:
  41     type: event
  42     description: >
  43         Recorded when a top level content document has been loaded.
  44     bugs:
  45       - https://bugzilla.mozilla.org/show_bug.cgi?id=1759744
  46       - https://bugzilla.mozilla.org/show_bug.cgi?id=1799727
  47       - https://bugzilla.mozilla.org/show_bug.cgi?id=1834774
  48       - https://bugzilla.mozilla.org/show_bug.cgi?id=1862939
  49     data_reviews:
  50       - https://bugzilla.mozilla.org/show_bug.cgi?id=1759744#c5
  51       - https://bugzilla.mozilla.org/show_bug.cgi?id=1799727#c4
  52       - https://bugzilla.mozilla.org/show_bug.cgi?id=1834774#c3
  53       - https://bugzilla.mozilla.org/show_bug.cgi?id=1862939#c5
  54     notification_emails:
  55       - perf-telemetry-alerts@mozilla.com
  56       - dpalmeiro@mozilla.com
  57     expires: never
  58     extra_keys:
  59       load_time:
  60         description:
  61           "Time between loadEventStart and navigationStart, in ms."
  62         type: quantity
  63         unit: ms
  64       dns_lookup_time:
  65         description:
  66           "Time taken to perform dns lookup of the top level document, in ms."
  67         type: quantity
  68         unit: ms
  69       response_time:
  70         description:
  71           "Time between responseStart and navigationStart, in ms."
  72         type: quantity
  73         unit: ms
  74       fcp_time:
  75         description:
  76           "Time between firstContentfulPaint and navigationStart, in ms."
  77         type: quantity
  78         unit: ms
  79       lcp_time:
  80         description:
  81           "Time between largestContentfulPaint and navigationStart, at the point of onLoad firing, in ms. This may differ from the final LCP value as reported through the LCP histogram."
  82         type: quantity
  83         unit: ms
  84       js_exec_time:
  85         description:
  86           "Time spent executing JS during page load, in ms."
  87         type: quantity
  88         unit: ms
  89       redirect_time:
  90         type: quantity
  91         description:
  92           "Time spent in redirections for the top level document."
  93         unit: ms
  94       redirect_count:
  95         description:
  96           "Number of redirections for the top level document."
  97         type: quantity
  98         unit: integer
  99       load_type:
 100         description:
 101           "One of normal,reload,stop,link,history,error or other."
 102         type: string
 103       same_origin_nav:
 104         description:
 105           "If true, a normal navigation was performed on the same origin."
 106         type: boolean
 107       http_ver:
 108         description:
 109           "Version of HTTP protocol used."
 110         type: quantity
 111         unit: integer
 112       trr_domain:
 113         description:
 114           "TRR domain used."
 115         type: string
 116     send_in_pings:
 117       - pageload
 118
 119 bloburl:
 120   resolve_stopped:
 121     type: counter
 122     description: >
 123       Counts how many times we do not resolve a blob URL
 124       because of different partition keys
 125     bugs:
 126       - https://bugzilla.mozilla.org/show_bug.cgi?id=1843158
 127     data_reviews:
 128       - https://bugzilla.mozilla.org/show_bug.cgi?id=1843158
 129     data_sensitivity:
 130       - technical
 131     notification_emails:
 132       - amadan@mozilla.com
 133     expires: 127
 134     telemetry_mirror: BLOBURL_RESOLVE_STOPPED
 135
 136 performance.pageload:
 137   load_time:
 138     type: timing_distribution
 139     time_unit: millisecond
 140     telemetry_mirror: PERF_PAGE_LOAD_TIME_MS
 141     description: >
 142       Time in milliseconds from navigationStart to loadEventStart
 143       for the foreground http or https root content document.
 144       (Migrated from the geckoview metric of the same name).
 145     bugs:
 146       - https://bugzilla.mozilla.org/show_bug.cgi?id=1671729
 147       - https://bugzilla.mozilla.org/show_bug.cgi?id=1877842
 148     data_reviews:
 149       - https://bugzilla.mozilla.org/show_bug.cgi?id=1671729#c7
 150     notification_emails:
 151       - dpalmeiro@mozilla.com
 152       - perf-telemetry-alerts@mozilla.com
 153     expires: never
 154
 155   load_time_responsestart:
 156     type: timing_distribution
 157     time_unit: millisecond
 158     telemetry_mirror: PERF_PAGE_LOAD_TIME_FROM_RESPONSESTART_MS
 159     description: >
 160       Time in milliseconds from responseStart to loadEventStart
 161       for the foreground http or https root content document.
 162       (Migrated from the geckoview metric of the same name).
 163     bugs:
 164       - https://bugzilla.mozilla.org/show_bug.cgi?id=1671729
 165       - https://bugzilla.mozilla.org/show_bug.cgi?id=1877842
 166     data_reviews:
 167       - https://bugzilla.mozilla.org/show_bug.cgi?id=1671729#c7
 168     notification_emails:
 169       - dpalmeiro@mozilla.com
 170       - perf-telemetry-alerts@mozilla.com
 171     expires: never
 172
 173   fcp:
 174     type: timing_distribution
 175     time_unit: millisecond
 176     telemetry_mirror: PERF_FIRST_CONTENTFUL_PAINT_MS
 177     description: >
 178       The time between navigationStart and the first contentful paint
 179       of a foreground http or https root content document, in
 180       milliseconds. The contentful paint timestamp is taken during
 181       display list building and does not include rasterization or
 182       compositing of that paint.
 183       (Migrated from the geckoview metric of the same name).
 184     bugs:
 185       - https://bugzilla.mozilla.org/show_bug.cgi?id=1671729
 186       - https://bugzilla.mozilla.org/show_bug.cgi?id=1877842
 187     data_reviews:
 188       - https://bugzilla.mozilla.org/show_bug.cgi?id=1671729#c7
 189     notification_emails:
 190       - dpalmeiro@mozilla.com
 191       - perf-telemetry-alerts@mozilla.com
 192     expires: never
 193
 194   fcp_responsestart:
 195     type: timing_distribution
 196     time_unit: millisecond
 197     telemetry_mirror: PERF_FIRST_CONTENTFUL_PAINT_FROM_RESPONSESTART_MS
 198     description: >
 199       The time between responseStart and the first contentful paint
 200       of a foreground http or https root content document, in
 201       milliseconds. The contentful paint timestamp is taken during
 202       display list building and does not include rasterization or
 203       compositing of that paint.
 204       (Migrated from the geckoview metric of the same name).
 205     bugs:
 206       - https://bugzilla.mozilla.org/show_bug.cgi?id=1671729
 207       - https://bugzilla.mozilla.org/show_bug.cgi?id=1877842
 208     data_reviews:
 209       - https://bugzilla.mozilla.org/show_bug.cgi?id=1671729#c7
 210     notification_emails:
 211       - dpalmeiro@mozilla.com
 212       - perf-telemetry-alerts@mozilla.com
 213     expires: never
 214
 215
 216 performance.time:
 217   dom_interactive:
 218     type: timing_distribution
 219     time_unit: millisecond
 220     telemetry_mirror: TIME_TO_DOM_INTERACTIVE_MS
 221     description: >
 222       Time from navigationStart to domInteractive as per the W3C
 223       Performance Timing API.
 224       (Migrated from the geckoview metric of the same name.)
 225     bugs:
 226       - https://bugzilla.mozilla.org/show_bug.cgi?id=1344893
 227       - https://bugzilla.mozilla.org/show_bug.cgi?id=1489524
 228       - https://bugzilla.mozilla.org/show_bug.cgi?id=1580077
 229       - https://bugzilla.mozilla.org/show_bug.cgi?id=1877842
 230     data_reviews:
 231       - https://bugzilla.mozilla.org/show_bug.cgi?id=1580077#c10
 232     notification_emails:
 233       - vgosu@mozilla.com
 234       - perf-telemetry-alerts@mozilla.com
 235     expires: never
 236
 237   dom_content_loaded_start:
 238     type: timing_distribution
 239     time_unit: millisecond
 240     telemetry_mirror: TIME_TO_DOM_CONTENT_LOADED_START_MS
 241     description: >
 242       Time from navigationStart to domContentLoadedEventStart as per
 243       the W3C Performance Timing API.
 244       (Migrated from the geckoview metric of the same name.)
 245     bugs:
 246       - https://bugzilla.mozilla.org/show_bug.cgi?id=1344893
 247       - https://bugzilla.mozilla.org/show_bug.cgi?id=1580077
 248       - https://bugzilla.mozilla.org/show_bug.cgi?id=1877842
 249     data_reviews:
 250       - https://bugzilla.mozilla.org/show_bug.cgi?id=1580077#c10
 251     notification_emails:
 252       - perf-telemetry-alerts@mozilla.com
 253       - bdekoz@mozilla.com
 254     expires: never
 255
 256   dom_content_loaded_end:
 257     type: timing_distribution
 258     time_unit: millisecond
 259     telemetry_mirror: TIME_TO_DOM_CONTENT_LOADED_END_MS
 260     description: >
 261       Time from navigationStart to domContentLoadedEventEnd as per
 262       the W3C Performance Timing API.
 263       (Migrated from the geckoview metric of the same name.)
 264     bugs:
 265       - https://bugzilla.mozilla.org/show_bug.cgi?id=1344893
 266       - https://bugzilla.mozilla.org/show_bug.cgi?id=1489524
 267       - https://bugzilla.mozilla.org/show_bug.cgi?id=1580077
 268       - https://bugzilla.mozilla.org/show_bug.cgi?id=1877842
 269     data_reviews:
 270       - https://bugzilla.mozilla.org/show_bug.cgi?id=1580077#c10
 271     notification_emails:
 272       - vchin@mozilla.com
 273       - perf-telemetry-alerts@mozilla.com
 274     expires: never
 275
 276   dom_complete:
 277     type: timing_distribution
 278     time_unit: millisecond
 279     telemetry_mirror: TIME_TO_DOM_COMPLETE_MS
 280     description: >
 281       Time from navigationStart to domComplete as per the W3C Performance
 282       Timing API.
 283       (Migrated from the geckoview metric of the same name.)
 284     bugs:
 285       - https://bugzilla.mozilla.org/show_bug.cgi?id=1344893
 286       - https://bugzilla.mozilla.org/show_bug.cgi?id=1489524
 287       - https://bugzilla.mozilla.org/show_bug.cgi?id=1580077
 288       - https://bugzilla.mozilla.org/show_bug.cgi?id=1877842
 289     data_reviews:
 290       - https://bugzilla.mozilla.org/show_bug.cgi?id=1580077#c10
 291     notification_emails:
 292       - vgosu@mozilla.com
 293       - perf-telemetry-alerts@mozilla.com
 294     expires: never
 295
 296   load_event_start:
 297     type: timing_distribution
 298     time_unit: millisecond
 299     telemetry_mirror: TIME_TO_LOAD_EVENT_START_MS
 300     description: >
 301       Time from navigationStart to loadEventStart as per the W3C Performance
 302       Timing API.
 303       (Migrated from the geckoview metric of the same name.)
 304     bugs:
 305       - https://bugzilla.mozilla.org/show_bug.cgi?id=1344893
 306       - https://bugzilla.mozilla.org/show_bug.cgi?id=1580077
 307       - https://bugzilla.mozilla.org/show_bug.cgi?id=1877842
 308     data_reviews:
 309       - https://bugzilla.mozilla.org/show_bug.cgi?id=1580077#c10
 310     notification_emails:
 311       - perf-telemetry-alerts@mozilla.com
 312       - bdekoz@mozilla.com
 313     expires: never
 314
 315   load_event_end:
 316     type: timing_distribution
 317     time_unit: millisecond
 318     telemetry_mirror: TIME_TO_LOAD_EVENT_END_MS
 319     description: >
 320       Time from navigationStart to loadEventEnd as per the W3C Performance
 321       Timing API.
 322       (Migrated from the geckoview metric of the same name.)
 323     bugs:
 324       - https://bugzilla.mozilla.org/show_bug.cgi?id=1344893
 325       - https://bugzilla.mozilla.org/show_bug.cgi?id=1489524
 326       - https://bugzilla.mozilla.org/show_bug.cgi?id=1580077
 327       - https://bugzilla.mozilla.org/show_bug.cgi?id=1877842
 328     data_reviews:
 329       - https://bugzilla.mozilla.org/show_bug.cgi?id=1580077#c10
 330     notification_emails:
 331       - vchin@mozilla.com
 332       - perf-telemetry-alerts@mozilla.com
 333     expires: never
 334
 335
 336 performance.page:
 337   non_blank_paint:
 338     type: timing_distribution
 339     time_unit: millisecond
 340     telemetry_mirror: TIME_TO_NON_BLANK_PAINT_MS
 341     description: >
 342       The time between navigationStart and the first non-blank paint of a
 343       foreground root content document, in milliseconds. This only records
 344       documents that were in an active docshell throughout the whole time
 345       between navigation start and non-blank paint. The non-blank paint
 346       timestamp is taken during display list building and does not include
 347       rasterization or compositing of that paint.
 348       (Migrated from the geckoview metric of the same name.)
 349     bugs:
 350       - https://bugzilla.mozilla.org/show_bug.cgi?id=1307242
 351       - https://bugzilla.mozilla.org/show_bug.cgi?id=1489524
 352       - https://bugzilla.mozilla.org/show_bug.cgi?id=1580077
 353       - https://bugzilla.mozilla.org/show_bug.cgi?id=1877842
 354     data_reviews:
 355       - https://bugzilla.mozilla.org/show_bug.cgi?id=1580077#c10
 356     notification_emails:
 357       - vchin@mozilla.com
 358       - perf-telemetry-alerts@mozilla.com
 359     expires: never
 360
 361
 362 javascript.pageload:
 363   execution_time:
 364     type: timing_distribution
 365     time_unit: millisecond
 366     telemetry_mirror: JS_PAGELOAD_EXECUTION_MS
 367     description: >
 368       Time spent during page load executing Javascript in ms.
 369       (Migrated from the geckoview metric of the same name.)
 370     bugs:
 371       - https://bugzilla.mozilla.org/show_bug.cgi?id=1709139
 372       - https://bugzilla.mozilla.org/show_bug.cgi?id=1877843
 373     data_reviews:
 374       - https://bugzilla.mozilla.org/show_bug.cgi?id=1709139#c4
 375     notification_emails:
 376       - dpalmeiro@mozilla.com
 377       - perf-telemetry-alerts@mozilla.com
 378     expires: never
 379
 380   delazification_time:
 381     type: timing_distribution
 382     time_unit: millisecond
 383     telemetry_mirror: JS_PAGELOAD_DELAZIFICATION_MS
 384     description: >
 385       Time spent during page load delazifying Javascript in ms.
 386       (Migrated from the geckoview metric of the same name.)
 387     bugs:
 388       - https://bugzilla.mozilla.org/show_bug.cgi?id=1709139
 389       - https://bugzilla.mozilla.org/show_bug.cgi?id=1877843
 390     data_reviews:
 391       - https://bugzilla.mozilla.org/show_bug.cgi?id=1709139#c4
 392     notification_emails:
 393       - dpalmeiro@mozilla.com
 394       - perf-telemetry-alerts@mozilla.com
 395     expires: never
 396
 397   xdr_encode_time:
 398     type: timing_distribution
 399     time_unit: millisecond
 400     telemetry_mirror: JS_PAGELOAD_XDR_ENCODING_MS
 401     description: >
 402       Time spent during page load XDR encoding Javascript in ms.
 403       (Migrated from the geckoview metric of the same name.)
 404     bugs:
 405       - https://bugzilla.mozilla.org/show_bug.cgi?id=1709139
 406       - https://bugzilla.mozilla.org/show_bug.cgi?id=1877843
 407     data_reviews:
 408       - https://bugzilla.mozilla.org/show_bug.cgi?id=1709139#c4
 409     notification_emails:
 410       - dpalmeiro@mozilla.com
 411       - perf-telemetry-alerts@mozilla.com
 412     expires: never
 413
 414   baseline_compile_time:
 415     type: timing_distribution
 416     time_unit: millisecond
 417     telemetry_mirror: JS_PAGELOAD_BASELINE_COMPILE_MS
 418     description: >
 419       Time spent during page load baseline compiling Javascript in ms.
 420       (Migrated from the geckoview metric of the same name.)
 421     bugs:
 422       - https://bugzilla.mozilla.org/show_bug.cgi?id=1709139
 423       - https://bugzilla.mozilla.org/show_bug.cgi?id=1877843
 424     data_reviews:
 425       - https://bugzilla.mozilla.org/show_bug.cgi?id=1709139#c4
 426     notification_emails:
 427       - dpalmeiro@mozilla.com
 428       - perf-telemetry-alerts@mozilla.com
 429     expires: never
 430
 431   gc_time:
 432     type: timing_distribution
 433     time_unit: millisecond
 434     telemetry_mirror: JS_PAGELOAD_GC_MS
 435     description: >
 436       Time spent during page load in the GC in ms.
 437       (Migrated from the geckoview metric of the same name.)
 438     bugs:
 439       - https://bugzilla.mozilla.org/show_bug.cgi?id=1709139
 440       - https://bugzilla.mozilla.org/show_bug.cgi?id=1877843
 441     data_reviews:
 442       - https://bugzilla.mozilla.org/show_bug.cgi?id=1709139#c4
 443     notification_emails:
 444       - dpalmeiro@mozilla.com
 445       - perf-telemetry-alerts@mozilla.com
 446     expires: never
 447
 448   parse_time:
 449     type: timing_distribution
 450     time_unit: millisecond
 451     telemetry_mirror: JS_PAGELOAD_PARSE_MS
 452     description: >
 453       Time spent during page load syntax parsing JS scripts on
 454       the main thread in ms.
 455       (Migrated from the geckoview metric of the same name.)
 456     bugs:
 457       - https://bugzilla.mozilla.org/show_bug.cgi?id=1709139
 458       - https://bugzilla.mozilla.org/show_bug.cgi?id=1877843
 459     data_reviews:
 460       - https://bugzilla.mozilla.org/show_bug.cgi?id=1709139#c4
 461     notification_emails:
 462       - dpalmeiro@mozilla.com
 463       - perf-telemetry-alerts@mozilla.com
 464     expires: never
 465
 466   protect_time:
 467     type: timing_distribution
 468     time_unit: millisecond
 469     telemetry_mirror: JS_PAGELOAD_PROTECT_MS
 470     description: >
 471       Time spent during page load protecting JIT executable memory.
 472       (Migrated from the geckoview metric of the same name.)
 473     bugs:
 474       - https://bugzilla.mozilla.org/show_bug.cgi?id=1709139
 475       - https://bugzilla.mozilla.org/show_bug.cgi?id=1877843
 476     data_reviews:
 477       - https://bugzilla.mozilla.org/show_bug.cgi?id=1709139#c4
 478     notification_emails:
 479       - dpalmeiro@mozilla.com
 480       - perf-telemetry-alerts@mozilla.com
 481     expires: never