chrome/renderer/page_load_histograms.h

   1 // Copyright (c) 2012 The Chromium Authors. All rights reserved.
   2 // Use of this source code is governed by a BSD-style license that can be
   3 // found in the LICENSE file.
   4
   5 #ifndef CHROME_RENDERER_PAGE_LOAD_HISTOGRAMS_H_
   6 #define CHROME_RENDERER_PAGE_LOAD_HISTOGRAMS_H_
   7
   8 #include "base/basictypes.h"
   9 #include "base/memory/weak_ptr.h"
  10 #include "content/public/renderer/render_view_observer.h"
  11
  12 namespace blink {
  13 class WebDataSource;
  14 }
  15
  16 namespace content {
  17 class DocumentState;
  18 }
  19
  20 class PageLoadHistograms : public content::RenderViewObserver {
  21  public:
  22   explicit PageLoadHistograms(content::RenderView* render_view);
  23   ~PageLoadHistograms() override;
  24
  25  private:
  26   // RenderViewObserver implementation.
  27   void FrameWillClose(blink::WebFrame* frame) override;
  28   void ClosePage() override;
  29   void DidUpdateLayout() override;
  30
  31   // Dump all page load histograms appropriate for the given frame.
  32   //
  33   // This method will only dump once-per-instance, so it is safe to call
  34   // multiple times.
  35   //
  36   // The time points we keep are
  37   //    request: time document was requested by user
  38   //    start: time load of document started
  39   //    commit: time load of document started
  40   //    finish_document: main document loaded, before onload()
  41   //    finish_all_loads: after onload() and all resources are loaded
  42   //    first_paint: first paint performed
  43   //    first_paint_after_load: first paint performed after load is finished
  44   //    begin: request if it was user requested, start otherwise
  45   //
  46   // It's possible for the request time not to be set, if a client
  47   // redirect had been done (the user never requested the page)
  48   // Also, it's possible to load a page without ever laying it out
  49   // so first_paint and first_paint_after_load can be 0.
  50   void Dump(blink::WebFrame* frame);
  51
  52   bool ShouldDump(blink::WebFrame* frame);
  53   void MaybeDumpFirstLayoutHistograms();
  54   void LogPageLoadTime(const content::DocumentState* load_times,
  55                        const blink::WebDataSource* ds) const;
  56
  57   bool dumped_first_layout_histograms_;
  58   base::WeakPtrFactory<PageLoadHistograms> weak_factory_;
  59
  60   DISALLOW_COPY_AND_ASSIGN(PageLoadHistograms);
  61 };
  62
  63 #endif  // CHROME_RENDERER_PAGE_LOAD_HISTOGRAMS_H_