Bug 1596365 - Adjust metrics.yaml to pass yamllint. r=chutten
authorAlessio Placitelli <alessio.placitelli@gmail.com>
Thu, 14 Nov 2019 16:40:31 +0000
changeset 501982 29ad799700cde08c67fae646439e1bbdb6a1ede2
parent 501981 8dc03b744500555e87b7506bd317a6c70438603c
child 501983 6c7a26bb6f04fe1677fd8ceb0ca914d042beea41
push id114172
push userdluca@mozilla.com
push dateTue, 19 Nov 2019 11:31:10 +0000
treeherdermozilla-inbound@b5c5ba07d3db [default view] [failures only]
perfherder[talos] [build metrics] [platform microbench] (compared to previous push)
reviewerschutten
bugs1596365
milestone72.0a1
first release with
nightly linux32
nightly linux64
nightly mac
nightly win32
nightly win64
last release without
nightly linux32
nightly linux64
nightly mac
nightly win32
nightly win64
Bug 1596365 - Adjust metrics.yaml to pass yamllint. r=chutten Differential Revision: https://phabricator.services.mozilla.com/D52982
toolkit/components/telemetry/geckoview/streaming/metrics.yaml
--- a/toolkit/components/telemetry/geckoview/streaming/metrics.yaml
+++ b/toolkit/components/telemetry/geckoview/streaming/metrics.yaml
@@ -1,25 +1,27 @@
 # This Source Code Form is subject to the terms of the Mozilla Public
 # License, v. 2.0. If a copy of the MPL was not distributed with this
 # file, You can obtain one at http://mozilla.org/MPL/2.0/.
 
 # This file defines the metrics that are recorded by the Glean SDK. They are
 # automatically converted to platform-specific code at build time using the
 # `glean_parser` PyPI package.
 
+---
 $schema: moz://mozilla.org/schemas/glean/metrics/1-0-0
 
 geckoview:
   page_load_time:
     type: timing_distribution
     time_unit: millisecond
     gecko_datapoint: GV_PAGE_LOAD_MS
     description: >
-      The time taken to load a page. This includes all static contents, no dynamic content.
+      The time taken to load a page. This includes all static contents, no
+      dynamic content.
       Loading of about: pages is not counted.
     bugs:
       - https://bugzilla.mozilla.org/show_bug.cgi?id=1499418
       - https://bugzilla.mozilla.org/show_bug.cgi?id=1584109
     data_reviews:
       - https://bugzilla.mozilla.org/show_bug.cgi?id=1584109#c1
     notification_emails:
       - geckoview-team@mozilla.com
@@ -44,19 +46,22 @@ geckoview:
 
 gfx:
   composite_time:
     type: timing_distribution
     time_unit: millisecond
     gecko_datapoint: COMPOSITE_TIME
     description: >
       The time taken to composite a frame.
-      On non-webrender this is the time taken in `CompositorBridgeParent::CompositeToTarget()`.
-      On webrender, this is the time taken from the start of `WebRenderBridgeParent::CompositeToTarget()`,
-      until the render thread has rendered the frame (in `RenderThread::HandleFrameOneDoc()`).
+      On non-webrender this is the time taken in
+      `CompositorBridgeParent::CompositeToTarget()`.
+      On webrender, this is the time taken from the start of
+      `WebRenderBridgeParent::CompositeToTarget()`,
+      until the render thread has rendered the frame (in
+      `RenderThread::HandleFrameOneDoc()`).
     bugs:
       - https://bugzilla.mozilla.org/show_bug.cgi?id=1080160
       - https://bugzilla.mozilla.org/show_bug.cgi?id=1529352
       - https://bugzilla.mozilla.org/show_bug.cgi?id=1580129
     data_reviews:
       - https://bugzilla.mozilla.org/show_bug.cgi?id=1580129#c7
     notification_emails:
       - gfx-telemetry-alerts@mozilla.com
@@ -65,19 +70,20 @@ gfx:
 
 gfx.checkerboard:
   duration:
     type: timing_distribution
     time_unit: millisecond
     gecko_datapoint: CHECKERBOARD_DURATION
     description: >
       The duration of a checkerboard event.
-      Checkerboarding is when painting has not kept up with asynchronous panning and
-      zooming so the compositor has to display a "checkerboard pattern" (or in practice,
-      the background color) rather than the actual page content.
+      Checkerboarding is when painting has not kept up with asynchronous
+      panning and zooming so the compositor has to display a "checkerboard
+      pattern" (or in practice, the background color) rather than the actual
+      page content.
     bugs:
       - https://bugzilla.mozilla.org/show_bug.cgi?id=1238040
       - https://bugzilla.mozilla.org/show_bug.cgi?id=1539309
       - https://bugzilla.mozilla.org/show_bug.cgi?id=1584109
     data_reviews:
       - https://bugzilla.mozilla.org/show_bug.cgi?id=1584109#c1
     notification_emails:
       - gfx-telemetry-alerts@mozilla.com
