tools/metrics/histograms/metadata/side_search/histograms.xml

<!--
Copyright 2021 The Chromium Authors
Use of this source code is governed by a BSD-style license that can be
found in the LICENSE file.
-->

<!--
This file is used to generate a comprehensive list of Side Search histograms
along with a detailed description for each histogram.

For best practices on writing histogram descriptions, see
https://chromium.googlesource.com/chromium/src.git/+/HEAD/tools/metrics/histograms/README.md

Please follow the instructions in the OWNERS file in this directory to find a
reviewer. If no OWNERS file exists, please consider signing up at
go/reviewing-metrics (Googlers only), as all subdirectories are expected to
have an OWNERS file. As a last resort you can send the CL to
chromium-metrics-reviews@google.com.
-->

<histogram-configuration>

<histograms>

<histogram
    name="SideSearch.AutoTrigger.NavigationCommittedWithinSideSearchCountPerJourney"
    units="navigations" expires_after="2023-06-18">
  <owner>yuhengh@chromium.org</owner>
  <owner>tluk@chromium.org</owner>
  <summary>
    Number of navigations committed within the side search panel a given side
    search journey started from an autotriggered side panel. Emitted when the
    current search journey ends (i.e. the side panel was explicitly closed by
    the user).
  </summary>
</histogram>

<histogram name="SideSearch.AutoTrigger.RedirectionToTabCountPerJourney"
    units="navigations" expires_after="2023-06-18">
  <owner>yuhengh@chromium.org</owner>
  <owner>tluk@chromium.org</owner>
  <summary>
    Number of navigations redirected to the tab from the side panel for side
    search journeys started from an autotriggered side panel. Emitted when the
    current search journey ends (i.e. the side panel was explicitly closed by
    the user).
  </summary>
</histogram>

<histogram name="SideSearch.AvailabilityChanged"
    enum="SideSearchAvailabilityChangeType" expires_after="2023-06-18">
  <owner>yuhengh@chromium.org</owner>
  <owner>tluk@chromium.org</owner>
  <owner>romanarora@chromium.org</owner>
  <summary>
    Denotes Side Search's availability. Recorded when side search becomes
    available or unavailable, more specifically when the side search button
    becomes visible or becomes invisible.
  </summary>
</histogram>

<histogram name="SideSearch.CloseAction" enum="SideSearchCloseActionType"
    expires_after="2023-04-16">
  <owner>yuhengh@chromium.org</owner>
  <owner>tluk@chromium.org</owner>
  <owner>romanarora@chromium.org</owner>
  <summary>
    The type of action taken to close Side Search. Recorded when side search
    panel is closed.
  </summary>
</histogram>

<histogram name="SideSearch.LoadCompletedTime" units="ms"
    expires_after="2023-06-18">
  <owner>yuhengh@chromium.org</owner>
  <owner>tluk@chromium.org</owner>
  <owner>romanarora@chromium.org</owner>
  <summary>
    The amount of time between the RenderFrameHost StartProvisionalLoad event
    and the RenderFrameHost DocumentOnLoadCompleted event for the Side Search
    Result Page. Recorded when DocumentOnLoadCompleted event triggered.
  </summary>
</histogram>

<histogram name="SideSearch.LoadDocumentTime" units="ms"
    expires_after="2023-06-18">
  <owner>yuhengh@chromium.org</owner>
  <owner>tluk@chromium.org</owner>
  <owner>romanarora@chromium.org</owner>
  <summary>
    The amount of time between the RenderFrameHost StartProvisionalLoad and
    DidFinishDocumentLoad events for the Side Search Result Page. Recorded when
    DidFinishDocumentLoad events triggered.
  </summary>
</histogram>

<histogram name="SideSearch.Navigation" enum="SideSearchNavigationType"
    expires_after="2023-06-18">
  <owner>yuhengh@chromium.org</owner>
  <owner>tluk@chromium.org</owner>
  <owner>romanarora@chromium.org</owner>
  <summary>
    The type of navigation of Side Search. Recorded when user clicks on a link
    from side search panel. It either navigates the link within the side search
    panel or redirects to the tab.
  </summary>
</histogram>

<histogram name="SideSearch.NavigationCommittedWithinSideSearchCountPerJourney"
    units="navigations" expires_after="2023-02-05">
  <obsolete>
    Removed in M107
  </obsolete>
  <owner>yuhengh@chromium.org</owner>
  <owner>tluk@chromium.org</owner>
  <owner>romanarora@chromium.org</owner>
  <summary>
    Number of navigations committed within the side search panel in the same
    side panel web contents for a given search journey. Recorded when the
    current search journey ends.
  </summary>
