<!--
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
[email protected].
-->
<histogram-configuration>
<histograms>
<histogram
name="SideSearch.AutoTrigger.NavigationCommittedWithinSideSearchCountPerJourney"
units="navigations" expires_after="2023-12-13">
<owner>[email protected]</owner>
<owner>[email protected]</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-12-13">
<owner>[email protected]</owner>
<owner>[email protected]</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-12-13">
<owner>[email protected]</owner>
<owner>[email protected]</owner>
<owner>[email protected]</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.LoadCompletedTime" units="ms"
expires_after="2024-04-28">
<owner>[email protected]</owner>
<owner>[email protected]</owner>
<owner>[email protected]</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="2024-05-05">
<owner>[email protected]</owner>
<owner>[email protected]</owner>
<owner>[email protected]</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="2024-04-28">
<owner>[email protected]</owner>
<owner>[email protected]</owner>
<owner>[email protected]</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.NavigationCommittedWithinSideSearchCountPerJourney2"
units="navigations" expires_after="2023-12-13">
<owner>[email protected]</owner>
<owner>[email protected]</owner>
<owner>[email protected]</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="2024-02-11">
<owner>[email protected]</owner>
<owner>[email protected]</owner>
<owner>[email protected]</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.PageActionIcon.LabelVisibleWhenToggled"
enum="SideSearchPageActionLabelVisibility" expires_after="2023-12-13">
<owner>[email protected]</owner>
<owner>[email protected]</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-12-13">
<owner>[email protected]</owner>
<owner>[email protected]</owner>
<owner>[email protected]</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-12-13">
<owner>[email protected]</owner>
<owner>[email protected]</owner>
<owner>[email protected]</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.TimeSinceSidePanelAvailableToFirstOpen" units="ms"
expires_after="2024-04-28">
<owner>[email protected]</owner>
<owner>[email protected]</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="2024-06-30">
<owner>[email protected]</owner>
<owner>[email protected]</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>