<!--
Copyright 2023 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 Signin 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>
<variants name="UiSurface">
<variant name="ATX"/>
<variant name="CQ"/>
<variant name="PageEntities"/>
<variant name="PH"/>
<variant name="PHResult"/>
<variant name="RegionSearch"/>
<variant name="RelQr"/>
<variant name="RelQs"/>
<variant name="SearchBox"/>
<variant name="VQ"/>
</variants>
<histogram name="Companion.CQ.TextHighlight.Success" enum="BooleanSuccess"
expires_after="2024-04-21">
<owner>[email protected]</owner>
<owner>[email protected]</owner>
<owner>src/chrome/browser/companion/OWNERS</owner>
<summary>
Records whether a text highlight operation was successful on the companion
page. Recorded after text highlighting is completed.
</summary>
</histogram>
<histogram name="Companion.FullLoad.Latency" units="ms"
expires_after="2025-01-26">
<owner>[email protected]</owner>
<owner>src/chrome/browser/companion/OWNERS</owner>
<summary>
Records the latency of Companion for full loads of the UI. Recorded once the
UI responds and reports the first element is shown.
</summary>
</histogram>
<histogram name="Companion.HasNavigatedToExpsSuccessPagePref.OnChanged"
enum="Boolean" expires_after="2024-07-14">
<owner>[email protected]</owner>
<owner>src/chrome/browser/companion/OWNERS</owner>
<summary>
Records value of the Exps Policy Pref. That pref contains boolean on whether
companion featureobserved successful exps registration. Recorded after the
value of pref has changed.
</summary>
</histogram>
<histogram name="Companion.HasNavigatedToExpsSuccessPagePref.Status"
enum="Boolean" expires_after="2024-07-07">
<owner>[email protected]</owner>
<owner>src/chrome/browser/companion/OWNERS</owner>
<summary>
Records value of the Exps Policy Pref. Recorded when the pref is read.
</summary>
</histogram>
<histogram name="Companion.IsUserOptedInToExps" enum="BooleanOptedIn"
expires_after="2025-01-05">
<owner>[email protected]</owner>
<owner>src/chrome/browser/companion/OWNERS</owner>
<summary>
Records whether user is opted-in to various experiments. Recorded when the
information is received from the companion backend.
</summary>
</histogram>
<histogram name="Companion.NavigationLoad.Latency" units="ms"
expires_after="2025-01-26">
<owner>[email protected]</owner>
<owner>src/chrome/browser/companion/OWNERS</owner>
<summary>
Records the latency of Companion for loads of the UI that are triggered by
navigation refreshes via PostMessages. Recorded once the UI responds and
reports the first element is shown.
</summary>
</histogram>
<histogram name="Companion.PHFeedback.Result" enum="Companion.PhFeedback"
expires_after="2024-08-18">
<owner>[email protected]</owner>
<owner>src/chrome/browser/companion/OWNERS</owner>
<summary>
Records the last PH feedback submitted by the user for the current page.
Recorded at the once the companion is reloaded or closed.
</summary>
</histogram>
<histogram name="Companion.PromoEvent" enum="Companion.PromoEvent"
expires_after="2024-11-03">
<owner>[email protected]</owner>
<owner>src/chrome/browser/companion/OWNERS</owner>
<summary>
Records various events (e.g. displayed, accepted or rejected) on various
promo surfaces on the companion page. Recorded as soon as the event happens.
</summary>
</histogram>
<histogram name="Companion.ServerSideUrlFilterEvent" enum="Boolean"
expires_after="2024-04-28">
<owner>[email protected]</owner>
<owner>src/chrome/browser/companion/OWNERS</owner>
<summary>
Records that a URL was excluded from VQS triggering due to pXLQ or
pornography signals from Diner. Recorded after URL RPC check and before VQS
rendering.
</summary>
</histogram>
<histogram name="Companion.SidePanel.OpenTrigger" enum="SidePanelOpenTrigger"
expires_after="2025-01-05">
<owner>[email protected]</owner>
<owner>src/chrome/browser/companion/OWNERS</owner>
<summary>
Records the UI location from which the companion side panel was triggered to
be opened. Recorded after the companion is opened and loaded.
</summary>
</histogram>
<histogram name="Companion.SidePanel.ShowUiSuccess" enum="BooleanSuccess"
expires_after="2025-02-10">
<owner>[email protected]</owner>
<owner>src/chrome/browser/companion/OWNERS</owner>
<summary>
Records whether the UI for side panel was successfully shown to the user
have the side panel opened. Recorded after the side panel is opened and all
listeners to the main active tab are setup.
</summary>
</histogram>
<histogram name="Companion.SidePanelAvailabilityChanged"
enum="CompanionSidePanelAvailabilityChanged" expires_after="2024-04-28">
<owner>[email protected]</owner>
<owner>src/chrome/browser/companion/OWNERS</owner>
<summary>
Records change in availability of the Companion side panel based on finch
and runtime checks. Recorded everytime the availability computation is run.
</summary>
</histogram>
<histogram name="Companion.VisualQuery.Agent.DomImageCount" units="images"
expires_after="2024-12-15">
<owner>[email protected]</owner>
<owner>[email protected]</owner>
<owner>src/chrome/browser/companion/OWNERS</owner>
<summary>
Records the number of images on the page found by DOM traversal. Recorded
during classification start for VisualQuerySuggestions in CSC.
</summary>
</histogram>
<histogram name="Companion.VisualQuery.Agent.StartClassification"
enum="Boolean" expires_after="2024-11-03">
<owner>[email protected]</owner>
<owner>[email protected]</owner>
<owner>src/chrome/browser/companion/OWNERS</owner>
<summary>
Records whether we successfully started classification in the
VisualQueryClassifierAgent or chose to delay processing to wait for DOM to
get updates with images. This is recorded right after we traverse the DOM
for images but before we do any classification.
</summary>
</histogram>
<histogram name="Companion.VisualQuery.ClassificationInitStatus"
enum="Companion.VisualQuery.InitStatus" expires_after="2024-11-03">
<owner>[email protected]</owner>
<owner>[email protected]</owner>
<owner>src/chrome/browser/companion/OWNERS</owner>
<summary>
Records whether classification initialization succeeded or failed, along
with a cause for failure. Recorded as soon as classification start has
aborted, or after IPC is made if all preliminary steps were successful.
</summary>
</histogram>
<histogram name="Companion.VisualQuery.ClassificationLatency" units="ms"
expires_after="2025-01-05">
<owner>[email protected]</owner>
<owner>[email protected]</owner>
<owner>src/chrome/browser/companion/OWNERS</owner>
<summary>
Records the latency of the classifer host in completing classification.
Recorded after the classification results are sent to the callback.
</summary>
</histogram>
<histogram name="Companion.VisualQuery.ClassificationResultsSize"
units="images" expires_after="2024-11-03">
<owner>[email protected]</owner>
<owner>[email protected]</owner>
<owner>src/chrome/browser/companion/OWNERS</owner>
<summary>
Records the number of images received by the companion UI from the
VisualQueryClassifierAgent running in the renderer process. Recorded once
the classification and result filtering is complete and the result is
received by the browser process.
</summary>
</histogram>
<histogram name="Companion.VisualQuery.ClassifierInitializationLatency"
units="ms" expires_after="2025-01-05">
<owner>[email protected]</owner>
<owner>[email protected]</owner>
<owner>src/chrome/browser/companion/OWNERS</owner>
<summary>
Records the latency of the classifier host in actually starting
classification. Recorded after IPC is made and as soon as the remote
interface begins Visual Query classification.
</summary>
</histogram>
<histogram name="Companion.VisualQuery.ClassifierModelAvailable"
enum="BooleanAvailable" expires_after="2024-06-30">
<owner>[email protected]</owner>
<owner>[email protected]</owner>
<owner>src/chrome/browser/companion/OWNERS</owner>
<summary>
Records whether the classifier model is available and valid. Recorded as
soon as classification with model has started.
</summary>
</histogram>
<histogram name="Companion.VisualQuery.EligibilityStatus.NumImages"
units="images" expires_after="2024-11-03">
<owner>[email protected]</owner>
<owner>[email protected]</owner>
<owner>src/chrome/browser/companion/OWNERS</owner>
<summary>
Records the total number of images determined to be eligible for
VisualQuerySuggestions in CSC. Recorded at the end of the first pass
(eligibility stage).
</summary>
</histogram>
<histogram name="Companion.VisualQuery.EligibilityStatus.NumSensitive"
units="images" expires_after="2024-09-15">
<owner>[email protected]</owner>
<owner>[email protected]</owner>
<owner>src/chrome/browser/companion/OWNERS</owner>
<summary>
Records the number of sensitive images as determined by the
VisualQuerySuggestions eligibility module in CSC. Recorded at the end of the
second pass (post-classification thresholding stage) if there is at least
one eligible image.
</summary>
</histogram>
<histogram name="Companion.VisualQuery.EligibilityStatus.NumShoppy"
units="images" expires_after="2025-01-05">
<owner>[email protected]</owner>
<owner>[email protected]</owner>
<owner>src/chrome/browser/companion/OWNERS</owner>
<summary>
Records the number of eligible shoppy images, which may or may not be
sensitive as well, as determined by the VisualQuerySuggestions eligibility
module in CSC. Recorded at the end of the second pass (post-classification
thresholding stage) if there is at least one eligible image.
</summary>
</histogram>
<histogram name="Companion.VisualQuery.EligibilityStatus.NumShoppyNotSensitive"
units="images" expires_after="2024-11-03">
<owner>[email protected]</owner>
<owner>[email protected]</owner>
<owner>src/chrome/browser/companion/OWNERS</owner>
<summary>
Records the number of eligible shoppy but not sensitive images as determined
by the VisualQuerySuggestions eligibility module in CSC. Recorded at the end
of the second pass (post-classification thresholding stage) if there is at
least one eligible image.
</summary>
</histogram>
<histogram
name="Companion.VisualQuery.MaybeSensitive.SensitivityClassificationScore"
units="percentile" expires_after="2024-03-31">
<owner>[email protected]</owner>
<owner>[email protected]</owner>
<owner>src/chrome/browser/companion/OWNERS</owner>
<summary>
Records the sensitivity classification score of each image that makes it
through the first pass of the VisualQuerySuggestions eligibility module in
CSC. Recorded during the second pass after classification and before score
thresholding. This score may or may not be less than the sensitivity
threshold value.
</summary>
</histogram>
<histogram name="Companion.VisualQuery.MaybeShoppy.ShoppingClassificationScore"
units="percentile" expires_after="2024-03-31">
<owner>[email protected]</owner>
<owner>[email protected]</owner>
<owner>src/chrome/browser/companion/OWNERS</owner>
<summary>
Records the shopping classification score of each image that makes it
through the first pass of the VisualQuerySuggestions eligibility module in
CSC. Recorded during the second pass after classification and before score
thresholding. This score may or may not be greater than the shopping
threshold value.
</summary>
</histogram>
<histogram
name="Companion.VisualQuery.MostShoppy.SensitivityClassificationScore"
units="percentile" expires_after="2024-10-20">
<owner>[email protected]</owner>
<owner>[email protected]</owner>
<owner>src/chrome/browser/companion/OWNERS</owner>
<summary>
Records the sensitivity classification score of the most shoppy image
without respect to sensitivity, as determined by the VisualQuerySuggestions
eligibility module in CSC. Recorded at the end of the second pass
(post-classification thresholding stage) if there is at least one eligible
image. This score may be higher than the sensitivity threshold value.
</summary>
</histogram>
<histogram name="Companion.VisualQuery.MostShoppy.ShoppingClassificationScore"
units="percentile" expires_after="2024-10-20">
<owner>[email protected]</owner>
<owner>[email protected]</owner>
<owner>src/chrome/browser/companion/OWNERS</owner>
<summary>
Records the shopping classification score of the most shoppy image without
respect to sensitivity, as determined by the VisualQuerySuggestions
eligibility module in CSC. Recorded at the end of the second pass
(post-classification thresholding stage) if there is at least one eligible
image. This score may be lower than the shopping threshold value.
</summary>
</histogram>
<histogram
name="Companion.VisualQuery.MostShoppyNotSensitive.SensitivityClassificationScore"
units="percentile" expires_after="2024-03-31">
<owner>[email protected]</owner>
<owner>[email protected]</owner>
<owner>src/chrome/browser/companion/OWNERS</owner>
<summary>
Records the sensitivity classification score of the winning - that is, most
shoppy and eligible - image, as determined by the VisualQuerySuggestions
eligibility module in CSC. Recorded at the end of the second pass
(post-classification thresholding stage) if there is at least one eligible
image. This score will be less than the sensitivity threshold value.
</summary>
</histogram>
<histogram
name="Companion.VisualQuery.MostShoppyNotSensitive.ShoppingClassificationScore"
units="percentile" expires_after="2024-03-31">
<owner>[email protected]</owner>
<owner>[email protected]</owner>
<owner>src/chrome/browser/companion/OWNERS</owner>
<summary>
Records the shopping classification score of the winning - that is, most
shoppy and eligible - image, as determined by the VisualQuerySuggestions
eligibility module in CSC. Recorded at the end of the second pass
(post-classification thresholding stage) if there is at least one eligible
image. This score will be greater than the shopping threshold value.
</summary>
</histogram>
<histogram name="Companion.VisualQuery.ResultLatency" units="ms"
expires_after="2025-01-05">
<owner>[email protected]</owner>
<owner>[email protected]</owner>
<owner>src/chrome/browser/companion/OWNERS</owner>
<summary>
Records the latency from the time the side panel starts loading to when the
visual query suggestion is sent to the side panel. Recorded right after the
visual result is sent to the side panel for rendering.
</summary>
</histogram>
<histogram name="Companion.VisualQuery.SendVisualResultSuccess" enum="Boolean"
expires_after="2024-11-03">
<owner>[email protected]</owner>
<owner>[email protected]</owner>
<owner>src/chrome/browser/companion/OWNERS</owner>
<summary>
Records whether we were able to successfully send a visual query suggestion
to the side panel. This is recorded right after we make the mojom IPC to the
side panel.
</summary>
</histogram>
<histogram name="Companion.{UiSurface}.ChildElementCount" units="Index"
expires_after="2024-09-01">
<owner>[email protected]</owner>
<owner>src/chrome/browser/companion/OWNERS</owner>
<summary>
Records the number of child elements shown within the UI surface. Only valid
for list UI surfaces. Recorded as soon as the surface is shown.
</summary>
<token key="UiSurface" variants="UiSurface"/>
</histogram>
<histogram name="Companion.{UiSurface}.Clicked" enum="BooleanClicked"
expires_after="2025-01-05">
<owner>[email protected]</owner>
<owner>src/chrome/browser/companion/OWNERS</owner>
<summary>
Records whether {UiSurface} was clicked by the user on the companion page.
Recorded as soon as the surface is clicked.
</summary>
<token key="UiSurface" variants="UiSurface"/>
</histogram>
<histogram name="Companion.{UiSurface}.ClickPosition" units="Index"
expires_after="2024-09-15">
<owner>[email protected]</owner>
<owner>src/chrome/browser/companion/OWNERS</owner>
<summary>
Records the position of the UI element that was clicked with respect to its
parent list. Recorded as soon as the surface is clicked.
</summary>
<token key="UiSurface" variants="UiSurface"/>
</histogram>
<histogram name="Companion.{UiSurface}.Shown" enum="BooleanShown"
expires_after="2025-01-05">
<owner>[email protected]</owner>
<owner>src/chrome/browser/companion/OWNERS</owner>
<summary>
Records whether {UiSurface} was shown on the companion page. Recorded as
soon as the surface is shown.
Warning: For SearchBox and RegionSearch, this metric is not recorded.
</summary>
<token key="UiSurface" variants="UiSurface"/>
</histogram>
</histograms>
</histogram-configuration>
Codebase Browser
chromium