@@ -87,19 +93,19 @@ gfx.checkerboard:
   peak_pixel_count:
     type: custom_distribution
     range_max: 66355200
     bucket_count: 50
     histogram_type: exponential
     unit: Pixels
     gecko_datapoint: CHECKERBOARD_PEAK
     description: >
-      The peak number of CSS pixels that checkerboarded during a checkerboard event.
-      The minimum value of the largest histogram bucket is the size of a 4k display with
-      maximum APZ zooming.
+      The peak number of CSS pixels that checkerboarded during a checkerboard
+      event. The minimum value of the largest histogram bucket is the size of
+      a 4k display with maximum APZ zooming.
     bugs:
       - https://bugzilla.mozilla.org/show_bug.cgi?id=1238040
       - https://bugzilla.mozilla.org/show_bug.cgi?id=1539309
       - https://bugzilla.mozilla.org/show_bug.cgi?id=1584109
     data_reviews:
       - https://bugzilla.mozilla.org/show_bug.cgi?id=1584109#c1
     notification_emails:
       - gfx-telemetry-alerts@mozilla.com
@@ -111,19 +117,20 @@ gfx.checkerboard:
     time_unit: millisecond
     gecko_datapoint: CHECKERBOARD_POTENTIAL_DURATION
     description: >
       The total amount of time that we could reasonably be checkerboarding.
       This is the union of two possibly-intersecting sets of time periods:
       The first set is that in which checkerboarding was actually happening,
       since by definition it could potentially be happening.
       The second set is that in which the APZC is actively transforming content
-      in the compositor, since it could potentially transform it so as to display
-      checkerboarding to the user. Combined with other information, this allows us
-      to meaningfully say how frequently users actually enncounters checkerboarding.
+      in the compositor, since it could potentially transform it so as to
+      display checkerboarding to the user. Combined with other information,
+      this allows us to meaningfully say how frequently users actually
+      enncounters checkerboarding.
     bugs:
       - https://bugzilla.mozilla.org/show_bug.cgi?id=1238040
       - https://bugzilla.mozilla.org/show_bug.cgi?id=1539309
       - https://bugzilla.mozilla.org/show_bug.cgi?id=1584109
     data_reviews:
       - https://bugzilla.mozilla.org/show_bug.cgi?id=1584109#c1
     notification_emails:
       - gfx-telemetry-alerts@mozilla.com
@@ -136,17 +143,18 @@ gfx.checkerboard:
     bucket_count: 50
     histogram_type: exponential
     unit: Opaque unit
     gecko_datapoint: CHECKERBOARD_SEVERITY
     description: >
       An opaque measurement of the severity of a checkerboard event.
       This doesn't have units, it's just useful for comparing two checkerboard
       events to see which one is worse, for some implementation-specific
-      definition of "worse". The larger the value, the worse the checkerboarding.
+      definition of "worse". The larger the value, the worse the
+      checkerboarding.
     bugs:
       - https://bugzilla.mozilla.org/show_bug.cgi?id=1238040
       - https://bugzilla.mozilla.org/show_bug.cgi?id=1539309
       - https://bugzilla.mozilla.org/show_bug.cgi?id=1584109
     data_reviews:
       - https://bugzilla.mozilla.org/show_bug.cgi?id=1584109#c1
     notification_emails:
       - gfx-telemetry-alerts@mozilla.com
@@ -155,19 +163,20 @@ gfx.checkerboard:
 
 gfx.content:
   paint_time:
     type: timing_distribution
     time_unit: millisecond
     gecko_datapoint: CONTENT_PAINT_TIME
     description: >
       Time spent in the main-thread paint pipeline for content.
-      For non-webrender, this includes display list building, layer building, and when OMTP
-      is disabled, rasterization.
-      For webrender, this includes display list building, and webrender display list building.
+      For non-webrender, this includes display list building, layer building,
+      and when OMTP is disabled, rasterization.
+      For webrender, this includes display list building, and webrender display
+      list building.
     bugs:
       - https://bugzilla.mozilla.org/show_bug.cgi?id=1309442
       - https://bugzilla.mozilla.org/show_bug.cgi?id=1489524
       - https://bugzilla.mozilla.org/show_bug.cgi?id=1584109
     data_reviews:
       - https://bugzilla.mozilla.org/show_bug.cgi?id=1584109#c1
     notification_emails:
       - gfx-telemetry-alerts@mozilla.com
