chromium/tools/metrics/histograms/metadata/holding_space/histograms.xml

<!--
Copyright 2020 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 Holding Space 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="HoldingSpaceFileSystemType">
  <variant name="DriveFs" summary="Drive"/>
  <variant name="Local" summary="local"/>
</variants>

<variants name="HoldingSpaceItemAction">
  <variant name="Cancel" summary="cancel"/>
  <variant name="Copy" summary="copy"/>
  <variant name="Drag" summary="drag"/>
  <variant name="Launch" summary="launch"/>
  <variant name="Pause" summary="pause"/>
  <variant name="Pin" summary="pin"/>
  <variant name="Remove" summary="remove"/>
  <variant name="Resume" summary="resume"/>
  <variant name="ShowInBrowser" summary="show-in-browser"/>
  <variant name="ShowInFolder" summary="show-in-folder"/>
  <variant name="Unpin" summary="unpin"/>
  <variant name="ViewDetailsInBrowser" summary="view-details-in-browser"/>
</variants>

<variants name="HoldingSpaceItemType">
  <variant name="All" summary="all"/>
  <variant name="ArcDownload" summary="ARC download"/>
  <variant name="CameraAppPhoto" summary="Camera app photo"/>
  <variant name="CameraAppScanJpg" summary="JPG Camera app scan"/>
  <variant name="CameraAppScanPdf" summary="PDF Camera app scan"/>
  <variant name="CameraAppVideoGif" summary="GIF Camera app video"/>
  <variant name="CameraAppVideoMp4" summary="MP4 Camera app video"/>
  <variant name="DiagnosticsLog" summary="Diagnostics app log"/>
  <variant name="Download" summary="Ash-Chrome download"/>
  <variant name="DriveSuggestion" summary="Drive suggestion"/>
  <variant name="LacrosDownload" summary="Lacros-Chrome download"/>
  <variant name="LocalSuggestion" summary="local suggestion"/>
  <variant name="NearbyShare" summary="Nearby Share"/>
  <variant name="PhoneHubCameraRoll" summary="Phone Hub camera roll"/>
  <variant name="PhotoshopWeb" summary="Photoshop Web"/>
  <variant name="PinnedFile" summary="pinned file"/>
  <variant name="PrintedPdf" summary="printed PDF"/>
  <variant name="Scan" summary="Scan app"/>
  <variant name="ScreenRecording" summary="WebM screen recording"/>
  <variant name="ScreenRecordingGif" summary="GIF screen recording"/>
  <variant name="Screenshot" summary="screenshot"/>
</variants>

<histogram name="HoldingSpace.Animation.BubbleResize.Smoothness" units="%"
    expires_after="2024-10-06">
  <owner>[email protected]</owner>
  <owner>[email protected]</owner>
  <summary>
    Records the smoothness of the holding space bubble resize animation. Note
    that smoothness is expected to be between 0 and 100 (inclusively) with 100
    representing ideal smoothness of &gt;= 60 frames per second. This histogram
    is emitted when the resize animation ends.
  </summary>
</histogram>

<histogram name="HoldingSpace.Animation.PodResize.Smoothness" units="%"
    expires_after="2024-10-06">
  <owner>[email protected]</owner>
  <owner>[email protected]</owner>
  <summary>
    Records the smoothness of the holding space pod resize animation. Note that
    smoothness is expected to be between 0 and 100 (inclusively) with 100
    representing ideal smoothness of &gt;= 60 frames per second. This histogram
    is emitted when the resize animation ends.
  </summary>
</histogram>

<histogram name="HoldingSpace.Downloads.Action.All"
    enum="HoldingSpaceDownloadsAction" expires_after="2025-02-10">
  <owner>[email protected]</owner>
  <owner>[email protected]</owner>
  <summary>
    Records an action taken on the downloads header in holding space UI at the
    moment the action is performed.
  </summary>
</histogram>

<histogram name="HoldingSpace.FileCreatedFromShowSaveFilePicker.Extension"
    enum="HoldingSpaceExtension" expires_after="2025-02-10">
  <owner>[email protected]</owner>
  <owner>[email protected]</owner>
  <summary>
    Records the extension for a file that was created in fulfillment of a
    `window.showSaveFilePicker()` request at the moment of file creation.
  </summary>
</histogram>

