forked from chromium/chromium
-
Notifications
You must be signed in to change notification settings - Fork 0
/
app_list_metrics.h
264 lines (215 loc) · 9.75 KB
/
app_list_metrics.h
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
// Copyright 2018 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#ifndef ASH_APP_LIST_APP_LIST_METRICS_H_
#define ASH_APP_LIST_APP_LIST_METRICS_H_
#include "ash/ash_export.h"
#include "ash/public/cpp/app_list/app_list_types.h"
#include "base/time/time.h"
#include "third_party/abseil-cpp/absl/types/optional.h"
#include "ui/events/event.h"
namespace ash {
// UMA histograms that record app list sort reorder animation smoothness.
// Exposed in this header because it is needed in tests.
ASH_EXPORT extern const char kClamshellReorderAnimationSmoothnessHistogram[];
ASH_EXPORT extern const char kTabletReorderAnimationSmoothnessHistogram[];
// UMA histograms that record app list sort reorder actions. Exposed in this
// header because it is needed in tests.
ASH_EXPORT extern const char kClamshellReorderActionHistogram[];
ASH_EXPORT extern const char kTabletReorderActionHistogram[];
// UMA histograms that record app list drag reorder animation smoothness.
// Exposed in this header because it is needed in tests.
ASH_EXPORT extern const char
kClamshellDragReorderAnimationSmoothnessHistogram[];
ASH_EXPORT extern const char kTabletDragReorderAnimationSmoothnessHistogram[];
// UMA histograms that records the number of files removed per user per session
// from the launcher continue section. Exposed in this header because it is
// needed in tests.
ASH_EXPORT extern const char kContinueSectionFilesRemovedInSessionHistogram[];
// These are used in histograms, do not remove/renumber entries. If you're
// adding to this enum with the intention that it will be logged, update the
// AppListResultRemovalConfirmation enum listing in
// tools/metrics/histograms/enums.xml.
enum class SearchResultRemovalConfirmation {
kRemovalConfirmed = 0,
kRemovalCanceled = 1,
kMaxValue = kRemovalCanceled,
};
// The two versions of folders. These values are written to logs. New enum
// values can be added, but existing enums must never be renumbered or deleted
// and reused.
enum AppListFolderOpened {
kOldFolders = 0,
kFullscreenAppListFolders = 1,
kMaxFolderOpened = 2,
};
// The valid AppListState transitions. These values are written to logs. New
// enum values can be added, but existing enums must never be renumbered or
// deleted and reused. If adding a state transition, add it to the switch
// statement in AppListView::GetAppListStateTransitionSource.
enum AppListStateTransitionSource {
kFullscreenAllAppsToClosed = 0,
kFullscreenAllAppsToFullscreenSearch = 1,
// Usage removed.
// kFullscreenAllAppsToPeeking = 2,
kFullscreenSearchToClosed = 3,
kFullscreenSearchToFullscreenAllApps = 4,
// Usage removed.
// kHalfToClosed = 5,
// KHalfToFullscreenSearch = 6,
// kHalfToPeeking = 7,
// kPeekingToClosed = 8,
// kPeekingToFullscreenAllApps = 9,
// kPeekingToHalf = 10,
kMaxAppListStateTransition = 11,
};
// The different ways to change pages in the app list's app grid. These values
// are written to logs. New enum values can be added, but existing enums must
// never be renumbered or deleted and reused.
enum AppListPageSwitcherSource {
kTouchPageIndicator = 0,
kClickPageIndicator = 1,
kSwipeAppGrid = 2,
kFlingAppGrid = 3,
kMouseWheelScroll = 4,
kMousePadScroll = 5,
kDragAppToBorder = 6,
kMoveAppWithKeyboard = 7,
kMouseDrag = 8,
kMaxAppListPageSwitcherSource = 9,
};
// The different ways to move an app in app list's apps grid. These values are
// written to logs. New enum values can be added, but existing enums must never
// be renumbered or deleted and reused.
enum AppListAppMovingType {
kMoveByDragIntoFolder = 0,
kMoveByDragOutOfFolder = 1,
kMoveIntoAnotherFolder = 2,
kReorderByDragInFolder = 3,
kReorderByDragInTopLevel = 4,
kReorderByKeyboardInFolder = 5,
kReorderByKeyboardInTopLevel = 6,
kMoveByKeyboardIntoFolder = 7,
kMoveByKeyboardOutOfFolder = 8,
kMaxAppListAppMovingType = 9,
};
// The presence of Drive QuickAccess search results when updating the zero-state
// results list. These values are persisted to logs. Entries should not be
// renumbered and numeric values should never be reused.
enum class DriveQuickAccessResultPresence {
kPresentAndShown = 0,
kPresentAndNotShown = 1,
kAbsent = 2,
kMaxValue = kAbsent
};
// Different places a search result can be launched from. These values do not
// persist to logs, so can be changed as-needed. However, changes should be
// reflected in RecordSearchLaunchIndexAndQueryLength().
enum SearchResultLaunchLocation {
kResultList = 0,
kTileList = 1,
};
// Different ways to trigger launcher animation in tablet mode.
enum TabletModeAnimationTransition {
// Click the Home button in tablet mode.
kHomeButtonShow,
// Activate a window from shelf to hide the launcher in tablet mode.
kHideHomeLauncherForWindow,
// Enter the kFullscreenAllApps state (usually by deactivating the search box)
kEnterFullscreenAllApps,
// Enter the kFullscreenSearch state (usually by activating the search box).
kEnterFullscreenSearch,
// Enter the overview mode in tablet, with overview fading in instead of
// sliding (as is the case with kEnterOverviewMode).
kFadeInOverview,
// Exit the overview mode in tablet, with overview fading out instead of
// sliding (as is the case with kExitOverviewMode).
kFadeOutOverview,
};
// Different actions that complete a user workflow within the launcher UI.
// Used as bucket values in histograms that track completed user actions within
// the launcher - do not remove/renumber existing items.
enum class AppListUserAction {
// User launched an app from the apps grid within the app list UI.
kAppLaunchFromAppsGrid = 0,
// User launched an app from list of recent apps within the app list UI.
kAppLaunchFromRecentApps = 1,
// User opened a non-app search result from the app list search results page.
kOpenSearchResult = 2,
// User opened an app search result from the app list search result page.
kOpenAppSearchResult = 3,
// User opened an item shown in continue section within the app list UI.
kOpenContinueSectionTask = 4,
// User opened a suggestion chip shown in the app list UI.
kOpenSuggestionChip = 5,
kMaxValue = kOpenSuggestionChip,
};
// Whether and how user-entered search box text matches up with the first search
// result. These values are persisted to logs. Entries should not be renumbered
// and numeric values should never be reused.
enum class SearchBoxTextMatch {
// The user entered query does not match the first search result. Autocomplete
// is not triggered.
kNoMatch = 0,
// The user entered query matches the prefix of the first search result.
kPrefixMatch = 1,
// The user entered query is a substring of the first search result.
kSubstringMatch = 2,
// The user's query does not match the first search result but autocomplete is
// triggered.
kAutocompletedWithoutMatch = 3,
kMaxValue = kAutocompletedWithoutMatch,
};
// Parameters to call RecordAppListAppLaunched. Passed to code that does not
// directly have access to them, such ash AppListMenuModelAdapter.
struct AppLaunchedMetricParams {
AppLaunchedMetricParams();
AppLaunchedMetricParams(AppListLaunchedFrom launched_from,
AppListLaunchType launch_type);
AppLaunchedMetricParams(const AppLaunchedMetricParams&);
AppLaunchedMetricParams& operator=(const AppLaunchedMetricParams&);
~AppLaunchedMetricParams();
AppListLaunchedFrom launched_from = AppListLaunchedFrom::kLaunchedFromGrid;
AppListLaunchType launch_type = AppListLaunchType::kSearchResult;
AppListViewState app_list_view_state = AppListViewState::kClosed;
bool is_tablet_mode = false;
bool app_list_shown = false;
absl::optional<base::TimeTicks> launcher_show_timestamp;
};
void AppListRecordPageSwitcherSourceByEventType(ui::EventType type);
void RecordPageSwitcherSource(AppListPageSwitcherSource source);
void RecordSearchResultRemovalDialogDecision(
SearchResultRemovalConfirmation removal_decision);
void RecordAppListUserJourneyTime(AppListShowSource source,
base::TimeDelta time);
// Records metrics periodically (see interval in UserMetricsRecorder).
void RecordPeriodicAppListMetrics();
ASH_EXPORT void RecordAppListAppLaunched(AppListLaunchedFrom launched_from,
AppListViewState app_list_state,
bool is_tablet_mode,
bool app_list_shown);
ASH_EXPORT void RecordLauncherWorkflowMetrics(
AppListUserAction action,
bool is_tablet_mode,
absl::optional<base::TimeTicks> launcher_show_time);
ASH_EXPORT bool IsCommandIdAnAppLaunch(int command_id);
ASH_EXPORT void ReportPaginationSmoothness(int smoothness);
ASH_EXPORT void ReportCardifiedSmoothness(bool is_entering_cardified,
int smoothness);
void ReportReorderAnimationSmoothness(bool in_tablet, int smoothness);
void RecordAppListSortAction(AppListSortOrder new_order, bool in_tablet);
void ReportItemDragReorderAnimationSmoothness(bool in_tablet, int smoothness);
// Invoked when the app list session ends, records metrics of interest during
// the session.
void RecordMetricsOnSessionEnd();
// Records the number of files that have been removed from the Launcher Continue
// Section in the session. This also increments the internal counter to keep
// track of the number of files that have been removed.
void RecordCumulativeContinueSectionResultRemovedNumber();
// Resets the count for the number of files that have been removed from the
// Launcher Continue Section in the session.
void ResetContinueSectionFileRemovedCountForTest();
// Records a metric for whether the user has hidden the continue section.
void RecordHideContinueSectionMetric();
} // namespace ash
#endif // ASH_APP_LIST_APP_LIST_METRICS_H_