@@ -175,18 +184,20 @@ gfx.content:
       - dbolter@mozilla.com
     expires: never
 
   full_paint_time:
     type: timing_distribution
     time_unit: millisecond
     gecko_datapoint: CONTENT_FULL_PAINT_TIME
     description: >
-      Time spent in the full paint pipeline for content until it's ready for composition.
-      For non-webrender this includes `paint_time`, plus rasterization if OMTP is enabled.
+      Time spent in the full paint pipeline for content until it's ready for
+      composition.
+      For non-webrender this includes `paint_time`, plus rasterization if OMTP
+      is enabled.
       For webrender, this includes `paint_time`, plus scene building time.
     bugs:
       - https://bugzilla.mozilla.org/show_bug.cgi?id=1505858
       - https://bugzilla.mozilla.org/show_bug.cgi?id=1584109
     data_reviews:
       - https://bugzilla.mozilla.org/show_bug.cgi?id=1584109#c1
     notification_emails:
       - gfx-telemetry-alerts@mozilla.com
@@ -198,18 +209,18 @@ gfx.content.frame_time:
   from_paint:
     type: custom_distribution
     range_max: 5000
     bucket_count: 50
     histogram_type: exponential
     unit: Percentage of vsync interval
     gecko_datapoint: CONTENT_FRAME_TIME
     description: >
-      The time, in percentage of a vsync interval, spent from beginning a paint in
-      the content process until that frame is presented in the compositor.
+      The time, in percentage of a vsync interval, spent from beginning a paint
+      in the content process until that frame is presented in the compositor.
     bugs:
       - https://bugzilla.mozilla.org/show_bug.cgi?id=1470528
       - https://bugzilla.mozilla.org/show_bug.cgi?id=1509536
       - https://bugzilla.mozilla.org/show_bug.cgi?id=1584109
     data_reviews:
       - https://bugzilla.mozilla.org/show_bug.cgi?id=1584109#c1
     notification_emails:
       - gfx-telemetry-alerts@mozilla.com
@@ -220,18 +231,19 @@ gfx.content.frame_time:
     type: custom_distribution
     range_min: 8
     range_max: 792
     bucket_count: 100
     histogram_type: linear
     unit: Percentage of vsync interval
     gecko_datapoint: CONTENT_FRAME_TIME_VSYNC
     description: >
-      The time, in percentage of a vsync interval, spent from the vsync that started a
-      paint in the content process until that frame is presented in the compositor.
+      The time, in percentage of a vsync interval, spent from the vsync that
+      started a paint in the content process until that frame is presented in
+      the compositor.
     bugs:
       - https://bugzilla.mozilla.org/show_bug.cgi?id=1517355
       - https://bugzilla.mozilla.org/show_bug.cgi?id=1584109
     data_reviews:
       - https://bugzilla.mozilla.org/show_bug.cgi?id=1584109#c1
     notification_emails:
       - gfx-telemetry-alerts@mozilla.com
       - mwoodrow@mozilla.com
@@ -240,19 +252,19 @@ gfx.content.frame_time:
   with_svg:
     type: custom_distribution
     range_max: 5000
     bucket_count: 50
     histogram_type: exponential
     unit: Percentage of vsync interval
     gecko_datapoint: CONTENT_FRAME_TIME_WITH_SVG
     description: >
-      The time, in percentage of a vsync interval, spent from beginning a paint in the
-      content process until that frame is presented in the compositor, for frames that
-      contained an SVG to be drawn by webrender.
+      The time, in percentage of a vsync interval, spent from beginning a paint
+      in the content process until that frame is presented in the compositor,
+      for frames that contained an SVG to be drawn by webrender.
     bugs:
       - https://bugzilla.mozilla.org/show_bug.cgi?id=1483549
       - https://bugzilla.mozilla.org/show_bug.cgi?id=1509536
       - https://bugzilla.mozilla.org/show_bug.cgi?id=1584109
     data_reviews:
       - https://bugzilla.mozilla.org/show_bug.cgi?id=1584109#c1
     notification_emails:
       - gfx-telemetry-alerts@mozilla.com
@@ -262,19 +274,19 @@ gfx.content.frame_time:
   without_resource_upload:
     type: custom_distribution
     range_max: 5000
     bucket_count: 50
     histogram_type: exponential
     unit: Percentage of vsync interval
     gecko_datapoint: CONTENT_FRAME_TIME_WITHOUT_RESOURCE_UPLOAD
     description: >
