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 performance.pageload:
 120   load_time:
 121     type: timing_distribution
 122     time_unit: millisecond
 123     telemetry_mirror: PERF_PAGE_LOAD_TIME_MS
 124     description: >
 125       Time in milliseconds from navigationStart to loadEventStart
 126       for the foreground http or https root content document.
 127       (Migrated from the geckoview metric of the same name).
 128     bugs:
 129       - https://bugzilla.mozilla.org/show_bug.cgi?id=1671729
 130       - https://bugzilla.mozilla.org/show_bug.cgi?id=1877842
 131     data_reviews:
 132       - https://bugzilla.mozilla.org/show_bug.cgi?id=1671729#c7
 133     notification_emails:
 134       - dpalmeiro@mozilla.com
 135       - perf-telemetry-alerts@mozilla.com
 136     expires: never
 137
 138   load_time_responsestart:
 139     type: timing_distribution
 140     time_unit: millisecond
 141     telemetry_mirror: PERF_PAGE_LOAD_TIME_FROM_RESPONSESTART_MS
 142     description: >
 143       Time in milliseconds from responseStart to loadEventStart
 144       for the foreground http or https root content document.
 145       (Migrated from the geckoview metric of the same name).
 146     bugs:
 147       - https://bugzilla.mozilla.org/show_bug.cgi?id=1671729
 148       - https://bugzilla.mozilla.org/show_bug.cgi?id=1877842
 149     data_reviews:
 150       - https://bugzilla.mozilla.org/show_bug.cgi?id=1671729#c7
 151     notification_emails:
 152       - dpalmeiro@mozilla.com
 153       - perf-telemetry-alerts@mozilla.com
 154     expires: never
 155
 156   fcp:
 157     type: timing_distribution
 158     time_unit: millisecond
 159     telemetry_mirror: PERF_FIRST_CONTENTFUL_PAINT_MS
 160     description: >
 161       The time between navigationStart and the first contentful paint
 162       of a foreground http or https root content document, in
 163       milliseconds. The contentful paint timestamp is taken during
 164       display list building and does not include rasterization or
 165       compositing of that paint.
 166       (Migrated from the geckoview metric of the same name).
 167     bugs:
 168       - https://bugzilla.mozilla.org/show_bug.cgi?id=1671729
 169       - https://bugzilla.mozilla.org/show_bug.cgi?id=1877842
 170     data_reviews:
 171       - https://bugzilla.mozilla.org/show_bug.cgi?id=1671729#c7
 172     notification_emails:
 173       - dpalmeiro@mozilla.com
 174       - perf-telemetry-alerts@mozilla.com
 175     expires: never
 176
 177   fcp_responsestart:
 178     type: timing_distribution
 179     time_unit: millisecond
 180     telemetry_mirror: PERF_FIRST_CONTENTFUL_PAINT_FROM_RESPONSESTART_MS
 181     description: >
 182       The time between responseStart and the first contentful paint
 183       of a foreground http or https root content document, in
 184       milliseconds. The contentful paint timestamp is taken during
 185       display list building and does not include rasterization or
 186       compositing of that paint.
 187       (Migrated from the geckoview metric of the same name).
 188     bugs:
 189       - https://bugzilla.mozilla.org/show_bug.cgi?id=1671729
 190       - https://bugzilla.mozilla.org/show_bug.cgi?id=1877842
 191     data_reviews:
 192       - https://bugzilla.mozilla.org/show_bug.cgi?id=1671729#c7
 193     notification_emails:
 194       - dpalmeiro@mozilla.com
 195       - perf-telemetry-alerts@mozilla.com
 196     expires: never
 197
 198
 199 performance.time:
 200   dom_interactive:
 201     type: timing_distribution
 202     time_unit: millisecond
 203     telemetry_mirror: TIME_TO_DOM_INTERACTIVE_MS
 204     description: >
 205       Time from navigationStart to domInteractive as per the W3C
 206       Performance Timing API.
 207       (Migrated from the geckoview metric of the same name.)
 208     bugs:
 209       - https://bugzilla.mozilla.org/show_bug.cgi?id=1344893
 210       - https://bugzilla.mozilla.org/show_bug.cgi?id=1489524
 211       - https://bugzilla.mozilla.org/show_bug.cgi?id=1580077
 212       - https://bugzilla.mozilla.org/show_bug.cgi?id=1877842
 213     data_reviews:
 214       - https://bugzilla.mozilla.org/show_bug.cgi?id=1580077#c10
 215     notification_emails:
 216       - vgosu@mozilla.com
 217       - perf-telemetry-alerts@mozilla.com
 218     expires: never
 219
 220   dom_content_loaded_start:
 221     type: timing_distribution
 222     time_unit: millisecond
 223     telemetry_mirror: TIME_TO_DOM_CONTENT_LOADED_START_MS
 224     description: >
 225       Time from navigationStart to domContentLoadedEventStart as per
 226       the W3C Performance Timing API.
 227       (Migrated from the geckoview metric of the same name.)
 228     bugs:
 229       - https://bugzilla.mozilla.org/show_bug.cgi?id=1344893
 230       - https://bugzilla.mozilla.org/show_bug.cgi?id=1580077
 231       - https://bugzilla.mozilla.org/show_bug.cgi?id=1877842
 232     data_reviews:
 233       - https://bugzilla.mozilla.org/show_bug.cgi?id=1580077#c10
 234     notification_emails:
 235       - perf-telemetry-alerts@mozilla.com
 236       - bdekoz@mozilla.com
 237     expires: never
 238
 239   dom_content_loaded_end:
 240     type: timing_distribution
 241     time_unit: millisecond
 242     telemetry_mirror: TIME_TO_DOM_CONTENT_LOADED_END_MS
 243     description: >
 244       Time from navigationStart to domContentLoadedEventEnd as per
 245       the W3C Performance Timing API.
 246       (Migrated from the geckoview metric of the same name.)
 247     bugs:
 248       - https://bugzilla.mozilla.org/show_bug.cgi?id=1344893
 249       - https://bugzilla.mozilla.org/show_bug.cgi?id=1489524
 250       - https://bugzilla.mozilla.org/show_bug.cgi?id=1580077
 251       - https://bugzilla.mozilla.org/show_bug.cgi?id=1877842
 252     data_reviews:
 253       - https://bugzilla.mozilla.org/show_bug.cgi?id=1580077#c10
 254     notification_emails:
 255       - vchin@mozilla.com
 256       - perf-telemetry-alerts@mozilla.com
 257     expires: never
 258
 259   dom_complete:
 260     type: timing_distribution
 261     time_unit: millisecond
 262     telemetry_mirror: TIME_TO_DOM_COMPLETE_MS
 263     description: >
 264       Time from navigationStart to domComplete as per the W3C Performance
 265       Timing API.
 266       (Migrated from the geckoview metric of the same name.)
 267     bugs:
 268       - https://bugzilla.mozilla.org/show_bug.cgi?id=1344893
 269       - https://bugzilla.mozilla.org/show_bug.cgi?id=1489524
 270       - https://bugzilla.mozilla.org/show_bug.cgi?id=1580077
 271       - https://bugzilla.mozilla.org/show_bug.cgi?id=1877842
 272     data_reviews:
 273       - https://bugzilla.mozilla.org/show_bug.cgi?id=1580077#c10
 274     notification_emails:
 275       - vgosu@mozilla.com
 276       - perf-telemetry-alerts@mozilla.com
 277     expires: never
 278
 279   load_event_start:
 280     type: timing_distribution
 281     time_unit: millisecond
 282     telemetry_mirror: TIME_TO_LOAD_EVENT_START_MS
 283     description: >
 284       Time from navigationStart to loadEventStart as per the W3C Performance
 285       Timing API.
 286       (Migrated from the geckoview metric of the same name.)
 287     bugs:
 288       - https://bugzilla.mozilla.org/show_bug.cgi?id=1344893
 289       - https://bugzilla.mozilla.org/show_bug.cgi?id=1580077
 290       - https://bugzilla.mozilla.org/show_bug.cgi?id=1877842
 291     data_reviews:
 292       - https://bugzilla.mozilla.org/show_bug.cgi?id=1580077#c10
 293     notification_emails:
 294       - perf-telemetry-alerts@mozilla.com
 295       - bdekoz@mozilla.com
 296     expires: never
 297
 298   load_event_end:
 299     type: timing_distribution
 300     time_unit: millisecond
 301     telemetry_mirror: TIME_TO_LOAD_EVENT_END_MS
 302     description: >
 303       Time from navigationStart to loadEventEnd as per the W3C Performance
 304       Timing API.
 305       (Migrated from the geckoview metric of the same name.)
 306     bugs:
 307       - https://bugzilla.mozilla.org/show_bug.cgi?id=1344893
 308       - https://bugzilla.mozilla.org/show_bug.cgi?id=1489524
 309       - https://bugzilla.mozilla.org/show_bug.cgi?id=1580077
 310       - https://bugzilla.mozilla.org/show_bug.cgi?id=1877842
 311     data_reviews:
 312       - https://bugzilla.mozilla.org/show_bug.cgi?id=1580077#c10
 313     notification_emails:
 314       - vchin@mozilla.com
 315       - perf-telemetry-alerts@mozilla.com
 316     expires: never
 317
 318
 319 performance.page:
 320   non_blank_paint:
 321     type: timing_distribution
 322     time_unit: millisecond
 323     telemetry_mirror: TIME_TO_NON_BLANK_PAINT_MS
 324     description: >
 325       The time between navigationStart and the first non-blank paint of a
 326       foreground root content document, in milliseconds. This only records
 327       documents that were in an active docshell throughout the whole time
 328       between navigation start and non-blank paint. The non-blank paint
 329       timestamp is taken during display list building and does not include
 330       rasterization or compositing of that paint.
 331       (Migrated from the geckoview metric of the same name.)
 332     bugs:
 333       - https://bugzilla.mozilla.org/show_bug.cgi?id=1307242
 334       - https://bugzilla.mozilla.org/show_bug.cgi?id=1489524
 335       - https://bugzilla.mozilla.org/show_bug.cgi?id=1580077
 336       - https://bugzilla.mozilla.org/show_bug.cgi?id=1877842
 337     data_reviews:
 338       - https://bugzilla.mozilla.org/show_bug.cgi?id=1580077#c10
 339     notification_emails:
 340       - vchin@mozilla.com
 341       - perf-telemetry-alerts@mozilla.com
 342     expires: never
 343
 344
 345 javascript.pageload:
 346   execution_time:
 347     type: timing_distribution
 348     time_unit: millisecond
 349     telemetry_mirror: JS_PAGELOAD_EXECUTION_MS
 350     description: >
 351       Time spent during page load executing Javascript in ms.
 352       (Migrated from the geckoview metric of the same name.)
 353     bugs:
 354       - https://bugzilla.mozilla.org/show_bug.cgi?id=1709139
 355       - https://bugzilla.mozilla.org/show_bug.cgi?id=1877843
 356     data_reviews:
 357       - https://bugzilla.mozilla.org/show_bug.cgi?id=1709139#c4
 358     notification_emails:
 359       - dpalmeiro@mozilla.com
 360       - perf-telemetry-alerts@mozilla.com
 361     expires: never
 362
 363   delazification_time:
 364     type: timing_distribution
 365     time_unit: millisecond
 366     telemetry_mirror: JS_PAGELOAD_DELAZIFICATION_MS
 367     description: >
 368       Time spent during page load delazifying 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   xdr_encode_time:
 381     type: timing_distribution
 382     time_unit: millisecond
 383     telemetry_mirror: JS_PAGELOAD_XDR_ENCODING_MS
 384     description: >
 385       Time spent during page load XDR encoding 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   baseline_compile_time:
 398     type: timing_distribution
 399     time_unit: millisecond
 400     telemetry_mirror: JS_PAGELOAD_BASELINE_COMPILE_MS
 401     description: >
 402       Time spent during page load baseline compiling 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   gc_time:
 415     type: timing_distribution
 416     time_unit: millisecond
 417     telemetry_mirror: JS_PAGELOAD_GC_MS
 418     description: >
 419       Time spent during page load in the GC 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   parse_time:
 432     type: timing_distribution
 433     time_unit: millisecond
 434     telemetry_mirror: JS_PAGELOAD_PARSE_MS
 435     description: >
 436       Time spent during page load syntax parsing JS scripts on
 437       the main thread in ms.
 438       (Migrated from the geckoview metric of the same name.)
 439     bugs:
 440       - https://bugzilla.mozilla.org/show_bug.cgi?id=1709139
 441       - https://bugzilla.mozilla.org/show_bug.cgi?id=1877843
 442     data_reviews:
 443       - https://bugzilla.mozilla.org/show_bug.cgi?id=1709139#c4
 444     notification_emails:
 445       - dpalmeiro@mozilla.com
 446       - perf-telemetry-alerts@mozilla.com
 447     expires: never
 448
 449   protect_time:
 450     type: timing_distribution
 451     time_unit: millisecond
 452     telemetry_mirror: JS_PAGELOAD_PROTECT_MS
 453     description: >
 454       Time spent during page load protecting JIT executable memory.
 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