Add metrics to all items in the 'wrench' menu

chrome/browser/ui/toolbar/wrench_menu_model.cc

 // Copyright (c) 2012 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.
 
 #include "chrome/browser/ui/toolbar/wrench_menu_model.h"
 
 #include <algorithm>
 #include <cmath>
 
 #include "base/command_line.h"
+#include "base/metrics/histogram.h"
 #include "base/prefs/pref_service.h"
 #include "base/strings/string_number_conversions.h"
 #include "base/strings/string_util.h"
 #include "base/strings/utf_string_conversions.h"
 #include "chrome/app/chrome_command_ids.h"
 #include "chrome/browser/browser_process.h"
 #include "chrome/browser/defaults.h"
 #include "chrome/browser/extensions/extension_toolbar_model.h"
 #include "chrome/browser/extensions/extension_util.h"
 #include "chrome/browser/profiles/profile.h"
@@ skipping 248 matching lines @@
   AddCheckItemWithStringId(IDC_PROFILING_ENABLED, IDS_PROFILING_ENABLED);
 #endif
 }
 
 ////////////////////////////////////////////////////////////////////////////////
 // WrenchMenuModel
 
 WrenchMenuModel::WrenchMenuModel(ui::AcceleratorProvider* provider,
                                  Browser* browser)
     : ui::SimpleMenuModel(this),
+      uma_action_recorded_(false),
       provider_(provider),
       browser_(browser),
       tab_strip_model_(browser_->tab_strip_model()) {
   Build();
   UpdateZoomControls();
 
   content_zoom_subscription_ =
       content::HostZoomMap::GetDefaultForBrowserContext(browser->profile())
           ->AddZoomLevelChangedCallback(base::Bind(
               &WrenchMenuModel::OnZoomLevelChanged, base::Unretained(this)));
@@ skipping 108 matching lines @@
   if (!switches::IsNewAvatarMenu() && command_id == IDC_SHOW_SIGNIN) {
     // If a custom error message is being shown, handle it.
     GlobalError* error = signin_ui_util::GetSignedInServiceError(
         browser_->profile()->GetOriginalProfile());
     if (error) {
       error->ExecuteMenuItem(browser_);
       return;
     }
   }
 
-  if (command_id == IDC_HELP_PAGE_VIA_MENU)
-    content::RecordAction(UserMetricsAction("ShowHelpTabViaWrenchMenu"));
-
-  if (command_id == IDC_FULLSCREEN) {
-    // We issue the UMA command here and not in BrowserCommandController or even
-    // FullscreenController since we want to be able to distinguish this event
-    // and a menu which is under development.
-    content::RecordAction(UserMetricsAction("EnterFullScreenWithWrenchMenu"));
-  }
-
+  LogMenuMetrics(command_id);
   chrome::ExecuteCommand(browser_, command_id);
 }
 