-      The time, in percentage of a vsync interval, spent from beginning a paint in the
-      content process until that frame is presented in the compositor by webrender,
-      excluding time spent uploading resources.
+      The time, in percentage of a vsync interval, spent from beginning a paint
+      in the content process until that frame is presented in the compositor by
+      webrender, excluding time spent uploading resources.
     bugs:
       - https://bugzilla.mozilla.org/show_bug.cgi?id=1503405
       - https://bugzilla.mozilla.org/show_bug.cgi?id=1584109
     data_reviews:
       - https://bugzilla.mozilla.org/show_bug.cgi?id=1584109#c1
     notification_emails:
       - gfx-telemetry-alerts@mozilla.com
       - mwoodrow@mozilla.com
@@ -283,19 +295,19 @@ gfx.content.frame_time:
   without_upload:
     type: custom_distribution
     range_max: 5000
     bucket_count: 50
     histogram_type: exponential
     unit: Percentage of vsync interval
     gecko_datapoint: CONTENT_FRAME_TIME_WITHOUT_UPLOAD
     description: >
-      The time, in percentage of a vsync interval, spent from beginning a paint in the
-      content process until that frame is presented in the compositor by webrender,
-      excluding time spent uploading any content.
+      The time, in percentage of a vsync interval, spent from beginning a paint
+      in the content process until that frame is presented in the compositor by
+      webrender, excluding time spent uploading any content.
     bugs:
       - https://bugzilla.mozilla.org/show_bug.cgi?id=1503405
       - https://bugzilla.mozilla.org/show_bug.cgi?id=1584109
     data_reviews:
       - https://bugzilla.mozilla.org/show_bug.cgi?id=1584109#c1
     notification_emails:
       - gfx-telemetry-alerts@mozilla.com
       - mwoodrow@mozilla.com
@@ -309,17 +321,18 @@ gfx.content.frame_time:
       - missed_composite
       - slow_composite
       - missed_composite_mid
       - missed_composite_long
       - missed_composite_low
       - no_vsync_no_id
     gecko_datapoint: CONTENT_FRAME_TIME_REASON
     description: >
-      The reason that `gfx.content.frame_time.from_paint` recorded a slow (>200ms) result, if any.
+      The reason that `gfx.content.frame_time.from_paint` recorded a slow
+      (>200ms) result, if any.
     bugs:
       - https://bugzilla.mozilla.org/show_bug.cgi?id=1510853
       - https://bugzilla.mozilla.org/show_bug.cgi?id=1584109
     data_reviews:
       - https://bugzilla.mozilla.org/show_bug.cgi?id=1584109#c1
     notification_emails:
       - gfx-telemetry-alerts@mozilla.com
       - mwoodrow@mozilla.com
@@ -344,36 +357,37 @@ gfx.webrender:
       - kgupta@mozilla.com
     expires: never
 
   sceneswap_time:
     type: timing_distribution
     time_unit: millisecond
     gecko_datapoint: WR_SCENESWAP_TIME
     description: >
-      The time taken to do a webrender scene swap. This is book-keeping that APZ must
-      perform once webrender has built a new scene.
+      The time taken to do a webrender scene swap. This is book-keeping that
+      APZ must perform once webrender has built a new scene.
     bugs:
       - https://bugzilla.mozilla.org/show_bug.cgi?id=1470901
       - https://bugzilla.mozilla.org/show_bug.cgi?id=1584109
     data_reviews:
       - https://bugzilla.mozilla.org/show_bug.cgi?id=1584109#c1
     notification_emails:
       - gfx-telemetry-alerts@mozilla.com
       - kgupta@mozilla.com
     expires: never
 
   framebuild_time:
     type: timing_distribution
     time_unit: millisecond
     gecko_datapoint: WR_FRAMEBUILD_TIME
     description: >
       The time taken to build a webrender frame.
-      This involves calculating the visibility of primitives, requesting resources,
-      and building the render passes which will be used to render the frame.
+      This involves calculating the visibility of primitives, requesting
+      resources, and building the render passes which will be used to render
+      the frame.
     bugs:
       - https://bugzilla.mozilla.org/show_bug.cgi?id=1470901
       - https://bugzilla.mozilla.org/show_bug.cgi?id=1584109
     data_reviews:
       - https://bugzilla.mozilla.org/show_bug.cgi?id=1584109#c1
     notification_emails:
       - gfx-telemetry-alerts@mozilla.com
       - kgupta@mozilla.com