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
|
// Copyright 2013 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.
#ifndef ASH_METRICS_USER_METRICS_RECORDER_H_
#define ASH_METRICS_USER_METRICS_RECORDER_H_
#include "ash/ash_export.h"
#include "ash/metrics/task_switch_metrics_recorder.h"
#include "base/macros.h"
#include "base/memory/scoped_ptr.h"
#include "base/timer/timer.h"
namespace ash {
class DesktopTaskSwitchMetricRecorder;
namespace test {
class UserMetricsRecorderTestAPI;
}
enum UserMetricsAction {
UMA_ACCEL_EXIT_FIRST_Q,
UMA_ACCEL_EXIT_SECOND_Q,
UMA_ACCEL_KEYBOARD_BRIGHTNESS_DOWN_F6,
UMA_ACCEL_KEYBOARD_BRIGHTNESS_UP_F7,
UMA_ACCEL_LOCK_SCREEN_LOCK_BUTTON,
UMA_ACCEL_LOCK_SCREEN_POWER_BUTTON,
UMA_ACCEL_MAXIMIZE_RESTORE_F4,
UMA_ACCEL_PREVWINDOW_F5,
UMA_ACCEL_RESTART_POWER_BUTTON,
UMA_ACCEL_SHUT_DOWN_POWER_BUTTON,
UMA_CLOSE_THROUGH_CONTEXT_MENU,
UMA_DESKTOP_SWITCH_TASK,
UMA_DRAG_MAXIMIZE_LEFT,
UMA_DRAG_MAXIMIZE_RIGHT,
UMA_LAUNCHER_BUTTON_PRESSED_WITH_MOUSE,
UMA_LAUNCHER_BUTTON_PRESSED_WITH_TOUCH,
UMA_LAUNCHER_CLICK_ON_APP,
UMA_LAUNCHER_CLICK_ON_APPLIST_BUTTON,
UMA_LAUNCHER_LAUNCH_TASK,
UMA_LAUNCHER_MINIMIZE_TASK,
UMA_LAUNCHER_SWITCH_TASK,
UMA_MAXIMIZE_MODE_DISABLED,
UMA_MAXIMIZE_MODE_ENABLED,
UMA_MAXIMIZE_MODE_INITIALLY_DISABLED,
UMA_MOUSE_DOWN,
UMA_PANEL_MINIMIZE_CAPTION_CLICK,
UMA_PANEL_MINIMIZE_CAPTION_GESTURE,
UMA_SHELF_ALIGNMENT_SET_BOTTOM,
UMA_SHELF_ALIGNMENT_SET_LEFT,
UMA_SHELF_ALIGNMENT_SET_RIGHT,
UMA_STATUS_AREA_AUDIO_CURRENT_INPUT_DEVICE,
UMA_STATUS_AREA_AUDIO_CURRENT_OUTPUT_DEVICE,
UMA_STATUS_AREA_AUDIO_SWITCH_INPUT_DEVICE,
UMA_STATUS_AREA_AUDIO_SWITCH_OUTPUT_DEVICE,
UMA_STATUS_AREA_BRIGHTNESS_CHANGED,
UMA_STATUS_AREA_BLUETOOTH_CONNECT_KNOWN_DEVICE,
UMA_STATUS_AREA_BLUETOOTH_CONNECT_UNKNOWN_DEVICE,
UMA_STATUS_AREA_BLUETOOTH_DISABLED,
UMA_STATUS_AREA_BLUETOOTH_ENABLED,
UMA_STATUS_AREA_CAPS_LOCK_DETAILED,
UMA_STATUS_AREA_CAPS_LOCK_DISABLED_BY_CLICK,
UMA_STATUS_AREA_CAPS_LOCK_ENABLED_BY_CLICK,
UMA_STATUS_AREA_CAPS_LOCK_POPUP,
UMA_STATUS_AREA_CAST_STOP_CAST,
UMA_STATUS_AREA_CONNECT_TO_CONFIGURED_NETWORK,
UMA_STATUS_AREA_CONNECT_TO_UNCONFIGURED_NETWORK,
UMA_STATUS_AREA_CONNECT_TO_VPN,
UMA_STATUS_AREA_CHANGED_VOLUME_MENU,
UMA_STATUS_AREA_CHANGED_VOLUME_POPUP,
UMA_STATUS_AREA_DETAILED_ACCESSABILITY,
UMA_STATUS_AREA_DETAILED_AUDIO_VIEW,
UMA_STATUS_AREA_DETAILED_BLUETOOTH_VIEW,
UMA_STATUS_AREA_DETAILED_BRIGHTNESS_VIEW,
UMA_STATUS_AREA_DETAILED_CAST_VIEW,
UMA_STATUS_AREA_DETAILED_CAST_VIEW_LAUNCH_CAST,
UMA_STATUS_AREA_DETAILED_DRIVE_VIEW,
UMA_STATUS_AREA_DETAILED_NETWORK_VIEW,
UMA_STATUS_AREA_DETAILED_VPN_VIEW,
UMA_STATUS_AREA_DISABLE_AUTO_CLICK,
UMA_STATUS_AREA_DISABLE_HIGH_CONTRAST,
UMA_STATUS_AREA_DISABLE_LARGE_CURSOR,
UMA_STATUS_AREA_DISABLE_MAGNIFIER,
UMA_STATUS_AREA_DISABLE_SPOKEN_FEEDBACK,
UMA_STATUS_AREA_DISABLE_WIFI,
UMA_STATUS_AREA_DISABLE_VIRTUAL_KEYBOARD,
UMA_STATUS_AREA_DRIVE_CANCEL_OPERATION,
UMA_STATUS_AREA_DRIVE_SETTINGS,
UMA_STATUS_AREA_ENABLE_AUTO_CLICK,
UMA_STATUS_AREA_ENABLE_HIGH_CONTRAST,
UMA_STATUS_AREA_ENABLE_LARGE_CURSOR,
UMA_STATUS_AREA_ENABLE_MAGNIFIER,
UMA_STATUS_AREA_ENABLE_SPOKEN_FEEDBACK,
UMA_STATUS_AREA_ENABLE_WIFI,
UMA_STATUS_AREA_ENABLE_VIRTUAL_KEYBOARD,
UMA_STATUS_AREA_IME_SHOW_DETAILED,
UMA_STATUS_AREA_IME_SWITCH_MODE,
UMA_STATUS_AREA_MENU_OPENED,
UMA_STATUS_AREA_NETWORK_JOIN_OTHER_CLICKED,
UMA_STATUS_AREA_NETWORK_SETTINGS_CLICKED,
UMA_STATUS_AREA_SHOW_NETWORK_CONNECTION_DETAILS,
UMA_STATUS_AREA_SHOW_VPN_CONNECTION_DETAILS,
UMA_STATUS_AREA_SIGN_OUT,
UMA_STATUS_AREA_VPN_ADD_BUILT_IN_CLICKED,
UMA_STATUS_AREA_VPN_ADD_THIRD_PARTY_CLICKED,
UMA_STATUS_AREA_VPN_DISCONNECT_CLICKED,
UMA_STATUS_AREA_VPN_SETTINGS_CLICKED,
UMA_TOGGLE_MAXIMIZE_CAPTION_CLICK,
UMA_TOGGLE_MAXIMIZE_CAPTION_GESTURE,
UMA_TOGGLE_SINGLE_AXIS_MAXIMIZE_BORDER_CLICK,
UMA_TOUCHPAD_GESTURE_OVERVIEW,
UMA_TOUCHSCREEN_TAP_DOWN,
UMA_TRAY_HELP,
UMA_TRAY_LOCK_SCREEN,
UMA_TRAY_OVERVIEW,
UMA_TRAY_SHUT_DOWN,
UMA_WINDOW_APP_CLOSE_BUTTON_CLICK,
UMA_WINDOW_CLOSE_BUTTON_CLICK,
UMA_WINDOW_MAXIMIZE_BUTTON_CLICK_EXIT_FULLSCREEN,
UMA_WINDOW_MAXIMIZE_BUTTON_CLICK_MAXIMIZE,
UMA_WINDOW_MAXIMIZE_BUTTON_CLICK_MINIMIZE,
UMA_WINDOW_MAXIMIZE_BUTTON_CLICK_RESTORE,
UMA_WINDOW_MAXIMIZE_BUTTON_MAXIMIZE_LEFT,
UMA_WINDOW_MAXIMIZE_BUTTON_MAXIMIZE_RIGHT,
// Thumbnail sized overview of windows triggered by pressing the overview key.
UMA_WINDOW_OVERVIEW,
// User selected a window in overview mode different from the
// previously-active window.
UMA_WINDOW_OVERVIEW_ACTIVE_WINDOW_CHANGED,
// Selecting a window in overview mode by pressing the enter key.
UMA_WINDOW_OVERVIEW_ENTER_KEY,
// Window selection started by beginning an alt+tab cycle. This does not count
// each step through an alt+tab cycle.
UMA_WINDOW_CYCLE,
};
// User Metrics Recorder provides a repeating callback (RecordPeriodicMetrics)
// on a timer to allow recording of state data over time to the UMA records.
// Any additional states (in ash) that require monitoring can be added to
// this class. As well calls to record on action metrics
// (RecordUserMetricsAction) are passed through the UserMetricsRecorder.
class ASH_EXPORT UserMetricsRecorder {
public:
// Creates a UserMetricsRecorder that records metrics periodically. Equivalent
// to calling UserMetricsRecorder(true).
UserMetricsRecorder();
virtual ~UserMetricsRecorder();
// Records an Ash owned user action.
void RecordUserMetricsAction(ash::UserMetricsAction action);
TaskSwitchMetricsRecorder& task_switch_metrics_recorder() {
return task_switch_metrics_recorder_;
}
// Informs |this| that the Shell has been initialized.
void OnShellInitialized();
// Informs |this| that the Shell is going to be shut down.
void OnShellShuttingDown();
private:
friend class test::UserMetricsRecorderTestAPI;
// Creates a UserMetricsRecorder and will only record periodic metrics if
// |record_periodic_metrics| is true. This is used by tests that do not want
// the timer to be started.
// TODO(bruthig): Add a constructor that accepts a base::RepeatingTimer so
// that tests can inject a test double that can be controlled by the test. The
// missing piece is a suitable base::RepeatingTimer test double.
explicit UserMetricsRecorder(bool record_periodic_metrics);
// Records UMA metrics. Invoked periodically by the |timer_|.
void RecordPeriodicMetrics();
// Returns true if the user's session is active and they are in a desktop
// environment.
bool IsUserInActiveDesktopEnvironment() const;
// Starts the |timer_| and binds it to |RecordPeriodicMetrics|.
void StartTimer();
// The periodic timer that triggers metrics to be recorded.
base::RepeatingTimer timer_;
TaskSwitchMetricsRecorder task_switch_metrics_recorder_;
// Metric recorder to track how often task windows are activated by mouse
// clicks or touchscreen taps.
scoped_ptr<DesktopTaskSwitchMetricRecorder>
desktop_task_switch_metric_recorder_;
DISALLOW_COPY_AND_ASSIGN(UserMetricsRecorder);
};
} // namespace ash
#endif // ASH_METRICS_USER_METRICS_RECORDER_H_
|
