Add UKM metrics for rendering timing measurements

UKM review: https://docs.google.com/document/d/1Cpe5kLi3tVshH3evoJVUVDjOw7le-f8jFwBjEk2uadY/edit

Bug: 783383
Change-Id: Ib684e9e07322e27633b33576c688fa699fada81e
Reviewed-on: https://chromium-review.googlesource.com/812154Reviewed-by: Alexei Svitkine <asvitkine@chromium.org>
Reviewed-by: Chris Harrelson <chrishtr@chromium.org>
Commit-Queue: Christian Biesinger <cbiesinger@chromium.org>
Cr-Commit-Position: refs/heads/master@{#532051}

services/metrics/public/cpp/ukm_recorder.h

@@ -40,6 +40,7 @@ class BasePredictor;
 namespace blink {
 class AutoplayUmaHelper;
 class Document;
+class LocalFrameView;
 }
 
 namespace cc {
@@ -147,6 +148,7 @@ class METRICS_EXPORT UkmRecorder {
   friend previews::PreviewsUKMObserver;
   friend translate::TranslateRankerImpl;
   friend ui::LatencyTracker;
+  friend blink::LocalFrameView;
   FRIEND_TEST_ALL_PREFIXES(UkmServiceTest, AddEntryWithEmptyMetrics);
   FRIEND_TEST_ALL_PREFIXES(UkmServiceTest, EntryBuilderAndSerialization);
   FRIEND_TEST_ALL_PREFIXES(UkmServiceTest,

third_party/WebKit/Source/core/frame/LocalFrameView.cpp

@@ -128,6 +128,9 @@
 #include "public/platform/WebDisplayItemList.h"
 #include "public/platform/WebRect.h"
 #include "public/platform/WebScrollIntoViewParams.h"
+#include "services/metrics/public/cpp/ukm_builders.h"
+#include "services/metrics/public/cpp/ukm_entry_builder.h"
+#include "services/metrics/public/cpp/ukm_recorder.h"
 #include "third_party/WebKit/common/page/page_visibility_state.mojom-blink.h"
 
 // Used to check for dirty layouts violating document lifecycle rules.
@@ -153,6 +156,42 @@ constexpr int kLetterPortraitPageHeight = 792;
 }  // namespace
 
 namespace blink {
+namespace {
+
+class ScopedUsHistogramAndUkmTimer {
+  STACK_ALLOCATED();
+
+ public:
+  explicit ScopedUsHistogramAndUkmTimer(LocalFrameView* view,
+                                        CustomCountHistogram& counter,
+                                        const char* ukm_metric)
+      : view_(view),
+        start_time_(CurrentTimeTicks()),
+        counter_(&counter),
+        ukm_metric_(ukm_metric) {}
+
+  ~ScopedUsHistogramAndUkmTimer() {
+    int64_t elapsed = (CurrentTimeTicks() - start_time_).InMicroseconds();
+    counter_->Count(elapsed);
+    view_->RecordUkmPerformanceMetric(ukm_metric_, elapsed);
+  }
+
+ private:
+  Member<LocalFrameView> view_;
+  const TimeTicks start_time_;
+  CustomCountHistogram* counter_;
+  const char* ukm_metric_;
+
+  DISALLOW_COPY_AND_ASSIGN(ScopedUsHistogramAndUkmTimer);
+};
+
+#define SCOPED_UMA_AND_UKM_TIMER(uma_name, ukm_name)                \
+  DEFINE_STATIC_LOCAL_IMPL(CustomCountHistogram, scoped_us_counter, \
+                           (uma_name, 0, 10000000, 50), false);     \
+  ScopedUsHistogramAndUkmTimer timer(this, scoped_us_counter, ukm_name);
+
+}  // namespace
+
 using namespace HTMLNames;
 
 // The maximum number of updatePlugins iterations that should be done before
@@ -3279,7 +3318,7 @@ void LocalFrameView::PrePaint() {
   });
 
   {
-    SCOPED_BLINK_UMA_HISTOGRAM_TIMER("Blink.PrePaint.UpdateTime");
+    SCOPED_UMA_AND_UKM_TIMER("Blink.PrePaint.UpdateTime", "PrePaint");
     PrePaintTreeWalk().Walk(*this);
   }
 
@@ -3290,7 +3329,7 @@ void LocalFrameView::PrePaint() {
 
 void LocalFrameView::PaintTree() {
   TRACE_EVENT0("blink", "LocalFrameView::paintTree");
-  SCOPED_BLINK_UMA_HISTOGRAM_TIMER("Blink.Paint.UpdateTime");
+  SCOPED_UMA_AND_UKM_TIMER("Blink.Paint.UpdateTime", "Paint");
 
   DCHECK(GetFrame() == GetPage()->MainFrame() ||
          (!GetFrame().Tree().Parent()->IsLocalFrame()));
@@ -3373,7 +3412,7 @@ void LocalFrameView::PushPaintArtifactToCompositor(
         paint_artifact_compositor_->GetWebLayer(), &GetFrame());
   }
 
-  SCOPED_BLINK_UMA_HISTOGRAM_TIMER("Blink.Compositing.UpdateTime");
+  SCOPED_UMA_AND_UKM_TIMER("Blink.Compositing.UpdateTime", "Compositing");
 
   paint_artifact_compositor_->Update(paint_controller_->GetPaintArtifact(),
                                      composited_element_ids);
@@ -3388,7 +3427,7 @@ std::unique_ptr<JSONObject> LocalFrameView::CompositedLayersAsJSON(
 }
 
 void LocalFrameView::UpdateStyleAndLayoutIfNeededRecursive() {
-  SCOPED_BLINK_UMA_HISTOGRAM_TIMER("Blink.StyleAndLayout.UpdateTime");
+  SCOPED_UMA_AND_UKM_TIMER("Blink.StyleAndLayout.UpdateTime", "StyleAndLayout");
   UpdateStyleAndLayoutIfNeededRecursiveInternal();
 }
 
@@ -5710,4 +5749,14 @@ ScrollbarTheme& LocalFrameView::GetPageScrollbarTheme() const {
   return page->GetScrollbarTheme();
 }
 
+void LocalFrameView::RecordUkmPerformanceMetric(const char* metric_name,
+                                                int64_t value) {
+  ukm::UkmRecorder* ukm_recorder = frame_->GetDocument()->UkmRecorder();
+  DCHECK(ukm_recorder);
+
+  std::unique_ptr<ukm::UkmEntryBuilder> builder = ukm_recorder->GetEntryBuilder(
+      frame_->GetDocument()->UkmSourceID(), "Blink.UpdateTime");
+  builder->AddMetric(metric_name, value);
+}
+
 }  // namespace blink

third_party/WebKit/Source/core/frame/LocalFrameView.h

@@ -964,6 +964,11 @@ class CORE_EXPORT LocalFrameView final
   // scrollable area, or gains/loses a composited layer.
   void ScrollableAreasDidChange();
 
+  // Records a UKM metric for the current URL. metric_name is a metric
+  // that must be defined in ukm.xml; metric_value is in usec.
+  void RecordUkmPerformanceMetric(const char* metric_name,
+                                  int64_t metric_value);
+
  protected:
   // Scroll the content via the compositor.
   bool ScrollContentsFastPath(const IntSize& scroll_delta);

tools/metrics/ukm/ukm.xml

@@ -2583,4 +2583,31 @@ be describing additional metrics about the same event.
   </metric>
 </event>
 
+<event name="Blink.UpdateTime">
+  <owner>chrishtr@chromium.org</owner>
+  <summary>
+    Records various rendering performance metrics (in microseconds).
+  </summary>
+  <metric name="Compositing">
+    <summary>
+      Time taken by the compositing phase in microseconds.
+    </summary>
+  </metric>
+  <metric name="Paint">
+    <summary>
+      Time taken by the compositing phase in microseconds.
+    </summary>
+  </metric>
+  <metric name="PrePaint">
+    <summary>
+      Time taken by the pre-paint phase in microseconds.
+    </summary>
+  </metric>
+  <metric name="StyleAndLayout">
+    <summary>
+      Time taken by the style and layout phases in microseconds.
+    </summary>
+  </metric>
+</event>
+
 </ukm-configuration>