blob: bf518a1480bee7a9423590a3a8fd650c0e4d9721 [file] [log] [blame]
<!--
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 Quota 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="Quota.AgeOfDataInDays" units="days" expires_after="2023-11-12">
<owner>ayui@chromium.org</owner>
<owner>chrome-owp-storage@google.com</owner>
<summary>
How many kilobytes are how old. Similar to |AgeOfOrigin| except a sample is
added for each kilobyte of an origin's data. Logged hourly for all origins
with stored data.
</summary>
</histogram>
<histogram name="Quota.AgeOfOriginInDays" units="days"
expires_after="2023-11-19">
<owner>ayui@chromium.org</owner>
<owner>chrome-owp-storage@google.com</owner>
<summary>
How many days it's been since an origin's temporary storage has been
accessed. Logged hourly for all origins with stored data.
</summary>
</histogram>
<histogram name="Quota.AvailableDiskSpace" units="MB"
expires_after="2023-11-12">
<owner>ayui@chromium.org</owner>
<owner>chrome-owp-storage@google.com</owner>
<summary>
Amount of free disk space for the storage directory. Logged at irregular
intervals.
</summary>
</histogram>
<histogram name="Quota.AvailableDiskSpace2" units="MB"
expires_after="2023-10-08">
<owner>ayui@chromium.org</owner>
<owner>chrome-owp-storage@google.com</owner>
<summary>
Amount of free disk space for the storage directory. Logged when collecting
usage information.
</summary>
</histogram>
<histogram name="Quota.DatabaseMigration{VersionUpgrades}"
enum="BooleanSuccess" expires_after="2024-05-24">
<owner>ayui@chromium.org</owner>
<owner>chrome-owp-storage@google.com</owner>
<summary>
Records whether the database migration was successful. Recorded after
attempting to migrate the database.
</summary>
<token key="VersionUpgrades">
<variant name="FromV5ToV7"/>
<variant name="FromV6ToV7"/>
<variant name="FromV7ToV8"/>
<variant name="FromV8ToV9"/>
<variant name="FromV9ToV10"/>
</token>
</histogram>
<histogram name="Quota.DiskspaceShortage" units="MB" expires_after="2023-11-12">
<owner>ayui@chromium.org</owner>
<owner>chrome-owp-storage@google.com</owner>
<summary>
Difference between acceptable lower limit of diskspace and actual free
diskspace at beginning of an eviction round.
</summary>
</histogram>
<histogram name="Quota.EvictedBucketAccessCount" units="units"
expires_after="2023-08-20">
<owner>ayui@chromium.org</owner>
<owner>chrome-owp-storage@google.com</owner>
<summary>
The number of times the evicted bucket was accessed. Logged when the bucket
is evicted. Replaces Quota.EvictedOriginAccessCount when eviction was per
origin.
</summary>
</histogram>
<histogram name="Quota.EvictedBucketDaysSinceAccess" units="units"
expires_after="2023-09-24">
<owner>ayui@chromium.org</owner>
<owner>chrome-owp-storage@google.com</owner>
<summary>
The number of days since the evicted bucket was last accessed. Logged when
the bucket is evicted. Replaces Quota.EvictedOriginDaysSinceAccess when
eviction was per origin.
</summary>
</histogram>
<histogram name="Quota.EvictedBucketsPerHour" units="buckets"
expires_after="2023-10-22">
<owner>ayui@chromium.org</owner>
<owner>chrome-owp-storage@google.com</owner>
<summary>
Number of evicted buckets in an hour. Replaces Quota.EvictedOriginPerHour
when eviction was per origin.
</summary>
</histogram>
<histogram name="Quota.EvictedBytesPerRound" units="MB"
expires_after="2023-10-15">
<owner>ayui@chromium.org</owner>
<owner>chrome-owp-storage@google.com</owner>
<summary>
Amount of usage used by evicted buckets in an eviction round. Prior to M94,
evictions were based on per origin instead of per bucket.
</summary>
</histogram>
<histogram name="Quota.EvictionRoundsPerHour" units="units"
expires_after="2023-11-12">
<owner>ayui@chromium.org</owner>
<owner>chrome-owp-storage@google.com</owner>
<summary>
Number of eviction rounds in an hour. Histogram expired between 2020/10 and
2022/06.
</summary>
</histogram>
<histogram name="Quota.GlobalTemporaryPoolSize" units="MB"
expires_after="2023-11-12">
<owner>ayui@chromium.org</owner>
<owner>chrome-owp-storage@google.com</owner>
<summary>
The size of the global temporary storage pool. Logged at irregular
intervals.
</summary>
</histogram>
<histogram name="Quota.GlobalUsageOfTemporaryStorage" units="MB"
expires_after="2023-10-23">
<owner>ayui@chromium.org</owner>
<owner>chrome-owp-storage@google.com</owner>
<summary>Global usage of temporary storage.</summary>
</histogram>
<histogram name="Quota.NumberOfEvictedBucketsPerRound" units="units"
expires_after="2023-10-08">
<owner>ayui@chromium.org</owner>
<owner>chrome-owp-storage@google.com</owner>
<summary>Number of evicted buckets per round.</summary>
</histogram>
<histogram name="Quota.PercentDiskAvailable" units="%"
expires_after="2023-11-12">
<owner>ayui@chromium.org</owner>
<owner>chrome-owp-storage@google.com</owner>
<summary>
Percentage of the storage device that is free. Logged at irregular
intervals.
</summary>
</histogram>
<histogram name="Quota.PercentDiskAvailable2" units="%"
expires_after="2023-11-12">
<owner>ayui@chromium.org</owner>
<owner>chrome-owp-storage@google.com</owner>
<summary>
Percentage of the storage device that is free. Logged when collecting usage
information.
</summary>
</histogram>
<histogram name="Quota.PercentUsedByOrigin" units="%"
expires_after="2023-11-12">
<owner>ayui@chromium.org</owner>
<owner>chrome-owp-storage@google.com</owner>
<summary>
Percentage of an origin's quota that is being used by the origin. Logged at
irregular intervals.
</summary>
</histogram>
<histogram name="Quota.PercentUsedForTemporaryStorage2" units="%"
expires_after="2023-11-12">
<owner>ayui@chromium.org</owner>
<owner>chrome-owp-storage@google.com</owner>
<summary>
Percentage of the storage device that is being use for temporary storage.
Logged when collecting usage information.
</summary>
</histogram>
<histogram name="Quota.QuotaDatabaseDisabled"
enum="QuotaDatabaseDisabledReason" expires_after="2023-11-12">
<owner>estade@chromium.org</owner>
<owner>chrome-owp-storage@google.com</owner>
<summary>
Records at which step the QuotaDatabase failed to bootstrap.
</summary>
</histogram>
<histogram name="Quota.QuotaDatabaseError" enum="SqliteLoggedResultCode"
expires_after="2023-11-19">
<owner>ayui@chromium.org</owner>
<owner>chrome-owp-storage@google.com</owner>
<summary>Errors reported by SQLite while using the quota database.</summary>
</histogram>
<histogram name="Quota.QuotaDatabaseReset" enum="QuotaDatabaseResetReason"
expires_after="2023-11-12">
<owner>ayui@chromium.org</owner>
<owner>chrome-owp-storage@google.com</owner>
<summary>
Records the reason the QuotaDatabase was reset to understand how frequently
and why this happens. This will inform us on how we should implement data
recovery for storage data when the QuotaDatabase is reset.
</summary>
</histogram>
<histogram name="Quota.QuotaDatabaseResultSuccess" enum="BooleanSuccess"
expires_after="2023-10-22">
<obsolete>
Code for recording this histogram was removed in May 2023 after a refactor.
The error rate at the time was less than 0.005%.
</obsolete>
<owner>ayui@chromium.org</owner>
<owner>chrome-owp-storage@google.com</owner>
<summary>
Records whether the query to QuotaDatabase was successful. Recorded in
QuotaManager after a result is returned from every request to QuotaDatabase.
Added to ensure that the failure rate is within bounds of what we expect.
</summary>
</histogram>
<histogram name="Quota.QuotaForOrigin" units="MB" expires_after="2024-05-24">
<owner>ayui@chromium.org</owner>
<owner>chrome-owp-storage@google.com</owner>
<summary>
The quota value computed for an origin using temporary storage. Logged at
irregular intervals. (In the process of writing new data, storage systems
consult the quota system for &quot;usage and quota&quot; to determine if
there is sufficient space available for the new data. This value is logged
at the time of that consultation. The frequency is dependent on how
individual websites use the various storage apis.)
</summary>
</histogram>
<histogram name="Quota.SkippedEvictionRoundsPerHour" units="units"
expires_after="2023-11-12">
<owner>ayui@chromium.org</owner>
<owner>chrome-owp-storage@google.com</owner>
<summary>
Number of skipped eviction rounds in an hour. Histogram expired between
2018/08 and 2022/06.
</summary>
</histogram>
<histogram name="Quota.SkippedInvalidOriginUsage" enum="InvalidOriginReason"
expires_after="2023-06-24">
<owner>ayui@chromium.org</owner>
<owner>chrome-owp-storage@google.com</owner>
<summary>
While accumulating usage information, ClientUsageTracker is encountering
invalid origins. This enum histogram will capture the type of invalid
origins that are encountered.
</summary>
</histogram>
<histogram name="Quota.StorageKeyNonceCount" units="buckets"
expires_after="2023-11-12">
<owner>ayui@chromium.org</owner>
<owner>chrome-owp-storage@google.com</owner>
<summary>
Number of buckets in the QuotaDatabase buckets table with nonce in the
StorageKey to inform better eviction logic. Logged hourly. These will
typically be used by anonymous iframes, fenced frames, etc.
</summary>
</histogram>
<histogram name="Quota.TimeDeltaOfEvictionRounds" units="units"
expires_after="2023-11-12">
<owner>ayui@chromium.org</owner>
<owner>chrome-owp-storage@google.com</owner>
<summary>
Time between two consecutive eviction rounds. Only recorded if at least one
origin has been evicted in each eviction round.
</summary>
</histogram>
<histogram name="Quota.TimeSpentToAEvictionRound" units="units"
expires_after="2023-11-12">
<owner>ayui@chromium.org</owner>
<owner>chrome-owp-storage@google.com</owner>
<summary>
Time spent to an eviction round. Histogram expired between 2018/08 and
2022/06.
</summary>
</histogram>
<histogram name="Quota.TotalBucketCount" units="buckets"
expires_after="2023-11-12">
<owner>ayui@chromium.org</owner>
<owner>chrome-owp-storage@google.com</owner>
<summary>
Total number of entries in the QuotaDatabase buckets table for a profile.
Logged hourly.
</summary>
</histogram>
<histogram name="Quota.TotalDiskSpace" units="MB" expires_after="2023-10-22">
<owner>ayui@chromium.org</owner>
<owner>chrome-owp-storage@google.com</owner>
<summary>
Total disk space for the storage directory. Logged at irregular intervals.
</summary>
</histogram>
<histogram name="Quota.TotalDiskSpaceIsZero" enum="BooleanVolumeZero"
expires_after="2023-11-12">
<owner>ayui@chromium.org</owner>
<owner>chrome-owp-storage@google.com</owner>
<summary>
Whether base::SysInfo::AmountOfTotalDiskSpace() returned zero or a negative
number to the quota system. Logged whenever something is pinging the system
for quota or device info.
</summary>
</histogram>
<histogram name="Quota.UsageByOrigin" units="MB" expires_after="2024-05-24">
<owner>ayui@chromium.org</owner>
<owner>chrome-owp-storage@google.com</owner>
<summary>
Disk space (in MB) currently used by an origin. Logged hourly.
</summary>
</histogram>
</histograms>
</histogram-configuration>