[PageLoadMetrics] Keep track of Ad Sizes on Pages

tools/metrics/histograms/histograms.xml

Index: tools/metrics/histograms/histograms.xml
diff --git a/tools/metrics/histograms/histograms.xml b/tools/metrics/histograms/histograms.xml
index 3693d2ee9ed282d95217f401b2e437f21882fa46..2c1011e52baa9983ba22e37e015b40f48831eef9 100644
--- a/tools/metrics/histograms/histograms.xml
+++ b/tools/metrics/histograms/histograms.xml
@@ -46700,6 +46700,247 @@ http://cs/file:chrome/histograms.xml - but prefer this file for new entries.
   </summary>
 </histogram>
 
+<histogram name="PageLoad.Clients.Ads.Google.Bytes.AdFrames.Aggregate.Network"
+    units="KB">
+  <owner>jkarlin@chromium.org</owner>
+  <summary>
+    The size (in KB) of the resources loaded for all of the ad frames on the
+    page that loaded over the network.
+
+    Only recorded if the page has at least one identified ad frame. Bytes are
+    measured as over-the-wire (e.g., compressed) response body KBs and do not
+    include header bytes. An ad frame consists of the identified ad frame and
+    all of its children (which may also be ads, but are counted as part of the
+    ancestor ad frame).
+  </summary>
+</histogram>
+
+<histogram
+    name="PageLoad.Clients.Ads.Google.Bytes.AdFrames.Aggregate.PercentNetwork"
+    units="%">
+  <owner>jkarlin@chromium.org</owner>
+  <summary>
+    The percentage of bytes loaded for all ad frames that were loaded over the
+    network.
+
+    Only recorded if the page has at least one identified ad frame. Bytes are
+    measured as over-the-wire (e.g., compressed) response body KBs and do not
+    include header bytes. An ad frame consists of the identified ad frame and
+    all of its children (which may also be ads, but are counted as part of the
+    ancestor ad frame).
+  </summary>
+</histogram>
+
+<histogram name="PageLoad.Clients.Ads.Google.Bytes.AdFrames.Aggregate.Total"
+    units="KB">
+  <owner>jkarlin@chromium.org</owner>
+  <summary>
+    The size (in KB) of the resources loaded for all of the ad frames on the
+    page.
+
+    Only recorded if the page has at least one identified ad frame. Bytes are
+    measured as over-the-wire (e.g., compressed) response body KBs and do not
+    include header bytes. An ad frame consists of the identified ad frame and
+    all of its children (which may also be ads, but are counted as part of the
+    ancestor ad frame).
+  </summary>
+</histogram>
+
+<histogram name="PageLoad.Clients.Ads.Google.Bytes.AdFrames.PerFrame.Network"
+    units="KB">
+  <owner>jkarlin@chromium.org</owner>
+  <summary>
+    The size (in KB) of the resources loaded for an ad frame from the network.
+
+    Only recorded if the page has at least one identified ad frame. Bytes are
+    measured as over-the-wire (e.g., compressed) response body KBs and do not
+    include header bytes. An ad frame consists of the identified ad frame and
+    all of its children (which may also be ads, but are counted as part of the
+    ancestor ad frame).
+  </summary>
+</histogram>
+
+<histogram
+    name="PageLoad.Clients.Ads.Google.Bytes.AdFrames.PerFrame.PercentNetwork"
+    units="%">
+  <owner>jkarlin@chromium.org</owner>
+  <summary>
+    The percentage of bytes loaded for a single ad frame that were loaded over
+    the network.
+
+    Only recorded if the page has at least one identified ad frame. Bytes are
+    measured as over-the-wire (e.g., compressed) response body KBs and do not
+    include header bytes. An ad frame consists of the identified ad frame and
+    all of its children (which may also be ads, but are counted as part of the
+    ancestor ad frame).
+  </summary>
+</histogram>
+
+<histogram name="PageLoad.Clients.Ads.Google.Bytes.AdFrames.PerFrame.Total"
+    units="KB">
+  <owner>jkarlin@chromium.org</owner>
+  <summary>
+    The size (in KB) of the resources loaded for an ad frame.
+
+    Only recorded if the page has at least one identified ad frame. Bytes are
+    measured as over-the-wire (e.g., compressed) response body KBs and do not
+    include header bytes. An ad frame consists of the identified ad frame and
+    all of its children (which may also be ads, but are counted as part of the
+    ancestor ad frame).

[Ilya Sherman, 2017/04/28 22:57:19]

Optional: Note that this paragraph is repeated verbatim across eight histograms;
and the first two sentences across two additional ones as well.  I think that
histogram_suffixes could help reduce this repetition while still giving the
metrics a clear structure.  That said, if you prefer to duplicate the text,
that's fine too.

[jkarlin, 2017/05/02 18:20:52]

Acknowledged.

