File: gws_page_load_metrics_observer.h

package info (click to toggle)
chromium 139.0.7258.138-1
  • links: PTS, VCS
  • area: main
  • in suites: sid
  • size: 6,120,676 kB
  • sloc: cpp: 35,100,869; ansic: 7,163,530; javascript: 4,103,002; python: 1,436,920; asm: 946,517; xml: 746,709; pascal: 187,653; perl: 88,691; sh: 88,436; objc: 79,953; sql: 51,488; cs: 44,583; fortran: 24,137; makefile: 22,147; tcl: 15,277; php: 13,980; yacc: 8,984; ruby: 7,485; awk: 3,720; lisp: 3,096; lex: 1,327; ada: 727; jsp: 228; sed: 36
file content (160 lines) | stat: -rw-r--r-- 6,388 bytes parent folder | download | duplicates (5)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
// Copyright 2022 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#ifndef COMPONENTS_PAGE_LOAD_METRICS_GOOGLE_BROWSER_GWS_PAGE_LOAD_METRICS_OBSERVER_H_
#define COMPONENTS_PAGE_LOAD_METRICS_GOOGLE_BROWSER_GWS_PAGE_LOAD_METRICS_OBSERVER_H_

#include "components/google/core/common/google_util.h"
#include "components/page_load_metrics/browser/page_load_metrics_observer.h"
#include "content/public/browser/navigation_handle_timing.h"

namespace internal {
// Exposed for tests.

extern const char kHistogramGWSNavigationStartToFinalRequestStart[];
extern const char kHistogramGWSNavigationStartToFinalResponseStart[];
extern const char kHistogramGWSNavigationStartToFinalLoaderCallback[];
extern const char kHistogramGWSNavigationStartToFirstRequestStart[];
extern const char kHistogramGWSNavigationStartToFirstResponseStart[];
extern const char kHistogramGWSNavigationStartToFirstLoaderCallback[];
extern const char kHistogramGWSNavigationStartToOnComplete[];

extern const char kHistogramGWSConnectTimingFirstRequestDomainLookupDelay[];
extern const char kHistogramGWSConnectTimingFirstRequestConnectDelay[];
extern const char kHistogramGWSConnectTimingFirstRequestSslDelay[];
extern const char kHistogramGWSConnectTimingFinalRequestDomainLookupDelay[];
extern const char kHistogramGWSConnectTimingFinalRequestConnectDelay[];
extern const char kHistogramGWSConnectTimingFinalRequestSslDelay[];

extern const char kHistogramGWSAFTEnd[];
extern const char kHistogramGWSAFTStart[];

extern const char kHistogramGWSFirstContentfulPaint[];
extern const char kHistogramGWSLargestContentfulPaint[];
extern const char kHistogramGWSParseStart[];
extern const char kHistogramGWSConnectStart[];
extern const char kHistogramGWSDomainLookupStart[];
extern const char kHistogramGWSDomainLookupEnd[];

}  // namespace internal