</histogram>

<histogram
    name="SideSearch.NavigationCommittedWithinSideSearchCountPerJourney2"
    units="navigations" expires_after="2023-06-11">
  <owner>yuhengh@chromium.org</owner>
  <owner>tluk@chromium.org</owner>
  <owner>romanarora@chromium.org</owner>
  <summary>
    The number of navigations committed within the side search panel for a given
    search journey. The search journey corresponds to the life of the side panel
    web contents. Emitted when the side panel WebContents is destroyed.
  </summary>
</histogram>

<histogram
    name="SideSearch.NavigationCommittedWithinSideSearchCountPerJourneyFromMenuOption"
    units="navigations" expires_after="2023-06-04">
  <owner>pengchaocai@chromium.org</owner>
  <owner>yuhengh@chromium.org</owner>
  <owner>tluk@chromium.org</owner>
  <summary>
    The number of navigations committed within the side search panel for a given
    search journey, if the side panel web contents is created from menu entry
    point. The search journey corresponds to the life of the side panel web
    contents. Emitted when the side panel WebContents is destroyed.
  </summary>
</histogram>

<histogram name="SideSearch.OpenAction" enum="SideSearchOpenActionType"
    expires_after="2023-06-11">
  <owner>yuhengh@chromium.org</owner>
  <owner>tluk@chromium.org</owner>
  <owner>romanarora@chromium.org</owner>
  <summary>
    The type of action taken to open Side Search. Recorded when side search
    panel is open.
  </summary>
</histogram>

<histogram name="SideSearch.PageActionIcon.LabelVisibleWhenToggled"
    enum="SideSearchPageActionLabelVisibility" expires_after="2023-02-12">
  <owner>yuhengh@chromium.org</owner>
  <owner>tluk@chromium.org</owner>
  <summary>
    This metric tracks whether the SideSearchIconView's label is visible when
    the page action is toggled. The label is considered visible if it is fully
    expanded as well as if it is animating in and out.
  </summary>
</histogram>

<histogram name="SideSearch.RedirectionToTabCountPerJourney2"
    units="navigations" expires_after="2023-02-05">
  <owner>yuhengh@chromium.org</owner>
  <owner>tluk@chromium.org</owner>
  <owner>romanarora@chromium.org</owner>
  <summary>
    Number of navigations redirected to the tab from the side panel for a given
    side search journeys. Emitted when the current search journey ends (i.e. the
    side panel was explicitly closed by the user).
  </summary>
</histogram>

<histogram name="SideSearch.RedirectionToTabCountPerJourneyFromMenuOption"
    units="navigations" expires_after="2023-06-04">
  <owner>pengchaocai@chromium.org</owner>
  <owner>yuhengh@chromium.org</owner>
  <owner>tluk@chromium.org</owner>
  <summary>
    Number of navigations redirected to the tab from the side panel for a given
    side search journeys, if the side panel web contents is created from menu
    entry point. Emitted when the current search journey ends (i.e. the side
    panel was explicitly closed by the user).
  </summary>
</histogram>

<histogram name="SideSearch.SidePanel.TimeShownOpenedVia{OpenAction}"
    units="ms" expires_after="2023-02-12">
  <owner>tluk@chromium.org</owner>
  <owner>yuhengh@chromium.org</owner>
  <summary>
    Tracks the duration that a given tab's side search side panel was open for
    when opened via a {OpenAction} action. This metric is emitted when the tab's
    side search side panel is hidden.
  </summary>
  <token key="OpenAction">
    <variant name="Entrypoint"/>
    <variant name="TabSwitch"/>
  </token>
</histogram>

<histogram name="SideSearch.TimeSinceSidePanelAvailableToFirstOpen" units="ms"
    expires_after="2023-06-25">
  <owner>yuhengh@chromium.org</owner>
  <owner>tluk@chromium.org</owner>
  <summary>
    The time interval between when the side panel is made available to when it
    is first opened for a given tab. Emitted for the active tab when the side
    panel is toggled open.
  </summary>
</histogram>

<histogram name="SideSearch.TimesReturnedBackToSRP" units="navigations"
    expires_after="2023-06-25">
  <owner>yuhengh@chromium.org</owner>
  <owner>tluk@chromium.org</owner>
  <summary>
    The number of times the user navigated back to the same search results page
    in a given tab's history. Emitted after the count is reset when the user
    navigates to a new search results page in a given tab.
  </summary>
</histogram>

</histograms>

</histogram-configuration>