Add UKM for ScrollingCoordinator.

ScrollingCoordinator accounts for some of the time in MainFrame
update time. Record how much.

As a side effect, move the macro for local frame UKM scoped recording
into the aggregator class so that it can be shared across classes.
This is to avoid relocating the UMA metric recording site in a way that
would skew the data toward zero, a lot.

R=pdr@chromium.org,rkaplow@chromium.org
BUG=910635

Change-Id: Id527efb7f30cc69de8ee45e27c616621059ef544
Reviewed-on: https://chromium-review.googlesource.com/c/1356888
Commit-Queue: Stephen Chenney <schenney@chromium.org>
Reviewed-by: Philip Rogers <pdr@chromium.org>
Reviewed-by: Robert Kaplow <rkaplow@chromium.org>
Cr-Commit-Position: refs/heads/master@{#612880}

third_party/blink/renderer/core/frame/local_frame_ukm_aggregator.h

@@ -18,8 +18,8 @@ class CustomCountHistogram;
 
 // This class aggregaties and records time based UKM and UMA metrics
 // for LocalFrameView. The simplest way to use it is via the
-// SCOPED_UMA_AND_UKM_HIERARCHICAL_TIMER macro in LocalFrameView combined
-// with LocalFrameView::RecordEndOfFrameMetrics.
+// SCOPED_UMA_AND_UKM_TIMER macro combined with
+// LocalFrameView::RecordEndOfFrameMetrics.
 //
 // It takes the following constructor parameters:
 // - source_id: UKM Source ID associated with the events.
@@ -42,7 +42,7 @@ class CustomCountHistogram;
 //
 // When the primary timed execution completes, this aggregator stores the
 // primary time and computes metrics that depend on it. The results are
-// aggregated.  UMA metrics are updated at this time. A UKM event is
+// aggregated. UMA metrics are updated at this time. A UKM event is
 // generated in one of two situations:
 //  - If a sample is added that lies in the next event frequency interval (this
 //    will generate an event for the previous interval)
@@ -52,7 +52,7 @@ class CustomCountHistogram;
 // Note that no event is generated if there were no primary samples in an
 // interval.
 //
-// Sample usage (see also SCOPED_UMA_AND_UKM_HIERARCHICAL_TIMER):
+// Sample usage (see also SCOPED_UMA_AND_UKM_TIMER):
 //   std::unique_ptr<UkmHierarchicalTimeAggregator> aggregator(
 //      new UkmHierarchicalTimeAggregator(
 //              GetSourceId(),
@@ -101,6 +101,23 @@ class CustomCountHistogram;
 //
 // If the source_id/recorder changes then a new
 // UkmHierarchicalTimeAggregator has to be created.
+// Defines a UKM that is part of a hierarchical ukm, recorded in
+// microseconds equal to the duration of the current lexical scope after
+// declaration of the macro. Example usage:
+//
+// void LocalFrameView::DoExpensiveThing() {
+//   SCOPED_UMA_AND_UKM_TIMER(kUkmEnumName);
+//   // Do computation of expensive thing
+//
+// }
+//
+// |ukm_enum| should be an entry in LocalFrameUkmAggregator's enum of
+// metric names (which in turn corresponds to names in from ukm.xml).
+
+#define SCOPED_UMA_AND_UKM_TIMER(aggregator, ukm_enum) \
+  auto scoped_ukm_hierarchical_timer =                 \
+      aggregator.GetScopedTimer(static_cast<size_t>(ukm_enum));
+
 class CORE_EXPORT LocalFrameUkmAggregator {
  public:
   // Changing these values requires changing the names of metrics specified
@@ -114,6 +131,7 @@ class CORE_EXPORT LocalFrameUkmAggregator {
     kPrePaint,
     kStyleAndLayout,
     kForcedStyleAndLayout,
+    kScrollingCoordinator,
     kCount
   };
 
@@ -123,9 +141,15 @@ class CORE_EXPORT LocalFrameUkmAggregator {
   // Add an entry in this arrray every time a new metric is added.
   static const Vector<String>& metric_strings() {
     // Leaky construction to avoid exit-time destruction.
-    static const Vector<String>* strings = new Vector<String>{
-        "Compositing", "CompositingCommit", "IntersectionObservation", "Paint",
-        "PrePaint",    "StyleAndLayout",    "ForcedStyleAndLayout"};
+    static const Vector<String>* strings =
+        new Vector<String>{"Compositing",
+                           "CompositingCommit",
+                           "IntersectionObservation",
+                           "Paint",
+                           "PrePaint",
+                           "StyleAndLayout",
+                           "ForcedStyleAndLayout",
+                           "ScrollingCoordinator"};
     return *strings;
   }
 

third_party/blink/renderer/core/frame/local_frame_ukm_aggregator_test.cc

@@ -123,6 +123,8 @@ TEST_F(LocalFrameUkmAggregatorTest, EventsRecordedPerSecond) {
   auto entries = recorder().GetEntriesByName("Blink.UpdateTime");
   EXPECT_EQ(entries.size(), 4u);
 
+  float expected_average_ratio =
+      floor(100.0 / (float)LocalFrameUkmAggregator::kCount);
   for (auto* entry : entries) {
     for (int i = 0; i < LocalFrameUkmAggregator::kCount; ++i) {
       EXPECT_TRUE(
@@ -142,7 +144,7 @@ TEST_F(LocalFrameUkmAggregatorTest, EventsRecordedPerSecond) {
       const int64_t* metric1_average_ratio =
           ukm::TestUkmRecorder::GetEntryMetric(entry,
                                                GetAverageRatioMetricName(i));
-      EXPECT_NEAR(*metric1_average_ratio, 14.0, 0.001);
+      EXPECT_NEAR(*metric1_average_ratio, expected_average_ratio, 0.001);
 
       EXPECT_TRUE(ukm::TestUkmRecorder::EntryHasMetric(
           entry, GetWorstCaseRatioMetricName(i)));

third_party/blink/renderer/core/frame/local_frame_view.cc

@@ -193,22 +193,6 @@ void LogCursorSizeCounter(LocalFrame* frame, const Cursor& cursor) {
 
 }  // namespace
 
-// Defines a UKM that is part of a hierarchical ukm, recorded in
-// microseconds equal to the duration of the current lexical scope after
-// declaration of the macro. Example usage:
-//
-// void LocalFrameView::DoExpensiveThing() {
-//   SCOPED_UMA_AND_UKM_TIMER(kUkmEnumName);
-//   // Do computation of expensive thing
-//
-// }
-//
-// |ukm_enum| should be an entry in LocalFrameUkmAggregator's enum of
-// metric names (which in turn corresponds to names in from ukm.xml).
-#define SCOPED_UMA_AND_UKM_TIMER(ukm_enum) \
-  auto scoped_ukm_hierarchical_timer =     \
-      EnsureUkmAggregator().GetScopedTimer(static_cast<size_t>(ukm_enum));
-
 // The maximum number of updatePlugins iterations that should be done before
 // returning.
 static const unsigned kMaxUpdatePluginsIterations = 2;
@@ -2394,7 +2378,8 @@ bool LocalFrameView::UpdateLifecyclePhases(
   if (target_state == DocumentLifecycle::kPaintClean) {
     TRACE_EVENT0("blink,benchmark",
                  "LocalFrameView::UpdateViewportIntersectionsForSubtree");
-    SCOPED_UMA_AND_UKM_TIMER(LocalFrameUkmAggregator::kIntersectionObservation);
+    SCOPED_UMA_AND_UKM_TIMER(EnsureUkmAggregator(),
+                             LocalFrameUkmAggregator::kIntersectionObservation);
     UpdateViewportIntersectionsForSubtree();
   }
 
@@ -2451,7 +2436,8 @@ bool LocalFrameView::RunStyleAndLayoutLifecyclePhases(
   TRACE_EVENT0("blink,benchmark",
                "LocalFrameView::RunStyleAndLayoutLifecyclePhases");
   {
-    SCOPED_UMA_AND_UKM_TIMER(LocalFrameUkmAggregator::kStyleAndLayout);
+    SCOPED_UMA_AND_UKM_TIMER(EnsureUkmAggregator(),
+                             LocalFrameUkmAggregator::kStyleAndLayout);
     UpdateStyleAndLayoutIfNeededRecursive();
   }
   DCHECK(Lifecycle().GetState() >= DocumentLifecycle::kLayoutClean);
@@ -2518,7 +2504,8 @@ bool LocalFrameView::RunCompositingLifecyclePhase(
   DCHECK(layout_view);
 
   if (!RuntimeEnabledFeatures::CompositeAfterPaintEnabled()) {
-    SCOPED_UMA_AND_UKM_TIMER(LocalFrameUkmAggregator::kCompositing);
+    SCOPED_UMA_AND_UKM_TIMER(EnsureUkmAggregator(),
+                             LocalFrameUkmAggregator::kCompositing);
     layout_view->Compositor()->UpdateIfNeededRecursive(target_state);
   } else {
     ForAllNonThrottledLocalFrameViews([](LocalFrameView& frame_view) {
@@ -2562,7 +2549,8 @@ bool LocalFrameView::RunPrePaintLifecyclePhase(
   });
 
   {
-    SCOPED_UMA_AND_UKM_TIMER(LocalFrameUkmAggregator::kPrePaint);
+    SCOPED_UMA_AND_UKM_TIMER(EnsureUkmAggregator(),
+                             LocalFrameUkmAggregator::kPrePaint);
 
     PrePaintTreeWalk().WalkTree(*this);
   }
@@ -2788,7 +2776,8 @@ static void PaintGraphicsLayerRecursively(GraphicsLayer* layer) {
 }
 
 void LocalFrameView::PaintTree() {
-  SCOPED_UMA_AND_UKM_TIMER(LocalFrameUkmAggregator::kPaint);
+  SCOPED_UMA_AND_UKM_TIMER(EnsureUkmAggregator(),
+                           LocalFrameUkmAggregator::kPaint);
 
   DCHECK(GetFrame().IsLocalRoot());
 
@@ -2929,7 +2918,8 @@ void LocalFrameView::PushPaintArtifactToCompositor(
         paint_artifact_compositor_->RootLayer(), &GetFrame());
   }
 
-  SCOPED_UMA_AND_UKM_TIMER(LocalFrameUkmAggregator::kCompositingCommit);
+  SCOPED_UMA_AND_UKM_TIMER(EnsureUkmAggregator(),
+                           LocalFrameUkmAggregator::kCompositingCommit);
 
   paint_artifact_compositor_->Update(
       paint_controller_->GetPaintArtifactShared(), composited_element_ids,

third_party/blink/renderer/core/frame/local_frame_view.h

@@ -690,6 +690,9 @@ class CORE_EXPORT LocalFrameView final
     return *paint_timing_detector_;
   }
 
+  // Return the UKM aggregator for this frame, creating it if necessary.
+  LocalFrameUkmAggregator& EnsureUkmAggregator();
+
  protected:
   void NotifyFrameRectsChangedIfNeeded();
 
@@ -832,8 +835,6 @@ class CORE_EXPORT LocalFrameView final
 
   void LayoutFromRootObject(LayoutObject& root);
 
-  LocalFrameUkmAggregator& EnsureUkmAggregator();
-
   LayoutSize size_;
 
   typedef HashSet<scoped_refptr<LayoutEmbeddedObject>> EmbeddedObjectSet;

third_party/blink/renderer/core/page/scrolling/scrolling_coordinator.cc

@@ -41,6 +41,7 @@
 #include "third_party/blink/renderer/core/frame/event_handler_registry.h"
 #include "third_party/blink/renderer/core/frame/local_dom_window.h"
 #include "third_party/blink/renderer/core/frame/local_frame.h"
+#include "third_party/blink/renderer/core/frame/local_frame_ukm_aggregator.h"
 #include "third_party/blink/renderer/core/frame/local_frame_view.h"
 #include "third_party/blink/renderer/core/frame/page_scale_constraints_set.h"
 #include "third_party/blink/renderer/core/frame/settings.h"
@@ -191,7 +192,8 @@ void ScrollingCoordinator::UpdateAfterPaint(LocalFrameView* frame_view) {
     return;
   }
 
-  SCOPED_BLINK_UMA_HISTOGRAM_TIMER("Blink.ScrollingCoordinator.UpdateTime");
+  SCOPED_UMA_AND_UKM_TIMER(frame_view->EnsureUkmAggregator(),
+                           LocalFrameUkmAggregator::kScrollingCoordinator);
   TRACE_EVENT0("input", "ScrollingCoordinator::UpdateAfterPaint");
 
   // TODO(pdr): Move the scroll gesture region logic to use touch action rects.

tools/metrics/ukm/ukm.xml

@@ -819,6 +819,40 @@ be describing additional metrics about the same event.
       the sample window. An int in the range [0,100].
     </summary>
   </metric>
+  <metric name="ScrollingCoordinator.Average">
+    <summary>
+      The average time taken by the style and layout phases in microseconds in
+      the event period.
+    </summary>
+    <aggregation>
+      <history>
+        <index fields="profile.country"/>
+        <statistics>
+          <quantiles type="std-percentiles"/>
+        </statistics>
+      </history>
+    </aggregation>
+  </metric>
+  <metric name="ScrollingCoordinator.AverageRatio">
+    <summary>
+      The average over frames within the event period of the ratio of time taken
+      to update the scrolling coordinator after painting to the total time for
+      the main frame, expressed as a percentage. An int in the range [0,100].
+    </summary>
+  </metric>
+  <metric name="ScrollingCoordinator.WorstCase">
+    <summary>
+      The longest single time within the event period that was used to update
+      the ScrollingCoordinator after painting (in microseconds).
+    </summary>
+  </metric>
+  <metric name="ScrollingCoordinator.WorstCaseRatio">
+    <summary>
+      The highest proportion of a frame within the event period that was used to
+      update the ScrollingCoordinator after painting, expressed as a percentage.
+      An int in the range [0,100].
+    </summary>
+  </metric>
   <metric name="StyleAndLayout.Average">
     <summary>
       The average time taken by the style and layout phases in microseconds in