<histogram
    name="HoldingSpace.FileCreatedFromShowSaveFilePicker.FilePickerBindingContext"
    enum="HoldingSpaceFilePickerBindingContext" expires_after="2025-02-10">
  <owner>[email protected]</owner>
  <owner>[email protected]</owner>
  <summary>
    Records the binding context for the file picker used to create a file in
    fulfillment of a `window.showSaveFilePicker()` request at the moment of file
    creation.
  </summary>
</histogram>

<histogram name="HoldingSpace.FilesAppChip.Action.All"
    enum="HoldingSpaceFilesAppChipAction" expires_after="2024-10-06">
  <owner>[email protected]</owner>
  <owner>[email protected]</owner>
  <summary>
    Records an action taken on the Files app chip in holding space UI at the
    moment the action is performed.
  </summary>
</histogram>

<histogram name="HoldingSpace.Item.Action.All" enum="HoldingSpaceItemAction"
    expires_after="2025-02-10">
  <owner>[email protected]</owner>
  <owner>[email protected]</owner>
  <summary>
    Records an action taken on an item in holding space UI at the moment the
    action is performed.
  </summary>
</histogram>

<histogram name="HoldingSpace.Item.Action.Launch.Empty"
    enum="HoldingSpaceItemType" expires_after="2024-10-06">
  <owner>[email protected]</owner>
  <owner>[email protected]</owner>
  <summary>
    Records an attempt to launch a holding space item of a specific type, backed
    by an empty file, at the moment of attempt.
  </summary>
</histogram>

<histogram name="HoldingSpace.Item.Action.Launch.Empty.Extension"
    enum="HoldingSpaceExtension" expires_after="2024-10-06">
  <owner>[email protected]</owner>
  <owner>[email protected]</owner>
  <summary>
    Records an attempt to launch a holding space item backed by an empty file of
    a specific extension at the moment of attempt.
  </summary>
</histogram>

<histogram name="HoldingSpace.Item.Action.Launch.Failure"
    enum="HoldingSpaceItemType" expires_after="2024-10-06">
  <owner>[email protected]</owner>
  <owner>[email protected]</owner>
  <summary>
    Records a failure to launch a holding space item of a specific type at the
    moment of failure.
  </summary>
</histogram>

<histogram name="HoldingSpace.Item.Action.Launch.Failure.Extension"
    enum="HoldingSpaceExtension" expires_after="2024-10-06">
  <owner>[email protected]</owner>
  <owner>[email protected]</owner>
  <summary>
    Records a failure to launch a holding space item backed by file of a
    specific extension at the moment of failure.
  </summary>
</histogram>

<histogram name="HoldingSpace.Item.Action.Launch.Failure.Reason"
    enum="HoldingSpaceItemLaunchFailureReason" expires_after="2024-10-06">
  <owner>[email protected]</owner>
  <owner>[email protected]</owner>
  <summary>
    Records the reason for failing to launch a holding space item at the moment
    of failure.
  </summary>
</histogram>

<histogram name="HoldingSpace.Item.Action.{action}" enum="HoldingSpaceItemType"
    expires_after="2025-02-10">
  <owner>[email protected]</owner>
  <owner>[email protected]</owner>
  <summary>
    Records the type of item in holding space UI for which the {action} action
    was taken at the moment the action is performed.
  </summary>
  <token key="action" variants="HoldingSpaceItemAction"/>
</histogram>

<histogram name="HoldingSpace.Item.Action.{action}.Extension"
    enum="HoldingSpaceExtension" expires_after="2024-10-06">
  <owner>[email protected]</owner>
  <owner>[email protected]</owner>
  <summary>
    Records the extension of an item in holding space UI for which the {action}
    action was taken at the moment the action is performed.
  </summary>
  <token key="action" variants="HoldingSpaceItemAction"/>
</histogram>

<histogram name="HoldingSpace.Item.Action.{action}.FileSystemType"
    enum="HoldingSpaceFileSystemType" expires_after="2025-02-10">
  <owner>[email protected]</owner>
  <owner>[email protected]</owner>
  <summary>
    Records the file system type of an item in holding space UI for which the
    {action} action was taken at the moment the action is performed.
  </summary>
  <token key="action" variants="HoldingSpaceItemAction"/>
</histogram>