class GWSPageLoadMetricsObserver
    : public page_load_metrics::PageLoadMetricsObserver {
 public:
  // The source of the navigation. Specifically keeps track of special cases
  // such as the navigtation started from NewTabPage, or if the navigation
  // started in the background.
  //
  // These values are persisted to logs. Entries should not be renumbered
  // and numeric values should never be reused.
  //
  // LINT.IfChange(NavigationSourceType)
  enum NavigationSourceType {
    kUnknown,
    kFromNewTabPage,
    kStartedInBackground,
    kStartedInBackgroundFromNewTabPage,
    kFromGWSPage,
    kStartedInBackgroundFromGWSPage,
    kMaxValue = kStartedInBackgroundFromGWSPage,
  };
  // LINT.ThenChange(//tools/metrics/histograms/metadata/page/enums.xml:NavigationSourceTypeEnum)

  // The state of the preconnect. Keeps track of the possible state of
  // preconnect before commit.
  //
  // These values are persisted to logs. Entries should not be renumbered
  // and numeric values should never be reused.
  //
  // LINT.IfChange(ConnectionReuseStatus)
  enum class ConnectionReuseStatus {
    kNonReuse,
    kDNSReused,
    kReused,
    kMaxValue = kReused,
  };
  // LINT.ThenChange(//tools/metrics/histograms/metadata/page/enums.xml:ConnectionReuseStatus)

  GWSPageLoadMetricsObserver();

  GWSPageLoadMetricsObserver(const GWSPageLoadMetricsObserver&) = delete;
  GWSPageLoadMetricsObserver& operator=(const GWSPageLoadMetricsObserver&) =
      delete;

  // page_load_metrics::PageLoadMetricsObserver implementation:
  ObservePolicy OnStart(content::NavigationHandle* navigation_handle,
                        const GURL& currently_committed_url,
                        bool started_in_foreground) override;
  ObservePolicy OnCommit(content::NavigationHandle* navigation_handle) override;

  ObservePolicy OnPrerenderStart(content::NavigationHandle* navigation_handle,
                                 const GURL& currently_committed_url) override;

  ObservePolicy OnFencedFramesStart(
      content::NavigationHandle* navigation_handle,
      const GURL& currently_committed_url) override;

  ObservePolicy FlushMetricsOnAppEnterBackground(
      const page_load_metrics::mojom::PageLoadTiming& timing) override;

  void OnFirstContentfulPaintInPage(
      const page_load_metrics::mojom::PageLoadTiming& timing) override;
  void OnParseStart(
      const page_load_metrics::mojom::PageLoadTiming& timing) override;
  void OnConnectStart(
      const page_load_metrics::mojom::PageLoadTiming& timing) override;
  void OnDomainLookupStart(
      const page_load_metrics::mojom::PageLoadTiming& timing) override;
  void OnDomainLookupEnd(
      const page_load_metrics::mojom::PageLoadTiming& timing) override;
  void OnComplete(
      const page_load_metrics::mojom::PageLoadTiming& timing) override;
  void OnCustomUserTimingMarkObserved(
      const std::vector<page_load_metrics::mojom::CustomUserTimingMarkPtr>&
          timings) override;

  // The methods below are only intended for use in testing.
  void SetIsFirstNavigationForTesting(bool is_first_navigation) {
    is_first_navigation_ = is_first_navigation;
  }

  void SetNewTabPageForTesting(bool is_new_tab_page) {
    source_type_ = kFromNewTabPage;
  }

 private:
  void LogMetricsOnComplete();
  void RecordNavigationTimingHistograms();
  void RecordLatencyHitograms(base::TimeTicks response_start_time);

  // Records the histograms required before commit. This is to ensure that we
  // are getting the metrics only for GWS navigations.
  void RecordPreCommitHistograms();

  // Records the histograms for possible connection reuse.
  void RecordConnectionReuseHistograms();

  virtual bool IsFromNewTabPage(
      content::NavigationHandle* navigation_handle) = 0;
  virtual bool IsBrowserStartupComplete() = 0;
  virtual bool IsIncognitoProfile() const = 0;
  std::string AddHistogramSuffix(const std::string& histogram_name);

  content::NavigationHandleTiming navigation_handle_timing_;

  bool is_first_navigation_ = false;
  bool was_cached_ = false;

  NavigationSourceType source_type_ = kUnknown;

  std::optional<base::TimeDelta> aft_start_time_;
  std::optional<base::TimeDelta> aft_end_time_;
  std::optional<base::TimeDelta> body_chunk_start_time_;
  std::optional<base::TimeDelta> header_chunk_start_time_;
  std::optional<base::TimeDelta> header_chunk_end_time_;

  int64_t navigation_id_;
};

#endif  // COMPONENTS_PAGE_LOAD_METRICS_GOOGLE_BROWSER_GWS_PAGE_LOAD_METRICS_OBSERVER_H_