ash/metrics/user_metrics_recorder.h

   1 // Copyright 2013 The Chromium Authors. All rights reserved.
   2 // Use of this source code is governed by a BSD-style license that can be
   3 // found in the LICENSE file.
   4
   5 #ifndef ASH_METRICS_USER_METRICS_RECORDER_H_
   6 #define ASH_METRICS_USER_METRICS_RECORDER_H_
   7
   8 #include "ash/ash_export.h"
   9 #include "base/timer/timer.h"
  10
  11 namespace ash {
  12
  13 namespace test {
  14 class UserMetricsRecorderTestAPI;
  15 }
  16
  17 enum UserMetricsAction {
  18   UMA_ACCEL_EXIT_FIRST_Q,
  19   UMA_ACCEL_EXIT_SECOND_Q,
  20   UMA_ACCEL_KEYBOARD_BRIGHTNESS_DOWN_F6,
  21   UMA_ACCEL_KEYBOARD_BRIGHTNESS_UP_F7,
  22   UMA_ACCEL_LOCK_SCREEN_LOCK_BUTTON,
  23   UMA_ACCEL_LOCK_SCREEN_POWER_BUTTON,
  24   UMA_ACCEL_MAXIMIZE_RESTORE_F4,
  25   UMA_ACCEL_PREVWINDOW_F5,
  26   UMA_ACCEL_RESTART_POWER_BUTTON,
  27   UMA_ACCEL_SHUT_DOWN_POWER_BUTTON,
  28   UMA_CLOSE_THROUGH_CONTEXT_MENU,
  29   UMA_DRAG_MAXIMIZE_LEFT,
  30   UMA_DRAG_MAXIMIZE_RIGHT,
  31   UMA_GESTURE_OVERVIEW,
  32   UMA_LAUNCHER_BUTTON_PRESSED_WITH_MOUSE,
  33   UMA_LAUNCHER_BUTTON_PRESSED_WITH_TOUCH,
  34   UMA_LAUNCHER_CLICK_ON_APP,
  35   UMA_LAUNCHER_CLICK_ON_APPLIST_BUTTON,
  36   UMA_LAUNCHER_LAUNCH_TASK,
  37   UMA_LAUNCHER_MINIMIZE_TASK,
  38   UMA_LAUNCHER_SWITCH_TASK,
  39   UMA_MAXIMIZE_MODE_DISABLED,
  40   UMA_MAXIMIZE_MODE_ENABLED,
  41   UMA_MAXIMIZE_MODE_INITIALLY_DISABLED,
  42   UMA_MOUSE_DOWN,
  43   UMA_PANEL_MINIMIZE_CAPTION_CLICK,
  44   UMA_PANEL_MINIMIZE_CAPTION_GESTURE,
  45   UMA_SHELF_ALIGNMENT_SET_BOTTOM,
  46   UMA_SHELF_ALIGNMENT_SET_LEFT,
  47   UMA_SHELF_ALIGNMENT_SET_RIGHT,
  48   UMA_STATUS_AREA_AUDIO_CURRENT_INPUT_DEVICE,
  49   UMA_STATUS_AREA_AUDIO_CURRENT_OUTPUT_DEVICE,
  50   UMA_STATUS_AREA_AUDIO_SWITCH_INPUT_DEVICE,
  51   UMA_STATUS_AREA_AUDIO_SWITCH_OUTPUT_DEVICE,
  52   UMA_STATUS_AREA_BRIGHTNESS_CHANGED,
  53   UMA_STATUS_AREA_BLUETOOTH_CONNECT_KNOWN_DEVICE,
  54   UMA_STATUS_AREA_BLUETOOTH_CONNECT_UNKNOWN_DEVICE,
  55   UMA_STATUS_AREA_BLUETOOTH_DISABLED,
  56   UMA_STATUS_AREA_BLUETOOTH_ENABLED,
  57   UMA_STATUS_AREA_CAPS_LOCK_DETAILED,
  58   UMA_STATUS_AREA_CAPS_LOCK_DISABLED_BY_CLICK,
  59   UMA_STATUS_AREA_CAPS_LOCK_ENABLED_BY_CLICK,
  60   UMA_STATUS_AREA_CAPS_LOCK_POPUP,
  61   UMA_STATUS_AREA_CONNECT_TO_CONFIGURED_NETWORK,
  62   UMA_STATUS_AREA_CONNECT_TO_UNCONFIGURED_NETWORK,
  63   UMA_STATUS_AREA_CONNECT_TO_VPN,
  64   UMA_STATUS_AREA_CHANGED_VOLUME_MENU,
  65   UMA_STATUS_AREA_CHANGED_VOLUME_POPUP,
  66   UMA_STATUS_AREA_DETAILED_ACCESSABILITY,
  67   UMA_STATUS_AREA_DETAILED_AUDIO_VIEW,
  68   UMA_STATUS_AREA_DETAILED_BLUETOOTH_VIEW,
  69   UMA_STATUS_AREA_DETAILED_BRIGHTNESS_VIEW,
  70   UMA_STATUS_AREA_DETAILED_DRIVE_VIEW,
  71   UMA_STATUS_AREA_DETAILED_NETWORK_VIEW,
  72   UMA_STATUS_AREA_DETAILED_VPN_VIEW,
  73   UMA_STATUS_AREA_DISABLE_AUTO_CLICK,
  74   UMA_STATUS_AREA_DISABLE_HIGH_CONTRAST,
  75   UMA_STATUS_AREA_DISABLE_LARGE_CURSOR,
  76   UMA_STATUS_AREA_DISABLE_MAGNIFIER,
  77   UMA_STATUS_AREA_DISABLE_SPOKEN_FEEDBACK,
  78   UMA_STATUS_AREA_DISABLE_WIFI,
  79   UMA_STATUS_AREA_DISABLE_VIRTUAL_KEYBOARD,
  80   UMA_STATUS_AREA_DRIVE_CANCEL_OPERATION,
  81   UMA_STATUS_AREA_DRIVE_SETTINGS,
  82   UMA_STATUS_AREA_ENABLE_AUTO_CLICK,
  83   UMA_STATUS_AREA_ENABLE_HIGH_CONTRAST,
  84   UMA_STATUS_AREA_ENABLE_LARGE_CURSOR,
  85   UMA_STATUS_AREA_ENABLE_MAGNIFIER,
  86   UMA_STATUS_AREA_ENABLE_SPOKEN_FEEDBACK,
  87   UMA_STATUS_AREA_ENABLE_WIFI,
  88   UMA_STATUS_AREA_ENABLE_VIRTUAL_KEYBOARD,
  89   UMA_STATUS_AREA_IME_SHOW_DETAILED,
  90   UMA_STATUS_AREA_IME_SWITCH_MODE,
  91   UMA_STATUS_AREA_MENU_OPENED,
  92   UMA_STATUS_AREA_NETWORK_JOIN_OTHER_CLICKED,
  93   UMA_STATUS_AREA_NETWORK_SETTINGS_CLICKED,
  94   UMA_STATUS_AREA_SHOW_NETWORK_CONNECTION_DETAILS,
  95   UMA_STATUS_AREA_SHOW_VPN_CONNECTION_DETAILS,
  96   UMA_STATUS_AREA_SIGN_OUT,
  97   UMA_STATUS_AREA_VPN_ADD_BUILT_IN_CLICKED,
  98   UMA_STATUS_AREA_VPN_ADD_THIRD_PARTY_CLICKED,
  99   UMA_STATUS_AREA_VPN_DISCONNECT_CLICKED,
 100   UMA_STATUS_AREA_VPN_SETTINGS_CLICKED,
 101   UMA_TOGGLE_MAXIMIZE_CAPTION_CLICK,
 102   UMA_TOGGLE_MAXIMIZE_CAPTION_GESTURE,
 103   UMA_TOGGLE_SINGLE_AXIS_MAXIMIZE_BORDER_CLICK,
 104   UMA_TOUCHPAD_GESTURE_OVERVIEW,
 105   UMA_TOUCHSCREEN_TAP_DOWN,
 106   UMA_TRAY_HELP,
 107   UMA_TRAY_LOCK_SCREEN,
 108   UMA_TRAY_SHUT_DOWN,
 109   UMA_WINDOW_APP_CLOSE_BUTTON_CLICK,
 110   UMA_WINDOW_CLOSE_BUTTON_CLICK,
 111   UMA_WINDOW_MAXIMIZE_BUTTON_CLICK_EXIT_FULLSCREEN,
 112   UMA_WINDOW_MAXIMIZE_BUTTON_CLICK_MAXIMIZE,
 113   UMA_WINDOW_MAXIMIZE_BUTTON_CLICK_MINIMIZE,
 114   UMA_WINDOW_MAXIMIZE_BUTTON_CLICK_RESTORE,
 115   UMA_WINDOW_MAXIMIZE_BUTTON_MAXIMIZE_LEFT,
 116   UMA_WINDOW_MAXIMIZE_BUTTON_MAXIMIZE_RIGHT,
 117
 118   // Thumbnail sized overview of windows triggered by pressing the overview key.
 119   UMA_WINDOW_OVERVIEW,
 120
 121   // Selecting a window in overview mode by pressing the enter key.
 122   UMA_WINDOW_OVERVIEW_ENTER_KEY,
 123
 124   // Window selection started by beginning an alt+tab cycle. This does not count
 125   // each step through an alt+tab cycle.
 126   UMA_WINDOW_CYCLE,
 127 };
 128
 129 // User Metrics Recorder provides a repeating callback (RecordPeriodicMetrics)
 130 // on a timer to allow recording of state data over time to the UMA records.
 131 // Any additional states (in ash) that require monitoring can be added to
 132 // this class. As well calls to record on action metrics
 133 // (RecordUserMetricsAction) are passed through the UserMetricsRecorder.
 134 class ASH_EXPORT UserMetricsRecorder {
 135  public:
 136   // Creates a UserMetricsRecorder that records metrics periodically. Equivalent
 137   // to calling UserMetricsRecorder(true).
 138   UserMetricsRecorder();
 139
 140   virtual ~UserMetricsRecorder();
 141
 142   // Records an Ash owned user action.
 143   void RecordUserMetricsAction(ash::UserMetricsAction action);
 144
 145  private:
 146   friend class test::UserMetricsRecorderTestAPI;
 147
 148   // Creates a UserMetricsRecorder and will only record periodic metrics if
 149   // |record_periodic_metrics| is true. This is used by tests that do not want
 150   // the timer to be started.
 151   // TODO(bruthig): Add a constructor that accepts a base::RepeatingTimer so
 152   // that tests can inject a test double that can be controlled by the test. The
 153   // missing piece is a suitable base::RepeatingTimer test double.
 154   explicit UserMetricsRecorder(bool record_periodic_metrics);
 155
 156   // Records UMA metrics. Invoked periodically by the |timer_|.
 157   void RecordPeriodicMetrics();
 158
 159   // Returns true if the user's session is active and they are in a desktop
 160   // environment.
 161   bool IsUserInActiveDesktopEnvironment() const;
 162
 163   // Starts the |timer_| and binds it to |RecordPeriodicMetrics|.
 164   void StartTimer();
 165
 166   // The periodic timer that triggers metrics to be recorded.
 167   base::RepeatingTimer<UserMetricsRecorder> timer_;
 168
 169   DISALLOW_COPY_AND_ASSIGN(UserMetricsRecorder);
 170 };
 171
 172 }  // namespace ash
 173
 174 #endif  // ASH_METRICS_USER_METRICS_RECORDER_H_