<histogram name="HoldingSpace.Item.TotalCountV2.{type}" units="items"
    expires_after="2025-02-10">
  <owner>[email protected]</owner>
  <owner>[email protected]</owner>
  <summary>
    Records the total count of {type} items in holding space on startup and as
    additions/removals take place. Note that this histogram is emitted no more
    than once every thirty seconds.
  </summary>
  <token key="type" variants="HoldingSpaceItemType"/>
</histogram>

<histogram
    name="HoldingSpace.Item.TotalCountV2.{type}.FileSystemType.{fs_type}"
    units="items" expires_after="2025-02-10">
  <owner>[email protected]</owner>
  <owner>[email protected]</owner>
  <summary>
    Records the total count of {type} items in holding space which are backed by
    a file in the {fs_type} file system, on startup and as additions/removals
    take place. Note that this histogram is emitted no more than once every
    thirty seconds.
  </summary>
  <token key="fs_type" variants="HoldingSpaceFileSystemType"/>
  <token key="type" variants="HoldingSpaceItemType"/>
</histogram>

<histogram name="HoldingSpace.Item.VisibleCount.{type}" units="items"
    expires_after="2025-02-10">
  <owner>[email protected]</owner>
  <owner>[email protected]</owner>
  <summary>
    Records the visible count of {type} items in holding space at the moment
    holding space UI is shown.
  </summary>
  <token key="type" variants="HoldingSpaceItemType"/>
</histogram>

<histogram
    name="HoldingSpace.Item.VisibleCount.{type}.FileSystemType.{fs_type}"
    units="items" expires_after="2025-02-10">
  <owner>[email protected]</owner>
  <owner>[email protected]</owner>
  <summary>
    Records the visible count of {type} items in holding space which are backed
    by a file in the {fs_type} file system at the moment holding space UI is
    shown.
  </summary>
  <token key="fs_type" variants="HoldingSpaceFileSystemType"/>
  <token key="type" variants="HoldingSpaceItemType"/>
</histogram>

<histogram name="HoldingSpace.Pod.Action.All" enum="HoldingSpacePodAction"
    expires_after="2025-02-10">
  <owner>[email protected]</owner>
  <owner>[email protected]</owner>
  <summary>
    Records an action taken on the holding space pod in the shelf at the moment
    the action is performed.
  </summary>
</histogram>

<histogram name="HoldingSpace.Suggestions.Action.All"
    enum="HoldingSpaceSuggestionsAction" expires_after="2024-10-06">
  <owner>[email protected]</owner>
  <owner>[email protected]</owner>
  <summary>
    Records an action taken on the suggestions header in holding space UI at the
    moment the action is performed.
  </summary>
</histogram>

<histogram name="HoldingSpace.TimeFromFirstAvailabilityToFirstAdd" units="ms"
    expires_after="2024-10-06">
  <owner>[email protected]</owner>
  <owner>[email protected]</owner>
  <summary>
    Records the time from when the holding space feature first became available
    to when the user first added an item to holding space.
  </summary>
</histogram>

<histogram name="HoldingSpace.TimeFromFirstAvailabilityToFirstEntry" units="ms"
    expires_after="2024-10-06">
  <owner>[email protected]</owner>
  <owner>[email protected]</owner>
  <summary>
    Records the time from when the holding space feature first became available
    to when the user first entered holding space.
  </summary>
</histogram>

<histogram name="HoldingSpace.TimeFromFirstEntryToFirstPin" units="ms"
    expires_after="2024-10-06">
  <owner>[email protected]</owner>
  <owner>[email protected]</owner>
  <summary>
    Records the time from when the user first entered holding space to when the
    user first pinned a file. Note that this may be zero if the user pinned
    their first file prior to having entered holding space.
  </summary>
</histogram>

<histogram name="HoldingSpace.UserPreferences.PreviewsEnabled"
    enum="BooleanEnabled" expires_after="2025-02-10">
  <owner>[email protected]</owner>
  <owner>[email protected]</owner>
  <summary>
    Records whether the user has previews enabled. Note that this histogram is
    emitted once per user session at start up.
  </summary>
</histogram>

<histogram name="HoldingSpace.UserPreferences.SuggestionsExpanded"
    enum="BooleanExpanded" expires_after="2025-02-10">
  <owner>[email protected]</owner>
  <owner>[email protected]</owner>
  <summary>
    Records whether the user has suggestions expanded. Note that this histogram
    is emitted once per user session at start up.
  </summary>
</histogram>

</histograms>

</histogram-configuration>