+void WrenchMenuModel::LogMenuMetrics(int command_id) {
+  base::TimeDelta now = timer_.Elapsed();
+
+  if (!uma_action_recorded_)
+    UMA_HISTOGRAM_MEDIUM_TIMES("WrenchMenu.TimeToAction", now);
+
+  // Menu user metrics

[Peter Kasting, 2014/11/14 19:48:59]

Nit: This comment is meaningless, remove.

[edwardjung, 2014/11/17 15:58:23]

Done.

+  switch (command_id) {
+    case IDC_NEW_TAB:
+      if (!uma_action_recorded_)
+        UMA_HISTOGRAM_MEDIUM_TIMES("WrenchMenu.TimeToAction.NewTab", now);
+      UMA_HISTOGRAM_ENUMERATION("WrenchMenu.MenuAction", MENU_ACTION_NEW_TAB,
+                                LIMIT_MENU_ACTION);
+      break;
+    case IDC_NEW_WINDOW:
+      if (!uma_action_recorded_)
+        UMA_HISTOGRAM_MEDIUM_TIMES("WrenchMenu.TimeToAction.NewWindow", now);
+      UMA_HISTOGRAM_ENUMERATION("WrenchMenu.MenuAction", MENU_ACTION_NEW_WINDOW,
+                                LIMIT_MENU_ACTION);
+      break;
+    case IDC_NEW_INCOGNITO_WINDOW:
+      if (!uma_action_recorded_)
+        UMA_HISTOGRAM_MEDIUM_TIMES("WrenchMenu.TimeToAction.NewIncognitoWindow",
+                                   now);
+      UMA_HISTOGRAM_ENUMERATION("WrenchMenu.MenuAction",
+                                MENU_ACTION_NEW_INCOGNITO_WINDOW,
+                                LIMIT_MENU_ACTION);
+      break;
+
+    // Bookmarks sub menu.
+    case IDC_SHOW_BOOKMARK_BAR:
+      if (!uma_action_recorded_)
+        UMA_HISTOGRAM_MEDIUM_TIMES("WrenchMenu.TimeToAction.ShowBookmarkBar",
+                                   now);
+      UMA_HISTOGRAM_ENUMERATION("WrenchMenu.MenuAction",
+                                MENU_ACTION_SHOW_BOOKMARK_BAR,
+                                LIMIT_MENU_ACTION);
+      break;
+    case IDC_SHOW_BOOKMARK_MANAGER:
+      if (!uma_action_recorded_)
+        UMA_HISTOGRAM_MEDIUM_TIMES("WrenchMenu.TimeToAction.ShowBookmarkMgr",
+                                   now);
+      UMA_HISTOGRAM_ENUMERATION("WrenchMenu.MenuAction",
+                                MENU_ACTION_SHOW_BOOKMARK_MANAGER,
+                                LIMIT_MENU_ACTION);
+      break;
+    case IDC_IMPORT_SETTINGS:
+      if (!uma_action_recorded_)
+        UMA_HISTOGRAM_MEDIUM_TIMES("WrenchMenu.TimeToAction.ImportSettings",
+                                   now);
+      UMA_HISTOGRAM_ENUMERATION("WrenchMenu.MenuAction",
+                                MENU_ACTION_IMPORT_SETTINGS,
+                                LIMIT_MENU_ACTION);
+      break;
+    case IDC_BOOKMARK_PAGE:
+      if (!uma_action_recorded_)
+        UMA_HISTOGRAM_MEDIUM_TIMES("WrenchMenu.TimeToAction.BookmarkPage", now);
+      UMA_HISTOGRAM_ENUMERATION("WrenchMenu.MenuAction",
+                                MENU_ACTION_BOOKMARK_PAGE,
+                                LIMIT_MENU_ACTION);
+      break;
+    case IDC_BOOKMARK_ALL_TABS:
+      if (!uma_action_recorded_)
+        UMA_HISTOGRAM_MEDIUM_TIMES("WrenchMenu.TimeToAction.BookmarkAllTabs",
+                                   now);
+      UMA_HISTOGRAM_ENUMERATION("WrenchMenu.MenuAction",
+                                MENU_ACTION_BOOKMARK_ALL_TABS,
+                                LIMIT_MENU_ACTION);
+      break;
+    case IDC_PIN_TO_START_SCREEN:
+      if (!uma_action_recorded_)
+        UMA_HISTOGRAM_MEDIUM_TIMES("WrenchMenu.TimeToAction.PinToStartScreen",
+                                   now);
+      UMA_HISTOGRAM_ENUMERATION("WrenchMenu.MenuAction",
+                                MENU_ACTION_PIN_TO_START_SCREEN,
+                                LIMIT_MENU_ACTION);
+      break;
+
+    // Recent tabs menu.
+    case IDC_RESTORE_TAB:
+      if (!uma_action_recorded_)
+        UMA_HISTOGRAM_MEDIUM_TIMES("WrenchMenu.TimeToAction.RestoreTab", now);
+      UMA_HISTOGRAM_ENUMERATION("WrenchMenu.MenuAction",
+                                MENU_ACTION_RESTORE_TAB,
+                                LIMIT_MENU_ACTION);
+      break;
+
+    // Windows.
+    case IDC_WIN_DESKTOP_RESTART:
+      if (!uma_action_recorded_)
+        UMA_HISTOGRAM_MEDIUM_TIMES("WrenchMenu.TimeToAction.WinDesktopRestart",
+                                   now);
+      UMA_HISTOGRAM_ENUMERATION("WrenchMenu.MenuAction",
+                                MENU_ACTION_WIN_DESKTOP_RESTART,
+                                LIMIT_MENU_ACTION);
+      break;
+    case IDC_WIN8_METRO_RESTART:
+      if (!uma_action_recorded_)
+        UMA_HISTOGRAM_MEDIUM_TIMES("WrenchMenu.TimeToAction.Win8MetroRestart",
+                                   now);
+      UMA_HISTOGRAM_ENUMERATION("WrenchMenu.MenuAction",
+                                MENU_ACTION_WIN8_METRO_RESTART,
+                                LIMIT_MENU_ACTION);
+      break;
+
+    case IDC_WIN_CHROMEOS_RESTART:
+      if (!uma_action_recorded_)
+        UMA_HISTOGRAM_MEDIUM_TIMES("WrenchMenu.TimeToAction.ChromeOSRestart",
+                                   now);
+      UMA_HISTOGRAM_ENUMERATION("WrenchMenu.MenuAction",
+                                MENU_ACTION_WIN_CHROMEOS_RESTART,
+                                LIMIT_MENU_ACTION);
+      break;
+    case IDC_DISTILL_PAGE:
+      if (!uma_action_recorded_)
+        UMA_HISTOGRAM_MEDIUM_TIMES("WrenchMenu.TimeToAction.DistillPage", now);
+      UMA_HISTOGRAM_ENUMERATION("WrenchMenu.MenuAction",
+                                MENU_ACTION_DISTILL_PAGE,
+                                LIMIT_MENU_ACTION);
+      break;
+    case IDC_SAVE_PAGE:
+      if (!uma_action_recorded_)
+        UMA_HISTOGRAM_MEDIUM_TIMES("WrenchMenu.TimeToAction.SavePage", now);
+      UMA_HISTOGRAM_ENUMERATION("WrenchMenu.MenuAction",
+                                MENU_ACTION_SAVE_PAGE,
+                                LIMIT_MENU_ACTION);
+      break;
+    case IDC_FIND:
+      if (!uma_action_recorded_)
+        UMA_HISTOGRAM_MEDIUM_TIMES("WrenchMenu.TimeToAction.Find", now);
+      UMA_HISTOGRAM_ENUMERATION("WrenchMenu.MenuAction", MENU_ACTION_FIND,
+                                LIMIT_MENU_ACTION);
+      break;
+    case IDC_PRINT:
+      if (!uma_action_recorded_)
+        UMA_HISTOGRAM_MEDIUM_TIMES("WrenchMenu.TimeToAction.Print", now);
+      UMA_HISTOGRAM_ENUMERATION("WrenchMenu.MenuAction", MENU_ACTION_PRINT,
+                                LIMIT_MENU_ACTION);
+      break;
+
+    // Edit menu.
+    case IDC_CUT:
+      if (!uma_action_recorded_)
+        UMA_HISTOGRAM_MEDIUM_TIMES("WrenchMenu.TimeToAction.Cut", now);
+      UMA_HISTOGRAM_ENUMERATION("WrenchMenu.MenuAction", MENU_ACTION_CUT,
+                                LIMIT_MENU_ACTION);
+      break;
+    case IDC_COPY:
+      if (!uma_action_recorded_)
+        UMA_HISTOGRAM_MEDIUM_TIMES("WrenchMenu.TimeToAction.Copy", now);
+      UMA_HISTOGRAM_ENUMERATION("WrenchMenu.MenuAction", MENU_ACTION_COPY,
+                                LIMIT_MENU_ACTION);
+      break;
+    case IDC_PASTE:
+      if (!uma_action_recorded_)
+        UMA_HISTOGRAM_MEDIUM_TIMES("WrenchMenu.TimeToAction.Paste", now);
+      UMA_HISTOGRAM_ENUMERATION("WrenchMenu.MenuAction", MENU_ACTION_PASTE,
+                                LIMIT_MENU_ACTION);
+      break;
+
+    // Tools menu.
+    case IDC_CREATE_HOSTED_APP:
+      if (!uma_action_recorded_)
+        UMA_HISTOGRAM_MEDIUM_TIMES("WrenchMenu.TimeToAction.CreateHostedApp",
+                                   now);
+      UMA_HISTOGRAM_ENUMERATION("WrenchMenu.MenuAction",
+                                MENU_ACTION_CREATE_HOSTED_APP,
+                                LIMIT_MENU_ACTION);
+      break;
+    case IDC_CREATE_SHORTCUTS:
+      if (!uma_action_recorded_)
+        UMA_HISTOGRAM_MEDIUM_TIMES("WrenchMenu.TimeToAction.CreateShortcuts",
+                                   now);
+      UMA_HISTOGRAM_ENUMERATION("WrenchMenu.MenuAction",
+                                MENU_ACTION_CREATE_SHORTCUTS,
+                                LIMIT_MENU_ACTION);
+      break;
+    case IDC_MANAGE_EXTENSIONS:
+      if (!uma_action_recorded_)
+        UMA_HISTOGRAM_MEDIUM_TIMES("WrenchMenu.TimeToAction.ManageExtensions",
+                                   now);
+      UMA_HISTOGRAM_ENUMERATION("WrenchMenu.MenuAction",
+                                MENU_ACTION_MANAGE_EXTENSIONS,
+                                LIMIT_MENU_ACTION);
+      break;
+    case IDC_TASK_MANAGER:
+      if (!uma_action_recorded_)
+        UMA_HISTOGRAM_MEDIUM_TIMES("WrenchMenu.TimeToAction.TaskManager", now);
+      UMA_HISTOGRAM_ENUMERATION("WrenchMenu.MenuAction",
+                                MENU_ACTION_TASK_MANAGER,
+                                LIMIT_MENU_ACTION);
+      break;
+    case IDC_CLEAR_BROWSING_DATA:
+      if (!uma_action_recorded_)
+        UMA_HISTOGRAM_MEDIUM_TIMES("WrenchMenu.TimeToAction.ClearBrowsingData",
+                                   now);
+      UMA_HISTOGRAM_ENUMERATION("WrenchMenu.MenuAction",
+                                MENU_ACTION_CLEAR_BROWSING_DATA,
+                                LIMIT_MENU_ACTION);
+      break;
+    case IDC_VIEW_SOURCE:
+      if (!uma_action_recorded_)
+        UMA_HISTOGRAM_MEDIUM_TIMES("WrenchMenu.TimeToAction.ViewSource", now);
+      UMA_HISTOGRAM_ENUMERATION("WrenchMenu.MenuAction",
+                                MENU_ACTION_VIEW_SOURCE,
+                                LIMIT_MENU_ACTION);
+      break;
+    case IDC_DEV_TOOLS:
+      if (!uma_action_recorded_)
+        UMA_HISTOGRAM_MEDIUM_TIMES("WrenchMenu.TimeToAction.DevTools", now);
+      UMA_HISTOGRAM_ENUMERATION("WrenchMenu.MenuAction", MENU_ACTION_DEV_TOOLS,
+                                LIMIT_MENU_ACTION);
+      break;
+    case IDC_DEV_TOOLS_CONSOLE:
+      if (!uma_action_recorded_)
+        UMA_HISTOGRAM_MEDIUM_TIMES("WrenchMenu.TimeToAction.DevToolsConsole",
+                                   now);
+      UMA_HISTOGRAM_ENUMERATION("WrenchMenu.MenuAction",
+                                MENU_ACTION_DEV_TOOLS_CONSOLE,
+                                LIMIT_MENU_ACTION);
+      break;
+    case IDC_DEV_TOOLS_DEVICES:
+      if (!uma_action_recorded_)
+        UMA_HISTOGRAM_MEDIUM_TIMES("WrenchMenu.TimeToAction.DevToolsDevices",
+                                   now);
+      UMA_HISTOGRAM_ENUMERATION("WrenchMenu.MenuAction",
+                                MENU_ACTION_DEV_TOOLS_DEVICES,
+                                LIMIT_MENU_ACTION);
+      break;
+    case IDC_PROFILING_ENABLED:
+      if (!uma_action_recorded_)
+        UMA_HISTOGRAM_MEDIUM_TIMES("WrenchMenu.TimeToAction.ProfilingEnabled",
+                                   now);
+      UMA_HISTOGRAM_ENUMERATION("WrenchMenu.MenuAction",
+                                MENU_ACTION_PROFILING_ENABLED,
+                                LIMIT_MENU_ACTION);
+      break;
+
+    // Zoom menu
+    case IDC_ZOOM_MINUS:
+      if (!uma_action_recorded_) {
+        UMA_HISTOGRAM_MEDIUM_TIMES("WrenchMenu.TimeToAction.ZoomMinus", now);
+        UMA_HISTOGRAM_ENUMERATION("WrenchMenu.MenuAction",
+                                  MENU_ACTION_ZOOM_MINUS, LIMIT_MENU_ACTION);
+        uma_action_recorded_ = true;
+      }
+      break;
+    case IDC_ZOOM_PLUS:
+      if (!uma_action_recorded_) {
+        UMA_HISTOGRAM_MEDIUM_TIMES("WrenchMenu.TimeToAction.ZoomPlus", now);
+        UMA_HISTOGRAM_ENUMERATION("WrenchMenu.MenuAction",
+                                  MENU_ACTION_ZOOM_PLUS, LIMIT_MENU_ACTION);

[Alexei Svitkine (slow), 2014/11/15 00:00:16]

Please make a helper function for this macro. Each macro expands to a lot of
code, so having a helper function avoids some of the bloat.

[Peter Kasting, 2014/11/15 00:03:10]

I'm not sure that's feasible.  Don't we have to explicitly pass the raw strings
to our histogram functions so our source-crawling tools annotate things
correctly, rather than passing in variables of string type?

[Alexei Svitkine (slow), 2014/11/15 00:06:43]

I'm suggesting specifically for "WrenchMenu.MenuAction" macro. I agree that the
other ones (*TimeToAction*) cannot be refactored this way.

[edwardjung, 2014/11/17 15:58:23]

Done.

+        uma_action_recorded_ = true;
+      }
+      break;
+    case IDC_FULLSCREEN:
+      content::RecordAction(UserMetricsAction("EnterFullScreenWithWrenchMenu"));
+
+      if (!uma_action_recorded_)
+        UMA_HISTOGRAM_MEDIUM_TIMES("WrenchMenu.TimeToAction.EnterFullScreen",
+                                   now);
+      UMA_HISTOGRAM_ENUMERATION("WrenchMenu.MenuAction", MENU_ACTION_FULLSCREEN,
+                                LIMIT_MENU_ACTION);
+      break;
+
+    case IDC_SHOW_HISTORY:
+      if (!uma_action_recorded_)
+        UMA_HISTOGRAM_MEDIUM_TIMES("WrenchMenu.TimeToAction.ShowHistory", now);
+      UMA_HISTOGRAM_ENUMERATION("WrenchMenu.MenuAction",
+                                MENU_ACTION_SHOW_HISTORY,
+                                LIMIT_MENU_ACTION);
+      break;
+    case IDC_SHOW_DOWNLOADS:
+      if (!uma_action_recorded_)
+        UMA_HISTOGRAM_MEDIUM_TIMES("WrenchMenu.TimeToAction.ShowDownloads",
+                                   now);
+      UMA_HISTOGRAM_ENUMERATION("WrenchMenu.MenuAction",
+                                MENU_ACTION_SHOW_DOWNLOADS,
+                                LIMIT_MENU_ACTION);
+      break;
+    case IDC_SHOW_SYNC_SETUP:
+      if (!uma_action_recorded_)
+        UMA_HISTOGRAM_MEDIUM_TIMES("WrenchMenu.TimeToAction.ShowSyncSetup",
+                                   now);
+      UMA_HISTOGRAM_ENUMERATION("WrenchMenu.MenuAction",
+                                MENU_ACTION_SHOW_SYNC_SETUP,
+                                LIMIT_MENU_ACTION);
+      break;
+    case IDC_OPTIONS:
+      if (!uma_action_recorded_)
+        UMA_HISTOGRAM_MEDIUM_TIMES("WrenchMenu.TimeToAction.Settings", now);
+      UMA_HISTOGRAM_ENUMERATION("WrenchMenu.MenuAction", MENU_ACTION_OPTIONS,
+                                LIMIT_MENU_ACTION);
+      break;
+    case IDC_ABOUT:
+      if (!uma_action_recorded_)
+        UMA_HISTOGRAM_MEDIUM_TIMES("WrenchMenu.TimeToAction.About", now);
+      UMA_HISTOGRAM_ENUMERATION("WrenchMenu.MenuAction", MENU_ACTION_ABOUT,
+                                LIMIT_MENU_ACTION);
+      break;
+
+    // Help menu.
+    case IDC_HELP_PAGE_VIA_MENU:
+      content::RecordAction(UserMetricsAction("ShowHelpTabViaWrenchMenu"));
+
+      if (!uma_action_recorded_)
+        UMA_HISTOGRAM_MEDIUM_TIMES("WrenchMenu.TimeToAction.HelpPage", now);
+      UMA_HISTOGRAM_ENUMERATION("WrenchMenu.MenuAction",
+                                MENU_ACTION_HELP_PAGE_VIA_MENU,
+                                LIMIT_MENU_ACTION);
+      break;
+  #if defined(GOOGLE_CHROME_BUILD)
+    case IDC_FEEDBACK:
+      if (!uma_action_recorded_)
+        UMA_HISTOGRAM_MEDIUM_TIMES("WrenchMenu.TimeToAction.Feedback", now);
+      UMA_HISTOGRAM_ENUMERATION("WrenchMenu.MenuAction", MENU_ACTION_FEEDBACK,
+                                LIMIT_MENU_ACTION);
+      break;
+  #endif
+
+    case IDC_TOGGLE_REQUEST_TABLET_SITE:
+      if (!uma_action_recorded_)
+        UMA_HISTOGRAM_MEDIUM_TIMES("WrenchMenu.TimeToAction.RequestTabletSite",
+                                   now);
+      UMA_HISTOGRAM_ENUMERATION("WrenchMenu.MenuAction",
+                                MENU_ACTION_TOGGLE_REQUEST_TABLET_SITE,
+                                LIMIT_MENU_ACTION);
+      break;
+    case IDC_EXIT:
+      if (!uma_action_recorded_)
+        UMA_HISTOGRAM_MEDIUM_TIMES("WrenchMenu.TimeToAction.Exit", now);
+      UMA_HISTOGRAM_ENUMERATION("WrenchMenu.MenuAction", MENU_ACTION_EXIT,
+                                LIMIT_MENU_ACTION);
+      break;
+  }
+}
+
 bool WrenchMenuModel::IsCommandIdChecked(int command_id) const {
   if (command_id == IDC_SHOW_BOOKMARK_BAR) {
     return browser_->profile()->GetPrefs()->GetBoolean(
         bookmarks::prefs::kShowBookmarkBar);
   } else if (command_id == IDC_PROFILING_ENABLED) {
     return Profiling::BeingProfiled();
   } else if (command_id == IDC_TOGGLE_REQUEST_TABLET_SITE) {
     return chrome::IsRequestingTabletSite(browser_);
   }
 
@@ skipping 228 matching lines @@
   if (browser_->host_desktop_type() == chrome::HOST_DESKTOP_TYPE_ASH)
     show_exit_menu = false;
 #endif
 
   if (show_exit_menu) {
     AddSeparator(ui::NORMAL_SEPARATOR);
     AddItemWithStringId(IDC_EXIT, IDS_EXIT);
   }
 
   RemoveTrailingSeparators();
+  uma_action_recorded_ = false;
 }
 
 void WrenchMenuModel::AddGlobalErrorMenuItems() {
   // TODO(sail): Currently we only build the wrench menu once per browser
   // window. This means that if a new error is added after the menu is built
   // it won't show in the existing wrench menu. To fix this we need to some
   // how update the menu if new errors are added.
   ui::ResourceBundle& rb = ui::ResourceBundle::GetSharedInstance();
   // GetSignedInServiceErrors() can modify the global error list, so call it
   // before iterating through that list below.
@@ skipping 105 matching lines @@
                        ->GetZoomPercent();
   }
   zoom_label_ = l10n_util::GetStringFUTF16(
       IDS_ZOOM_PERCENT, base::IntToString16(zoom_percent));
 }
 
 void WrenchMenuModel::OnZoomLevelChanged(
     const content::HostZoomMap::ZoomLevelChange& change) {
   UpdateZoomControls();
 }