+  </summary>
+</histogram>
+
+<histogram name="PageLoad.Clients.Ads.Google.Bytes.FullPage.Network" units="KB">
+  <owner>jkarlin@chromium.org</owner>
+  <summary>
+    The size (in KB) of all of the page's resources that loaded over the
+    network.
+
+    Only recorded if the page has at least one identified ad frame. Bytes are
+    measured as over-the-wire (e.g., compressed) response body KBs and do not
+    include header bytes.
+  </summary>
+</histogram>
+
+<histogram name="PageLoad.Clients.Ads.Google.Bytes.FullPage.Network.PercentAds"
+    units="%">
+  <owner>jkarlin@chromium.org</owner>
+  <summary>
+    The percentage of bytes loaded for the page (from the network) that came
+    from resource loads in ad frames (from the network).
+
+    Only recorded if the page has at least one identified ad frame. Bytes are
+    measured as over-the-wire (e.g., compressed) response body KBs and do not
+    include header bytes. An ad frame consists of the identified ad frame and
+    all of its children (which may also be ads, but are counted as part of the
+    ancestor ad frame).
+  </summary>
+</histogram>
+
+<histogram name="PageLoad.Clients.Ads.Google.Bytes.FullPage.Total" units="KB">
+  <owner>jkarlin@chromium.org</owner>
+  <summary>
+    The size (in KB) of all of the page's resources.
+
+    Only recorded if the page has at least one identified ad frame. Bytes are
+    measured as over-the-wire (e.g., compressed) response body KBs and do not
+    include header bytes.
+  </summary>
+</histogram>
+
+<histogram name="PageLoad.Clients.Ads.Google.Bytes.FullPage.Total.PercentAds"
+    units="%">
+  <owner>jkarlin@chromium.org</owner>
+  <summary>
+    The percentage of bytes loaded for the page that came from resource loads in
+    ad frames.
+
+    Only recorded if the page has at least one identified ad frame. Bytes are
+    measured as over-the-wire (e.g., compressed) response body KBs and do not
+    include header bytes. An ad frame consists of the identified ad frame and
+    all of its children (which may also be ads, but are counted as part of the
+    ancestor ad frame).
+  </summary>
+</histogram>
+
+<histogram name="PageLoad.Clients.Ads.Google.Bytes.NonAdFrames.Aggregate.Total"
+    units="KB">
+  <owner>jkarlin@chromium.org</owner>
+  <summary>
+    The size (in KB) of all of the page's resources except for those loaded in
+    ad frames.
+
+    Only recorded if the page has at least one identified ad frame. Bytes are
+    measured as over-the-wire (e.g., compressed) response body KBs and do not
+    include header bytes. An ad frame consists of the identified ad frame and
+    all of its children (which may also be ads, but are counted as part of the
+    ancestor ad frame).
+  </summary>
+</histogram>
+
+<histogram
+    name="PageLoad.Clients.Ads.Google.FrameCounts.AnyParentFrame.AdFrames"
+    units="Ad frames">
+  <owner>jkarlin@chromium.org</owner>
+  <summary>
+    The number of frames on the page identified as Google Ad Frames.
+
+    For pages with zero ad frames, the other PageLoad.Clients.Ads metrics are
+    not recorded unless otherwise specified.
+
+    Child frames of an ad frame are not included in the count.
+  </summary>
+</histogram>
+
+<histogram
+    name="PageLoad.Clients.Ads.Google.FrameCounts.MainFrameParent.AdFrames"
+    units="Frames">
+  <owner>jkarlin@chromium.org</owner>
+  <summary>
+    The number of frames (with parent frame of main frame) that are on the page
+    identified as Google Ad Frames.
+
+    Only recorded if the page has at least one identified ad frame. Child frames
+    of an ad frame are not included in the count.
+  </summary>
+</histogram>
+
+<histogram
+    name="PageLoad.Clients.Ads.Google.FrameCounts.MainFrameParent.PercentAdFrames"
+    units="%">
+  <owner>jkarlin@chromium.org</owner>
+  <summary>
+    The percentage of frames (with parent frame of main frame) on the page that
+    are identified as Google Ad Frames.
+
+    Only recorded if the page has at least one identified ad frame. An ad frame
+    consists of the identified ad frame and all of its children (which may also
+    be ads, but are counted as part of the ancestor ad frame).
+  </summary>
+</histogram>
+
+<histogram
+    name="PageLoad.Clients.Ads.Google.FrameCounts.MainFrameParent.TotalFrames"
+    units="Frames">
+  <owner>jkarlin@chromium.org</owner>
+  <summary>
+    The number of frames (with parent frame of main frame) on the page.
+
+    Only recorded if the page has at least one identified ad frame.
+  </summary>
+</histogram>
+
+<histogram
+    name="PageLoad.Clients.Ads.Google.Navigations.AdFrameRenavigatedToAd"
+    enum="DidNavigateToAd">
+  <owner>jkarlin@chromium.org</owner>
+  <summary>
+    When a frame that is (or previously was) an ad frame renavigates, record
+    whether it renavigated to an ad frame or a non-ad frame.
+
+    An ad frame consists of the identified ad frame and all of its children. Its
+    children (which may also be ads) are not counted when they renavigate.
+
+    This metric is recorded as the event happens. Note that this is unlike most
+    other Clients.Ads metrics, which are recorded when the page load is
+    complete.
+  </summary>
+</histogram>
+
+<histogram
+    name="PageLoad.Clients.Ads.Google.Navigations.NonAdFrameRenavigatedToAd"
+    enum="DidNavigateToAd">
+  <owner>jkarlin@chromium.org</owner>
+  <summary>
+    When a frame that has never been part of an ad frame renavigates, record
+    whether it renavigated to an ad frame or a non-ad frame.
+
+    This metric is recorded as the event happens. Note that this is unlike most
+    other Clients.Ads metrics, which are recorded when the page load is
+    complete.
+  </summary>
+</histogram>
+
 <histogram
     name="PageLoad.Clients.DataReductionProxy.Experimental.Bytes.Network.CompressionRatio"
     units="%">
@@ -89678,6 +89919,11 @@ http://cs/file:chrome/histograms.xml - but prefer this file for new entries.
   <int value="18" label="IME Warning (Activation)"/>
 </enum>
 
+<enum name="DidNavigateToAd" type="int">
+  <int value="0" label="Navigated to Non-Ad"/>
+  <int value="1" label="Navigated to Ad"/>
+</enum>
+
 <enum name="DifferentPrimaryAccounts" type="int">
   <int value="0" label="Primary Accounts the same"/>
   <int value="1" label="(obsolete) Primary Accounts different"/>