[Most Visited] Log suggestion provider to UMA

chrome/browser/search/most_visited_iframe_source.cc

 // 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.
 
 #include "chrome/browser/search/most_visited_iframe_source.h"
 
 #include "base/metrics/histogram.h"
 #include "base/strings/string_number_conversions.h"
+#include "base/strings/stringprintf.h"
 #include "chrome/common/url_constants.h"
 #include "content/public/browser/user_metrics.h"
 #include "grit/browser_resources.h"
 #include "net/base/url_util.h"
 #include "url/gurl.h"
 
 namespace {
 
 const char kTitleHTMLPath[] = "/title.html";
 const char kTitleCSSPath[] = "/title.css";
 const char kTitleJSPath[] = "/title.js";
 const char kThumbnailHTMLPath[] = "/thumbnail.html";
 const char kThumbnailCSSPath[] = "/thumbnail.css";
 const char kThumbnailJSPath[] = "/thumbnail.js";
 const char kUtilJSPath[] = "/util.js";
 const char kCommonCSSPath[] = "/common.css";
 const char kLogHTMLPath[] = "/log.html";
+const char kMostVisitedHistogramWithProvider[] = "NewTabPage.MostVisited.%s";
+
+// This macro is needed because the histogram name changes according to the
+// provider, and UMA_HISTOGRAM_ENUMERATION caches a given histogram object at

[Jered, 2013/12/13 19:39:38]

Where are you using UMA_HISTOGRAM_ENUMERATION here? Can this not just be an
inline function with the text of this macro, minus the do...while?

[Mathieu, 2013/12/13 20:00:38]

You're right, done. Made it a private function so that it can use my other
private function, GetHistogramNameForProvider.

+// call site, which will not work in this scenario.
+#define MV_PROVIDER_CLICK_HISTOGRAM(position, provider)                        \
+  do {                                                                         \
+    std::string histogram_name =                                               \
+        MostVisitedIframeSource::GetHistogramNameForProvider(provider);        \
+    base::HistogramBase* counter = base::LinearHistogram::FactoryGet(          \
+        histogram_name, 1,                                                     \
+        MostVisitedIframeSource::kNumMostVisited,                              \
+        MostVisitedIframeSource::kNumMostVisited + 1,                          \
+        base::Histogram::kUmaTargetedHistogramFlag);                           \
+    counter->Add(position);                                                    \
+  } while (0)
 
 }  // namespace
 
 MostVisitedIframeSource::MostVisitedIframeSource() {
 }
 
 MostVisitedIframeSource::~MostVisitedIframeSource() {
 }
 
 const int MostVisitedIframeSource::kNumMostVisited = 8;
@@ skipping 26 matching lines @@
   } else if (path == kUtilJSPath) {
     SendResource(IDR_MOST_VISITED_UTIL_JS, callback);
   } else if (path == kCommonCSSPath) {
     SendResource(IDR_MOST_VISITED_IFRAME_CSS, callback);
   } else if (path == kLogHTMLPath) {
     // Log the clicked MostVisited element by position.
     std::string str_position;
     int position;
     if (net::GetValueForKeyInQuery(url, "pos", &str_position) &&
         base::StringToInt(str_position, &position)) {
+      // Log the Most Visited click.
       UMA_HISTOGRAM_ENUMERATION(kMostVisitedHistogramName, position,
                                 kNumMostVisited);
+      // If a specific provider is specified, log the metric specific to the
+      // provider.
+      std::string provider;
+      if (net::GetValueForKeyInQuery(url, "pr", &provider))
+        MV_PROVIDER_CLICK_HISTOGRAM(position, provider.c_str());
+
       // Records the action. This will be available as a time-stamped stream
       // server-side and can be used to compute time-to-long-dwell.
       content::RecordAction(content::UserMetricsAction("MostVisited_Clicked"));
     }
     callback.Run(NULL);
   } else {
     callback.Run(NULL);
   }
 }
 
 bool MostVisitedIframeSource::ServesPath(const std::string& path) const {
   return path == kTitleHTMLPath || path == kTitleCSSPath ||
          path == kTitleJSPath || path == kThumbnailHTMLPath ||
          path == kThumbnailCSSPath || path == kThumbnailJSPath ||
          path == kUtilJSPath || path == kCommonCSSPath || path == kLogHTMLPath;
 }
+
+// static
+std::string MostVisitedIframeSource::GetHistogramNameForProvider(
+    const char* provider) {
+  return base::StringPrintf(kMostVisitedHistogramWithProvider, provider);
+}