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_USER_METRICS_RECORDER_H_
   6 #define ASH_USER_METRICS_RECORDER_H_
   7
   8 #include "ash/ash_export.h"
   9 #include "base/timer/timer.h"
  10
  11 namespace ash {
  12
  13 enum UserMetricsAction {
  14   UMA_ACCEL_EXIT_FIRST_Q,
  15   UMA_ACCEL_EXIT_SECOND_Q,
  16   UMA_ACCEL_KEYBOARD_BRIGHTNESS_DOWN_F6,
  17   UMA_ACCEL_KEYBOARD_BRIGHTNESS_UP_F7,
  18   UMA_ACCEL_LOCK_SCREEN_LOCK_BUTTON,
  19   UMA_ACCEL_LOCK_SCREEN_POWER_BUTTON,
  20   UMA_ACCEL_MAXIMIZE_RESTORE_F4,
  21   UMA_ACCEL_PREVWINDOW_F5,
  22   UMA_ACCEL_RESTART_POWER_BUTTON,
  23   UMA_ACCEL_SHUT_DOWN_POWER_BUTTON,
  24   UMA_CLOSE_THROUGH_CONTEXT_MENU,
  25   UMA_DRAG_MAXIMIZE_LEFT,
  26   UMA_DRAG_MAXIMIZE_RIGHT,
  27   UMA_GESTURE_OVERVIEW,
  28   UMA_LAUNCHER_CLICK_ON_APP,
  29   UMA_LAUNCHER_CLICK_ON_APPLIST_BUTTON,
  30   UMA_MOUSE_DOWN,
  31   UMA_PANEL_MINIMIZE_CAPTION_CLICK,
  32   UMA_PANEL_MINIMIZE_CAPTION_GESTURE,
  33   UMA_SHELF_ALIGNMENT_SET_BOTTOM,
  34   UMA_SHELF_ALIGNMENT_SET_LEFT,
  35   UMA_SHELF_ALIGNMENT_SET_RIGHT,
  36   UMA_STATUS_AREA_AUDIO_CURRENT_INPUT_DEVICE,
  37   UMA_STATUS_AREA_AUDIO_CURRENT_OUTPUT_DEVICE,
  38   UMA_STATUS_AREA_AUDIO_SWITCH_INPUT_DEVICE,
  39   UMA_STATUS_AREA_AUDIO_SWITCH_OUTPUT_DEVICE,
  40   UMA_STATUS_AREA_BRIGHTNESS_CHANGED,
  41   UMA_STATUS_AREA_BLUETOOTH_CONNECT_KNOWN_DEVICE,
  42   UMA_STATUS_AREA_BLUETOOTH_CONNECT_UNKNOWN_DEVICE,
  43   UMA_STATUS_AREA_BLUETOOTH_DISABLED,
  44   UMA_STATUS_AREA_BLUETOOTH_ENABLED,
  45   UMA_STATUS_AREA_CAPS_LOCK_DETAILED,
  46   UMA_STATUS_AREA_CAPS_LOCK_DISABLED_BY_CLICK,
  47   UMA_STATUS_AREA_CAPS_LOCK_ENABLED_BY_CLICK,
  48   UMA_STATUS_AREA_CAPS_LOCK_POPUP,
  49   UMA_STATUS_AREA_CONNECT_TO_CONFIGURED_NETWORK,
  50   UMA_STATUS_AREA_CONNECT_TO_UNCONFIGURED_NETWORK,
  51   UMA_STATUS_AREA_CONNECT_TO_VPN,
  52   UMA_STATUS_AREA_CHANGED_VOLUME_MENU,
  53   UMA_STATUS_AREA_CHANGED_VOLUME_POPUP,
  54   UMA_STATUS_AREA_DETAILED_ACCESSABILITY,
  55   UMA_STATUS_AREA_DETAILED_AUDIO_VIEW,
  56   UMA_STATUS_AREA_DETAILED_BLUETOOTH_VIEW,
  57   UMA_STATUS_AREA_DETAILED_BRIGHTNESS_VIEW,
  58   UMA_STATUS_AREA_DETAILED_DRIVE_VIEW,
  59   UMA_STATUS_AREA_DETAILED_NETWORK_VIEW,
  60   UMA_STATUS_AREA_DETAILED_VPN_VIEW,
  61   UMA_STATUS_AREA_DISABLE_AUTO_CLICK,
  62   UMA_STATUS_AREA_DISABLE_HIGH_CONTRAST,
  63   UMA_STATUS_AREA_DISABLE_LARGE_CURSOR,
  64   UMA_STATUS_AREA_DISABLE_MAGNIFIER,
  65   UMA_STATUS_AREA_DISABLE_SPOKEN_FEEDBACK,
  66   UMA_STATUS_AREA_DISABLE_WIFI,
  67   UMA_STATUS_AREA_DISABLE_VIRTUAL_KEYBOARD,
  68   UMA_STATUS_AREA_DRIVE_CANCEL_OPERATION,
  69   UMA_STATUS_AREA_DRIVE_SETTINGS,
  70   UMA_STATUS_AREA_ENABLE_AUTO_CLICK,
  71   UMA_STATUS_AREA_ENABLE_HIGH_CONTRAST,
  72   UMA_STATUS_AREA_ENABLE_LARGE_CURSOR,
  73   UMA_STATUS_AREA_ENABLE_MAGNIFIER,
  74   UMA_STATUS_AREA_ENABLE_SPOKEN_FEEDBACK,
  75   UMA_STATUS_AREA_ENABLE_WIFI,
  76   UMA_STATUS_AREA_ENABLE_VIRTUAL_KEYBOARD,
  77   UMA_STATUS_AREA_IME_SHOW_DETAILED,
  78   UMA_STATUS_AREA_IME_SWITCH_MODE,
  79   UMA_STATUS_AREA_MENU_OPENED,
  80   UMA_STATUS_AREA_NETWORK_JOIN_OTHER_CLICKED,
  81   UMA_STATUS_AREA_NETWORK_SETTINGS_CLICKED,
  82   UMA_STATUS_AREA_SHOW_NETWORK_CONNECTION_DETAILS,
  83   UMA_STATUS_AREA_SHOW_VPN_CONNECTION_DETAILS,
  84   UMA_STATUS_AREA_SIGN_OUT,
  85   UMA_STATUS_AREA_VPN_JOIN_OTHER_CLICKED,
  86   UMA_STATUS_AREA_VPN_SETTINGS_CLICKED,
  87   UMA_TOGGLE_MAXIMIZE_CAPTION_CLICK,
  88   UMA_TOGGLE_MAXIMIZE_CAPTION_GESTURE,
  89   UMA_TOGGLE_SINGLE_AXIS_MAXIMIZE_BORDER_CLICK,
  90   UMA_TOUCHPAD_GESTURE_OVERVIEW,
  91   UMA_TOUCHSCREEN_TAP_DOWN,
  92   UMA_TRAY_HELP,
  93   UMA_TRAY_LOCK_SCREEN,
  94   UMA_TRAY_SHUT_DOWN,
  95   UMA_WINDOW_APP_CLOSE_BUTTON_CLICK,
  96   UMA_WINDOW_CLOSE_BUTTON_CLICK,
  97   UMA_WINDOW_MAXIMIZE_BUTTON_CLICK_EXIT_FULLSCREEN,
  98   UMA_WINDOW_MAXIMIZE_BUTTON_CLICK_MAXIMIZE,
  99   UMA_WINDOW_MAXIMIZE_BUTTON_CLICK_MINIMIZE,
 100   UMA_WINDOW_MAXIMIZE_BUTTON_CLICK_RESTORE,
 101   UMA_WINDOW_MAXIMIZE_BUTTON_MAXIMIZE_LEFT,
 102   UMA_WINDOW_MAXIMIZE_BUTTON_MAXIMIZE_RIGHT,
 103
 104   // Thumbnail sized overview of windows triggered by pressing the overview key.
 105   UMA_WINDOW_OVERVIEW,
 106
 107   // Selecting a window in overview mode by pressing the enter key.
 108   UMA_WINDOW_OVERVIEW_ENTER_KEY,
 109
 110   // Window selection started by beginning an alt+tab cycle. This does not count
 111   // each step through an alt+tab cycle.
 112   UMA_WINDOW_CYCLE,
 113 };
 114
 115 // User Metrics Recorder provides a repeating callback (RecordPeriodicMetrics)
 116 // on a timer to allow recording of state data over time to the UMA records.
 117 // Any additional states (in ash) that require monitoring can be added to
 118 // this class. As well calls to record on action metrics
 119 // (RecordUserMetricsAction) are passed through the UserMetricsRecorder.
 120 class ASH_EXPORT UserMetricsRecorder {
 121  public:
 122   UserMetricsRecorder();
 123   ~UserMetricsRecorder();
 124
 125   void RecordUserMetricsAction(ash::UserMetricsAction action);
 126  private:
 127   void RecordPeriodicMetrics();
 128
 129   base::RepeatingTimer<UserMetricsRecorder> timer_;
 130 };
 131
 132 }  // namespace ash
 133
 134 #endif  // ASH_USER_METRICS_RECORDER_H_