| <!-- |
| Copyright 2020 The Chromium Authors. All rights reserved. |
| 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 Background 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 send CLs to chromium-metrics-reviews@google.com rather than to specific |
| individuals. These CLs will be automatically reassigned to a reviewer within |
| about 5 minutes. This approach helps the metrics team to load-balance incoming |
| reviews. Googlers can read more about this at go/gwsq-gerrit. |
| --> |
| |
| <histogram-configuration> |
| |
| <histograms> |
| |
| <histogram base="true" name="BackgroundFetch.EventDispatchFailure.Dispatch" |
| enum="ServiceWorkerStatusCode" expires_after="2021-06-30"> |
| <!-- Name completed by histogram_suffixes name="BackgroundFetchEvents" --> |
| |
| <owner>peter@chromium.org</owner> |
| <owner>rayankans@chromium.org</owner> |
| <summary> |
| Records the Service Worker status code that caused a Background Fetch API |
| event to fail dispatching whilst trying to dispatch an event on the active |
| Service Worker. |
| </summary> |
| </histogram> |
| |
| <histogram base="true" name="BackgroundFetch.EventDispatchFailure.FindWorker" |
| enum="ServiceWorkerStatusCode" expires_after="2021-06-30"> |
| <!-- Name completed by histogram_suffixes name="BackgroundFetchEvents" --> |
| |
| <owner>peter@chromium.org</owner> |
| <owner>rayankans@chromium.org</owner> |
| <summary> |
| Records the Service Worker status code that caused a Background Fetch API |
| event to fail dispatching whilst trying to find the Service Worker. |
| </summary> |
| </histogram> |
| |
| <histogram base="true" name="BackgroundFetch.EventDispatchFailure.StartWorker" |
| enum="ServiceWorkerStatusCode" expires_after="2021-06-30"> |
| <!-- Name completed by histogram_suffixes name="BackgroundFetchEvents" --> |
| |
| <owner>peter@chromium.org</owner> |
| <owner>rayankans@chromium.org</owner> |
| <summary> |
| Records the Service Worker status code that caused a Background Fetch API |
| event to fail dispatching whilst trying to start the active Service Worker. |
| </summary> |
| </histogram> |
| |
| <histogram base="true" name="BackgroundFetch.EventDispatchResult" |
| enum="BackgroundFetchEventDispatchResult" expires_after="2021-06-30"> |
| <!-- Name completed by histogram_suffixes name="BackgroundFetchEvents" --> |
| |
| <owner>peter@chromium.org</owner> |
| <owner>rayankans@chromium.org</owner> |
| <summary> |
| Records the result of dispatching one of the Background Fetch API events to |
| the Service Worker associated with the event. |
| </summary> |
| </histogram> |
| |
| <histogram name="BackgroundFetch.HasDuplicateRequests" enum="Boolean" |
| expires_after="2021-06-30"> |
| <owner>peter@chromium.org</owner> |
| <owner>rayankans@chromium.org</owner> |
| <summary> |
| Records whether the fetch requests contains any duplicate URLs. This is |
| called after the provided requests are verified, but before the fetch is |
| started. |
| </summary> |
| </histogram> |
| |
| <histogram name="BackgroundFetch.HasRequestsWithBody" enum="Boolean" |
| expires_after="2021-06-30"> |
| <owner>nator@chromium.org</owner> |
| <owner>rayankans@chromium.org</owner> |
| <owner>peter@chromium.org</owner> |
| <summary> |
| Records whether the background fetch contains any requests with a body. |
| Called before the fetch is started. |
| </summary> |
| </histogram> |
| |
| <histogram name="BackgroundFetch.IncompleteFetchesOnStartup" units="units" |
| expires_after="M95"> |
| <owner>rayankans@chromium.org</owner> |
| <owner>peter@chromium.org</owner> |
| <summary> |
| Records the number of Background Fetch registrations found on browser |
| start-up. This is called after the initialization database task runs |
| successfully. |
| </summary> |
| </histogram> |
| |
| <histogram base="true" name="BackgroundFetch.Manager" units="ms" |
| expires_after="M95"> |
| <!-- Name completed by histogram_suffixes name="BackgroundFetchManagerAPIsDuration" --> |
| |
| <owner>rayankans@chromium.org</owner> |
| <owner>peter@chromium.org</owner> |
| <summary> |
| Records the duration of the mojo call for the exposed BackgroundFetchManager |
| APIs. |
| </summary> |
| </histogram> |
| |
| <histogram name="BackgroundFetch.MatchCalledFromDocumentScope" |
| enum="ScopeMatchCalledFrom" expires_after="2021-11-30"> |
| <owner>nator@chromium.org</owner> |
| <owner>rayankans@chromium.org</owner> |
| <owner>peter@chromium.org</owner> |
| <summary> |
| Records whether match() or matchAll() was called from Document Scope. Called |
| when match() or matchAll() is invoked in the renderer process. |
| </summary> |
| </histogram> |
| |
| <histogram name="BackgroundFetch.MatchCalledWhenFetchIsIncomplete" |
| enum="FetchStatusWhenMatchCalled" expires_after="2021-11-30"> |
| <owner>nator@chromium.org</owner> |
| <owner>rayankans@chromium.org</owner> |
| <owner>peter@chromium.org</owner> |
| <summary> |
| Records whether match() or matchAll() was called when the background fetch |
| was incomplete. Called when match() or matchAll() is invoked in the renderer |
| process. |
| </summary> |
| </histogram> |
| |
| <histogram name="BackgroundFetch.PercentOfRequestsForWhichUpdatesAreSent" |
| units="%" expires_after="2021-11-30"> |
| <owner>nator@chromium.org</owner> |
| <owner>rayankans@chromium.org</owner> |
| <owner>peter@chromium.org</owner> |
| <summary> |
| Records the percent of requests for which updates are received in the |
| renderer process from the browser process. Called when the completion event |
| for a background fetch has finished processing. |
| </summary> |
| </histogram> |
| |
| <histogram base="true" name="BackgroundFetch.Storage" |
| enum="BackgroundFetchStorageError" expires_after="M95"> |
| <!-- Name completed by histogram_suffixes name="BackgroundFetchDatabaseStorageErrors" --> |
| |
| <owner>rayankans@chromium.org</owner> |
| <owner>peter@chromium.org</owner> |
| <summary>Records the storage error when running a database task.</summary> |
| </histogram> |
| |
| <histogram name="BackgroundMode.BackgroundApplicationsCount" units="units" |
| expires_after="2021-09-12"> |
| <owner>atwilson@chromium.org</owner> |
| <owner>mvanouwerkerk@chromium.org</owner> |
| <summary> |
| The number of background applications (extensions) for a profile that were |
| loaded after the profile was registered with the BackgroundModeManager. |
| </summary> |
| </histogram> |
| |
| <histogram name="BackgroundMode.BackgroundModeEnabledPrefChanged" |
| enum="BooleanEnabled" expires_after="2020-09-01"> |
| <owner>mvanouwerkerk@chromium.org</owner> |
| <owner>peter@chromium.org</owner> |
| <summary> |
| Logged if BackgroundModeManager is running and listening for pref changes, |
| and the pref does indeed change. The new value is logged. |
| </summary> |
| </histogram> |
| |
| <histogram name="BackgroundMode.MenuItemClick" enum="BackgroundModeMenuItem" |
| expires_after="2020-09-01"> |
| <owner>mvanouwerkerk@chromium.org</owner> |
| <owner>peter@chromium.org</owner> |
| <summary> |
| Logged when an item in the system tray icon menu is clicked. |
| </summary> |
| </histogram> |
| |
| <histogram name="BackgroundMode.OnStartup.AutoLaunchState" |
| enum="AutoLaunchState" expires_after="2021-10-04"> |
| <owner>mvanouwerkerk@chromium.org</owner> |
| <owner>rdevlin.cronin@chromium.org</owner> |
| <summary> |
| Logged during BackgroundModeManager's initialization. Indicates the |
| AutoLaunchState the current browser process was launched in. |
| </summary> |
| </histogram> |
| |
| <histogram name="BackgroundMode.OnStartup.IsBackgroundModePrefEnabled" |
| enum="BooleanEnabled" expires_after="2021-10-04"> |
| <owner>mvanouwerkerk@chromium.org</owner> |
| <owner>rdevlin.cronin@chromium.org</owner> |
| <summary> |
| Logged during BackgroundModeManager's initialization. Indicates the state of |
| the kBackgroundModeEnabled pref on startup. |
| </summary> |
| </histogram> |
| |
| <histogram name="BackgroundMode.TimeBeforeOptimizedRestart" units="ms" |
| expires_after="2020-09-01"> |
| <owner>peter@chromium.org</owner> |
| <owner>mvanouwerkerk@chromium.org</owner> |
| <summary> |
| The duration of a session before the browser got restarted in the background |
| by the BackgroundOptimizer to purge the memory. |
| </summary> |
| </histogram> |
| |
| <histogram name="BackgroundSync.Event.BatchSize" units="units" |
| expires_after="2021-08-29"> |
| <owner>nator@chromium.org</owner> |
| <owner>rayankans@chromium.org</owner> |
| <summary> |
| Records the number of `sync` events which were fired in a batch. A batch is |
| defined as the set of `sync` events dispatched at the same time by the |
| BackgroundSyncManager. One-shots usually run individually (a batch of one), |
| unless the device was offline and multiple are waiting for the device to go |
| back online. |
| </summary> |
| </histogram> |
| |
| <histogram name="BackgroundSync.Event.FromWakeupTask" |
| enum="BackgroundSyncWakeupTask" expires_after="2021-07-31"> |
| <owner>nator@chromium.org</owner> |
| <owner>rayankans@chromium.org</owner> |
| <summary> |
| Records whether the fired `sync` events upon completion orginated from a |
| background wakeup task or the foreground. |
| </summary> |
| </histogram> |
| |
| <histogram name="BackgroundSync.Event.OneShotResultPattern" |
| enum="BackgroundSyncResultPattern" expires_after="2021-08-29"> |
| <owner>nator@chromium.org</owner> |
| <owner>rayankans@chromium.org</owner> |
| <summary> |
| Records whether a `sync` event succeeded or failed and whether the sync |
| event finished in the foreground or background. |
| </summary> |
| <details> |
| A `sync` event finished in the foreground if the associated Service Worker |
| Registration has a client at the time that the event finished. |
| </details> |
| </histogram> |
| |
| <histogram name="BackgroundSync.Event.OneShotStartedInForeground" |
| enum="BooleanInForeground" expires_after="2021-08-29"> |
| <owner>nator@chromium.org</owner> |
| <owner>rayankans@chromium.org</owner> |
| <summary> |
| Records whether a one-shot sync started firing in the foreground or |
| background. Called shortly before the event is fired. |
| </summary> |
| </histogram> |
| |
| <histogram name="BackgroundSync.Event.PeriodicResultPattern" |
| enum="BackgroundSyncResultPattern" expires_after="2021-07-31"> |
| <owner>nator@chromium.org</owner> |
| <owner>rayankans@chromium.org</owner> |
| <owner>peter@chromium.org</owner> |
| <summary> |
| Records whether a periodic sync event succeeded or failed and whether the |
| sync event finished in the foreground or background. |
| </summary> |
| <details> |
| A sync event finished in the foreground if the associated Service Worker |
| Registration has a client at the time that the event finished. |
| </details> |
| </histogram> |
| |
| <histogram name="BackgroundSync.Event.PeriodicStartedInForeground" |
| enum="BooleanInForeground" expires_after="2021-07-31"> |
| <owner>nator@chromium.org</owner> |
| <owner>rayankans@chromium.org</owner> |
| <owner>peter@chromium.org</owner> |
| <summary> |
| Records whether a periodic sync event started firing in the foreground or |
| background. Called shortly before the event is fired. |
| </summary> |
| </histogram> |
| |
| <histogram name="BackgroundSync.Event.Time" units="ms" |
| expires_after="2021-08-29"> |
| <owner>nator@chromium.org</owner> |
| <owner>rayankans@chromium.org</owner> |
| <summary> |
| Time taken to execute a batch of one-shot sync events. A batch is defined as |
| the set of sync events dispatched at the same time by the |
| BackgroundSyncManager. One-shots usually run individually (a batch of one), |
| unless the device was offline and multiple are waiting for the device to go |
| back online. |
| </summary> |
| </histogram> |
| |
| <histogram name="BackgroundSync.LaunchTask.PlayServicesAvailable" |
| enum="Boolean" expires_after="2021-09-19"> |
| <owner>nator@chromium.org</owner> |
| <owner>rayankans@chromium.org</owner> |
| <summary> |
| Records whether Google Play Services is available to the Background Sync |
| system on Android, for scheduling future sync events when the browser is not |
| running. This will be logged at most once per run. |
| </summary> |
| </histogram> |
| |
| <histogram name="BackgroundSync.NetworkObserver.HasPermission" enum="Boolean" |
| expires_after="2021-06-30"> |
| <owner>nator@chromium.org</owner> |
| <owner>rayankans@chromium.org</owner> |
| <summary> |
| Records whether the browser has sufficient permissions to create a |
| BackgroundSyncNetworkObserver object on Android, at the point when it tries |
| to create it. This should never be false, but is being tracked in order to |
| help resolve crbug.com/545473. |
| </summary> |
| </histogram> |
| |
| <histogram name="BackgroundSync.Periodic.Wakeup.DelayTime" units="ms" |
| expires_after="2021-07-31"> |
| <owner>nator@chromium.org</owner> |
| <owner>peter@chromium.org</owner> |
| <owner>rayankans@chromium.org</owner> |
| <summary> |
| Records time elapsed since the soonest expected wake-up time. Recorded |
| whenever a periodic Background Sync Chrome wake-up task is called after |
| loading the native parts of the browser. |
| </summary> |
| </histogram> |
| |
| <histogram name="BackgroundSync.Registration.OneShot" |
| enum="BackgroundSyncStatus" expires_after="2021-10-10"> |
| <owner>nator@chromium.org</owner> |
| <owner>rayankans@chromium.org</owner> |
| <summary> |
| Records the result of attempting to register a one-shot sync. |
| </summary> |
| </histogram> |
| |
| <histogram name="BackgroundSync.Registration.OneShot.CouldFire" |
| enum="BooleanCouldFireImmediately" expires_after="2021-08-09"> |
| <owner>nator@chromium.org</owner> |
| <owner>rayankans@chromium.org</owner> |
| <summary> |
| Records the result of attempting to register a one-shot sync in a situation |
| where the sync could fire immediately. |
| </summary> |
| </histogram> |
| |
| <histogram |
| name="BackgroundSync.Registration.OneShot.EventSucceededAtCompletion" |
| enum="BooleanSuccess" expires_after="2021-09-12"> |
| <owner>nator@chromium.org</owner> |
| <owner>rayankans@chromium.org</owner> |
| <owner>peter@chromium.org</owner> |
| <summary> |
| Records whether the dispatched sync event succeeded at the completion of the |
| one-shot Background Sync registration. |
| </summary> |
| </histogram> |
| |
| <histogram name="BackgroundSync.Registration.OneShot.IsDuplicate" |
| enum="BooleanRegistrationIsDuplicate" expires_after="2021-06-30"> |
| <owner>nator@chromium.org</owner> |
| <owner>rayankans@chromium.org</owner> |
| <summary> |
| Records whether a one-shot sync registration exactly duplicates an existing |
| registered sync. |
| </summary> |
| </histogram> |
| |
| <histogram |
| name="BackgroundSync.Registration.OneShot.NumAttemptsForSuccessfulEvent" |
| units="attempts" expires_after="2021-09-12"> |
| <owner>nator@chromium.org</owner> |
| <owner>rayankans@chromium.org</owner> |
| <summary> |
| Records the number of times a sync event was dispatched for a one-shot |
| Background Sync registration before it succeeded. |
| </summary> |
| </histogram> |
| |
| <histogram name="BackgroundSync.Registration.Periodic" |
| enum="BackgroundSyncStatus" expires_after="2021-10-10"> |
| <owner>nator@chromium.org</owner> |
| <owner>rayankans@chromium.org</owner> |
| <summary> |
| Records the result of attempting to register a periodic sync. This is called |
| at each successful registration. |
| </summary> |
| </histogram> |
| |
| <histogram name="BackgroundSync.Registration.Periodic.IsDuplicate" |
| enum="BooleanRegistrationIsDuplicate" expires_after="2021-07-31"> |
| <owner>nator@chromium.org</owner> |
| <owner>rayankans@chromium.org</owner> |
| <summary> |
| Records whether a periodic sync registration duplicates the tag of an |
| existing registered sync. Recorded upon each successful periodic Background |
| Sync registration. |
| </summary> |
| </histogram> |
| |
| <histogram name="BackgroundSync.Registration.Periodic.MinInterval" |
| units="seconds" expires_after="2021-07-31"> |
| <owner>nator@chromium.org</owner> |
| <owner>rayankans@chromium.org</owner> |
| <summary> |
| Records the minInterval requested, in seconds, when a periodic sync is |
| successfully registered. |
| </summary> |
| </histogram> |
| |
| <histogram name="BackgroundSync.Unregistration.Periodic" |
| enum="BackgroundSyncStatus" expires_after="2021-07-31"> |
| <owner>nator@chromium.org</owner> |
| <owner>platform-capabilities@chromium.org</owner> |
| <summary> |
| Records the result of attempting to unregister a periodic sync. |
| </summary> |
| </histogram> |
| |
| <histogram name="BackgroundSync.Wakeup.DelayTime" units="ms" |
| expires_after="2021-07-31"> |
| <owner>nator@chromium.org</owner> |
| <owner>peter@chromium.org</owner> |
| <owner>rayankans@chromium.org</owner> |
| <summary> |
| If BackgroundSync uses BackgroundTaskScheduler to wake up Chrome, this |
| records the time elapsed since the soonest expected wake-up time. Recorded |
| whenever a BackgroundSync background task is called after loading the native |
| parts of the browser. |
| </summary> |
| </histogram> |
| |
| <histogram name="BackgroundSync.WakeupTaskFiredEvents.OneShot" |
| enum="BackgroundSyncFiredEvents" expires_after="2021-07-31"> |
| <owner>nator@chromium.org</owner> |
| <owner>peter@chromium.org</owner> |
| <owner>rayankans@chromium.org</owner> |
| <summary> |
| If Chrome is woken up by the one shot Background Sync Background task, this |
| records whether any sync events were fired as a result. Recorded whenever |
| Chrome is woken up to process one-shot Background Sync registrations on |
| Android. |
| </summary> |
| </histogram> |
| |
| <histogram name="BackgroundSync.WakeupTaskFiredEvents.Periodic" |
| enum="BackgroundSyncFiredEvents" expires_after="2021-07-31"> |
| <owner>nator@chromium.org</owner> |
| <owner>peter@chromium.org</owner> |
| <owner>rayankans@chromium.org</owner> |
| <summary> |
| If Chrome is woken up by the periodic Background Sync Background task,this |
| records whether any periodicsync events were fired as a result. Recorded |
| whenever Chrome is woken up to process periodic Background Sync |
| registrations on Android. |
| </summary> |
| </histogram> |
| |
| <histogram name="BackgroundTracing.SamplingProfilerUnwindResult" |
| enum="SamplingProfilerUnwindResult" expires_after="M71"> |
| <owner>ssid@chromium.org</owner> |
| <summary>Records the reason for unwind failues in sampling profiler.</summary> |
| </histogram> |
| |
| </histograms> |
| |
| </histogram-configuration> |