<!--
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 Local 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="IndexId">
<variant name="CrosSettings." summary="Cros Settings"/>
<variant name="HelpApp." summary="Help App"/>
<variant name="HelpAppLauncher." summary="Help App Launcher"/>
<variant name="Personalization." summary="Personalization App"/>
<variant name="ShortcutsApp." summary="Shortcuts App"/>
</variants>
<variants name="LocalStorageSizes">
<variant name="" summary=""/>
<variant name="1MBTo5MB" summary="DB size between 1MB and 5MB."/>
<variant name="100KBTo1MB" summary="DB size between 100KB and 1MB."/>
<variant name="Under100KB" summary="DB size under 100KB."/>
</variants>
<histogram name="LocalSearchService.BindIndexHasError" enum="Boolean"
expires_after="2024-11-30">
<owner>[email protected]</owner>
<owner>[email protected]</owner>
<summary>
Whether or not BindIndex calls to LocalSearchService have errors. It is
reported once for every BindIndex call. Chrome OS only.
</summary>
</histogram>
<histogram name="LocalSearchService.MetricsDailyEventInterval"
enum="DailyEventIntervalType" expires_after="2024-11-30">
<owner>[email protected]</owner>
<owner>[email protected]</owner>
<summary>
Reasons why local search daily metrics were reported. Chrome OS only.
</summary>
</histogram>
<histogram name="LocalSearchService.{IndexId}AddOrUpdateLatency" units="ms"
expires_after="2024-11-28">
<owner>[email protected]</owner>
<owner>[email protected]</owner>
<summary>
Time taken to add/update content to the index. It is reported once for every
AddOrUpdate call. Chrome OS only. {IndexId}
</summary>
<token key="IndexId" variants="IndexId">
<variant name=""/>
</token>
</histogram>
<histogram name="LocalSearchService.{IndexId}Backend"
enum="LocalSearchServiceBackend" expires_after="2024-11-30">
<owner>[email protected]</owner>
<owner>[email protected]</owner>
<summary>
Type of backend requested from the Local Search Service. It is reported once
at the initialization of an Index. Chrome OS only. {IndexId}
</summary>
<token key="IndexId" variants="IndexId">
<variant name=""/>
</token>
</histogram>
<histogram name="LocalSearchService.{IndexId}ClearIndexLatency" units="ms"
expires_after="2024-11-30">
<owner>[email protected]</owner>
<owner>[email protected]</owner>
<summary>
Time taken to clear all content from the index. It is reported once for
every ClearIndex call. Chrome OS only. {IndexId}
</summary>
<token key="IndexId" variants="IndexId">
<variant name=""/>
</token>
</histogram>
<histogram name="LocalSearchService.{IndexId}DailySearch" units="count"
expires_after="2025-02-02">
<owner>[email protected]</owner>
<owner>[email protected]</owner>
<summary>
Number of times the local search service has been requested to perform a
search on a device. Reported daily. The count is accumulated through the
day, spanning reboots, and sent once the system clock indicates that a full
day or more has passed since the last report. If the system is suspended or
off for more than a day, the current count will be reported the next time
the system boots, but the skipped days will not be reported. Chrome OS only.
{IndexId}
</summary>
<token key="IndexId" variants="IndexId">
<variant name=""/>
</token>
</histogram>
<histogram name="LocalSearchService.{IndexId}DeleteLatency" units="ms"
expires_after="2024-11-30">
<owner>[email protected]</owner>
<owner>[email protected]</owner>
<summary>
Time taken to delete content from the index. It is reported once for every
Delete call. Chrome OS only. {IndexId}
</summary>
<token key="IndexId" variants="IndexId">
<variant name=""/>
</token>
</histogram>
<histogram name="LocalSearchService.{IndexId}NumberDocuments" units="count"
expires_after="2024-11-30">
<owner>[email protected]</owner>
<owner>[email protected]</owner>
<summary>
Number of documents in the corpus. Recorded each time the index is updated
(documents added, updated or removed) and if the index is not empty. Chrome
OS only. {IndexId}
</summary>
<token key="IndexId" variants="IndexId">
<variant name=""/>
</token>
</histogram>
<histogram name="LocalSearchService.{IndexId}NumberResults" units="count"
expires_after="2024-11-28">
<owner>[email protected]</owner>
<owner>[email protected]</owner>
<summary>
Number of results for each successful search. Chrome OS only. {IndexId}
</summary>
<token key="IndexId" variants="IndexId">
<variant name=""/>
</token>
</histogram>
<histogram name="LocalSearchService.{IndexId}NumberSearchPerformedDone"
enum="Boolean" expires_after="2025-01-26">
<owner>[email protected]</owner>
<owner>[email protected]</owner>
<summary>
This is recorded each time a search is successfully performed using
LocalSearchService. Always records true. Chrome OS only. {IndexId}
</summary>
<token key="IndexId" variants="IndexId">
<variant name=""/>
</token>
</histogram>
<histogram name="LocalSearchService.{IndexId}ResponseStatus"
enum="LocalSearchServiceResponseStatus" expires_after="2025-02-02">
<owner>[email protected]</owner>
<owner>[email protected]</owner>
<summary>
Search request response status for Cros Settings. Chrome OS only. {IndexId}
</summary>
<token key="IndexId" variants="IndexId">
<variant name=""/>
</token>
</histogram>
<histogram name="LocalSearchService.{IndexId}SearchLatency" units="ms"
expires_after="2024-11-28">
<owner>[email protected]</owner>
<owner>[email protected]</owner>
<summary>
Time taken to find search results. Only recorded if search response status
is success, i.e. neither index nor query is empty. Chrome OS only. {IndexId}
</summary>
<token key="IndexId" variants="IndexId">
<variant name=""/>
</token>
</histogram>
<histogram name="LocalSearchService.{IndexId}UpdateDocumentsLatency" units="ms"
expires_after="2024-11-30">
<owner>[email protected]</owner>
<owner>[email protected]</owner>
<summary>
Time taken to update contents from the index. It is reported once for every
UpdateDocuments call. Chrome OS only. {IndexId}
</summary>
<token key="IndexId" variants="IndexId">
<variant name=""/>
</token>
</histogram>
<histogram name="LocalStorage.AccessMetaDataUpdateAtShutdown" enum="Boolean"
expires_after="2024-12-01">
<owner>[email protected]</owner>
<owner>[email protected]</owner>
<summary>
Emitted when a local StorageArea is shutdown and the access metadata for the
associated StorageKey is updated. It's possible to update the access
metadata when new data is written to the storage area instead, so this
metric does not capture all access metadata updates.
Value is true if update succeeded and false if update failed.
</summary>
</histogram>
<histogram name="LocalStorage.BrowserLocalStorageCachePurgedInKB" units="KB"
expires_after="M77">
<owner>[email protected]</owner>
<summary>
Total size of the HTML5 LocalStorage browser-side cache purged in KB when
memory pressure signal was triggered or cache size hit the limits.
</summary>
</histogram>
<histogram name="LocalStorage.BrowserLocalStorageCacheSizeInKB" units="KB"
expires_after="M77">
<owner>[email protected]</owner>
<summary>
Total size of the HTML5 LocalStorage databases in KB in the browser-side
cache recorded each time a new database is opened in memory.
</summary>
</histogram>
<histogram name="LocalStorage.DaysSinceLastModified400DaysGT" units="days"
expires_after="2025-04-19">
<owner>[email protected]</owner>
<owner>[email protected]</owner>
<summary>
Emitted when the browsing context that loaded the related local storage
controller shuts down. One entry is recorded per local storage area.
Number of days since a local storage area was modified (for values over 400
days).
</summary>
</histogram>
<histogram name="LocalStorage.DaysSinceLastModified400DaysLTE" units="days"
expires_after="2025-04-19">
<owner>[email protected]</owner>
<owner>[email protected]</owner>
<summary>
Emitted when the browsing context that loaded the related local storage
controller shuts down. One entry is recorded per local storage area.
Number of days since a local storage area was modified (for values under 400
days).
</summary>
</histogram>
<histogram name="LocalStorage.MojoSizeInKB" units="KB"
expires_after="2025-01-05">
<owner>[email protected]</owner>
<owner>[email protected]</owner>
<summary>
Size of the HTML5 LocalStorage DB in KB in the renderer-side cache using
Mojo implementation.
Warning: Histogram expired between M95-M110. Data may be missing.
</summary>
</histogram>
<histogram name="LocalStorage.MojoTimeToPrime" units="ms"
expires_after="2025-01-05">
<owner>[email protected]</owner>
<owner>[email protected]</owner>
<summary>
Time (in ms) to load HTML5 LocalStorage into the renderer-side cache using
Mojo implementation.
Warning: Histogram expired between M95-M110. Data may be missing.
</summary>
</histogram>
<histogram name="LocalStorage.MojoTimeToPrimeFor{LocalStorageSizes}" units="ms"
expires_after="2025-01-05">
<owner>[email protected]</owner>
<owner>[email protected]</owner>
<summary>
Time (in ms) to load HTML5 LocalStorage into the renderer-side cache using
Mojo implementation, split by size. {LocalStorageSizes}
Warning: Histogram expired between M95-M110. Data may be missing.
</summary>
<token key="LocalStorageSizes" variants="LocalStorageSizes"/>
</histogram>
<histogram name="LocalStorage.OrphanStorageAreasOnStartupCount" units="areas"
expires_after="2025-02-10">
<owner>[email protected]</owner>
<owner>[email protected]</owner>
<summary>
Records the amount of orphan (nonce-bound buckets which will never be
loaded) storage areas detected on LocalStorageImpl initialization (profile
load). Recorded one minute after LocalStorageImpl initialization to ensure
any restored tabs have loaded.
See crbug.com/353555346 for more info.
</summary>
</histogram>
<histogram name="LocalStorage.RendererAreaCacheHit"
enum="LocalStorageRendererAreaCacheHitEnum" expires_after="2025-09-01">
<owner>[email protected]</owner>
<owner>[email protected]</owner>
<summary>
The renderer side cache hit rate metrics for new HTML5 LocalStorage DB
opened.
Warning: this histogram was expired from M78 to M92; data may be missing.
</summary>
</histogram>
<histogram name="LocalStorage.StaleStorageAreasDeletedOnStartupCount"
units="areas" expires_after="2025-02-02">
<owner>[email protected]</owner>
<owner>[email protected]</owner>
<summary>
Records the amount of stale (400 days since last access or write) storage
areas deleted on LocalStorageImpl initialization (profile load).
Emitted after successful attempt to delete stale storage areas.
See crbug.com/40281870 for more info.
</summary>
</histogram>
<histogram name="LocalStorage.StaleStorageAreasDeletedOnStartupSuccess"
enum="BooleanSuccess" expires_after="2025-02-02">
<owner>[email protected]</owner>
<owner>[email protected]</owner>
<summary>
Records the success of clearing stale (400 days since last access or write)
storage areas on LocalStorageImpl initialization (profile load).
Emitted after attempt to delete stale storage areas occurs.
See crbug.com/40281870 for more info.
</summary>
</histogram>
</histograms>
</histogram-configuration>
Codebase Browser
chromium