Add PLT measurement to Resource Prefetching for Mobile Web

chrome/browser/predictors/resource_prefetch_predictor.cc

 // Copyright 2014 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/predictors/resource_prefetch_predictor.h"
 
 #include <map>
 #include <set>
 #include <utility>
 
@@ skipping 16 matching lines @@
 #include "chrome/common/chrome_switches.h"
 #include "chrome/common/url_constants.h"
 #include "content/public/browser/browser_thread.h"
 #include "content/public/browser/navigation_controller.h"
 #include "content/public/browser/notification_service.h"
 #include "content/public/browser/notification_source.h"
 #include "content/public/browser/notification_types.h"
 #include "content/public/browser/resource_request_info.h"
 #include "content/public/browser/web_contents.h"
 #include "net/base/mime_util.h"
+#include "net/base/network_change_notifier.h"
 #include "net/http/http_response_headers.h"
 #include "net/url_request/url_request.h"
 #include "net/url_request/url_request_context_getter.h"
 
 using content::BrowserThread;
 
 namespace {
 
 // For reporting whether a subresource is handled or not, and for what reasons.
 enum ResourceStatus {
@@ skipping 36 matching lines @@
   REPORTING_EVENT_PARTIAL_HISTORY_CLEARED = 1,
   REPORTING_EVENT_COUNT = 2
 };
 
 void RecordNavigationEvent(NavigationEvent event) {
   UMA_HISTOGRAM_ENUMERATION("ResourcePrefetchPredictor.NavigationEvent",
                             event,
                             NAVIGATION_EVENT_COUNT);
 }
 
+enum PagePrefetchedNetworkType {
+  PAGE_PREFETCHED_NETWORK_TYPE_ALL = 0,
+  PAGE_PREFETCHED_NETWORK_TYPE_NETWORK_UNKNOWN = 1,
+  PAGE_PREFETCHED_NETWORK_TYPE_ETHERNET = 2,
+  PAGE_PREFETCHED_NETWORK_TYPE_WIFI = 3,
+  PAGE_PREFETCHED_NETWORK_TYPE_2G = 4,
+  PAGE_PREFETCHED_NETWORK_TYPE_3G = 5,
+  PAGE_PREFETCHED_NETWORK_TYPE_4G = 6,
+  PAGE_PREFETCHED_NETWORK_TYPE_NETWORK_NONE = 7,
+  PAGE_PREFETCHED_NETWORK_TYPE_BLUETOOTH = 8,
+  PAGE_PREFETCHED_NETWORK_TYPE_CELLULAR = 9,
+  PAGE_PREFETCHED_NETWORK_TYPE_COUNT = 10
+};
+
+enum PageNotPrefetchedNetworkType {

[tburkard, 2014/10/08 07:58:29]

can't these be combined into a single enum, or, better yet, just reuse the enum
types from net?

[Zhen Wang, 2014/10/14 04:12:12]

Reusing enum types from net now.

+  PAGE_NOT_PREFETCHED_NETWORK_TYPE_ALL = 0,
+  PAGE_NOT_PREFETCHED_NETWORK_TYPE_NETWORK_UNKNOWN = 1,
+  PAGE_NOT_PREFETCHED_NETWORK_TYPE_ETHERNET = 2,
+  PAGE_NOT_PREFETCHED_NETWORK_TYPE_WIFI = 3,
+  PAGE_NOT_PREFETCHED_NETWORK_TYPE_2G = 4,
+  PAGE_NOT_PREFETCHED_NETWORK_TYPE_3G = 5,
+  PAGE_NOT_PREFETCHED_NETWORK_TYPE_4G = 6,
+  PAGE_NOT_PREFETCHED_NETWORK_TYPE_NETWORK_NONE = 7,
+  PAGE_NOT_PREFETCHED_NETWORK_TYPE_BLUETOOTH = 8,
+  PAGE_NOT_PREFETCHED_NETWORK_TYPE_CELLULAR = 9,
+  PAGE_NOT_PREFETCHED_NETWORK_TYPE_COUNT = 10
+};
+
+std::string GetNetworkTypeString() {
+  switch (net::NetworkChangeNotifier::GetConnectionType()) {
+    case net::NetworkChangeNotifier::CONNECTION_ETHERNET:
+      return "Ethernet";
+    case net::NetworkChangeNotifier::CONNECTION_WIFI:
+      return "WiFi";
+    case net::NetworkChangeNotifier::CONNECTION_2G:
+      return "2G";
+    case net::NetworkChangeNotifier::CONNECTION_3G:
+      return "3G";
+    case net::NetworkChangeNotifier::CONNECTION_4G:
+      return "4G";
+    case net::NetworkChangeNotifier::CONNECTION_NONE:
+      return "NetworkNone";
+    case net::NetworkChangeNotifier::CONNECTION_BLUETOOTH:
+      return "Bluetooth";
+    case net::NetworkChangeNotifier::CONNECTION_UNKNOWN:
+    default:
+      break;
+  }
+  return "NetworkUnknown";
+}
+
+PagePrefetchedNetworkType GetPagePrefetchedNetworkType() {
+  switch (net::NetworkChangeNotifier::GetConnectionType()) {
+    case net::NetworkChangeNotifier::CONNECTION_ETHERNET:
+      return PAGE_PREFETCHED_NETWORK_TYPE_ETHERNET;
+    case net::NetworkChangeNotifier::CONNECTION_WIFI:
+      return PAGE_PREFETCHED_NETWORK_TYPE_WIFI;
+    case net::NetworkChangeNotifier::CONNECTION_2G:
+      return PAGE_PREFETCHED_NETWORK_TYPE_2G;
+    case net::NetworkChangeNotifier::CONNECTION_3G:
+      return PAGE_PREFETCHED_NETWORK_TYPE_3G;
+    case net::NetworkChangeNotifier::CONNECTION_4G:
+      return PAGE_PREFETCHED_NETWORK_TYPE_4G;
+    case net::NetworkChangeNotifier::CONNECTION_NONE:
+      return PAGE_PREFETCHED_NETWORK_TYPE_NETWORK_NONE;
+    case net::NetworkChangeNotifier::CONNECTION_BLUETOOTH:
+      return PAGE_PREFETCHED_NETWORK_TYPE_BLUETOOTH;
+    case net::NetworkChangeNotifier::CONNECTION_UNKNOWN:
+    default:
+      break;
+  }
+  return PAGE_PREFETCHED_NETWORK_TYPE_NETWORK_UNKNOWN;
+}
+
+PageNotPrefetchedNetworkType GetPageNotPrefetchedNetworkType() {
+  switch (net::NetworkChangeNotifier::GetConnectionType()) {
+    case net::NetworkChangeNotifier::CONNECTION_ETHERNET:
+      return PAGE_NOT_PREFETCHED_NETWORK_TYPE_ETHERNET;
+    case net::NetworkChangeNotifier::CONNECTION_WIFI:
+      return PAGE_NOT_PREFETCHED_NETWORK_TYPE_WIFI;
+    case net::NetworkChangeNotifier::CONNECTION_2G:
+      return PAGE_NOT_PREFETCHED_NETWORK_TYPE_2G;
+    case net::NetworkChangeNotifier::CONNECTION_3G:
+      return PAGE_NOT_PREFETCHED_NETWORK_TYPE_3G;
+    case net::NetworkChangeNotifier::CONNECTION_4G:
+      return PAGE_NOT_PREFETCHED_NETWORK_TYPE_4G;
+    case net::NetworkChangeNotifier::CONNECTION_NONE:
+      return PAGE_NOT_PREFETCHED_NETWORK_TYPE_NETWORK_NONE;
+    case net::NetworkChangeNotifier::CONNECTION_BLUETOOTH:
+      return PAGE_NOT_PREFETCHED_NETWORK_TYPE_BLUETOOTH;
+    case net::NetworkChangeNotifier::CONNECTION_UNKNOWN:
+    default:
+      break;
+  }
+  return PAGE_NOT_PREFETCHED_NETWORK_TYPE_NETWORK_UNKNOWN;
+}
+
 }  // namespace
 
 namespace predictors {
 
 ////////////////////////////////////////////////////////////////////////////////
 // History lookup task.
 
 // Used to fetch the visit count for a URL from the History database.
 class GetUrlVisitCountTask : public history::HistoryDBTask {
  public:
@@ skipping 415 matching lines @@
 
   NavigationMap::iterator nav_it =
       inflight_navigations_.find(navigation_id);
   if (nav_it == inflight_navigations_.end()) {
     RecordNavigationEvent(NAVIGATION_EVENT_ONLOAD_UNTRACKED_URL);
     return;
   }
   RecordNavigationEvent(NAVIGATION_EVENT_ONLOAD_TRACKED_URL);
 
   // Report any stats.
+  base::TimeDelta plt = base::TimeTicks::Now() - navigation_id.creation_time;
+  ReportPageLoadTimeStats(plt);
   if (prefetch_manager_.get()) {
     ResultsMap::iterator results_it = results_map_.find(navigation_id);
     bool have_prefetch_results = results_it != results_map_.end();
     UMA_HISTOGRAM_BOOLEAN("ResourcePrefetchPredictor.HavePrefetchResults",
                           have_prefetch_results);
     if (have_prefetch_results) {
       ReportAccuracyStats(results_it->second->key_type,
                           *(nav_it->second),
                           results_it->second->requests.get());
+      ReportPageLoadTimePrefetchedStats(results_it->second->key_type, plt);
+    } else {
+      ReportPageLoadTimeNotPrefetchedStats(plt);
     }
   } else {
     scoped_ptr<ResourcePrefetcher::RequestVector> requests(
         new ResourcePrefetcher::RequestVector);
     PrefetchKeyType key_type;
     if (GetPrefetchData(navigation_id, requests.get(), &key_type)) {
       RecordNavigationEvent(NAVIGATION_EVENT_HAVE_PREDICTIONS_FOR_URL);
       ReportPredictedAccuracyStats(key_type,
                                    *(nav_it->second),
                                    *requests);
@@ skipping 447 matching lines @@
     BrowserThread::PostTask(
         BrowserThread::DB, FROM_HERE,
         base::Bind(&ResourcePrefetchPredictorTables::UpdateData,
                    tables_,
                    url_data,
                    host_data));
   }
 }
 
 ////////////////////////////////////////////////////////////////////////////////
-// Accuracy measurement.
+// Page load time and accuracy measurement.
+
+#define REPORT_PLT(name, page_load_time) \
+  UMA_HISTOGRAM_CUSTOM_TIMES( \
+      name, \
+      page_load_time, \
+      base::TimeDelta::FromMilliseconds(10), \
+      base::TimeDelta::FromSeconds(60), \
+      100)
+
+
+void ResourcePrefetchPredictor::ReportPageLoadTimeStats(
+    base::TimeDelta plt) const {
+  bool on_cellular =
+      net::NetworkChangeNotifier::IsConnectionCellular(
+          net::NetworkChangeNotifier::GetConnectionType());
+
+  REPORT_PLT("ResourcePrefetchPredictor.PLT", plt);
+  REPORT_PLT("ResourcePrefetchPredictor.PLT." + GetNetworkTypeString(), plt);
+  if (on_cellular)
+    REPORT_PLT("ResourcePrefetchPredictor.PLT.Cellular", plt);
+}
+
+void ResourcePrefetchPredictor::ReportPageLoadTimePrefetchedStats(
+    PrefetchKeyType key_type,
+    base::TimeDelta plt) const {
+  bool on_cellular =
+      net::NetworkChangeNotifier::IsConnectionCellular(
+          net::NetworkChangeNotifier::GetConnectionType());
+
+  UMA_HISTOGRAM_ENUMERATION(
+      "ResourcePrefetchPredictor.PagePrefetchedNetworkType",
+      PAGE_PREFETCHED_NETWORK_TYPE_ALL,
+      PAGE_PREFETCHED_NETWORK_TYPE_COUNT);
+  UMA_HISTOGRAM_ENUMERATION(
+      "ResourcePrefetchPredictor.PagePrefetchedNetworkType",
+      GetPagePrefetchedNetworkType(),
+      PAGE_PREFETCHED_NETWORK_TYPE_COUNT);
+  if (on_cellular) {
+    UMA_HISTOGRAM_ENUMERATION(
+        "ResourcePrefetchPredictor.PagePrefetchedNetworkType",
+        PAGE_PREFETCHED_NETWORK_TYPE_CELLULAR,
+        PAGE_PREFETCHED_NETWORK_TYPE_COUNT);
+  }
+
+  REPORT_PLT("ResourcePrefetchPredictor.PLT.PagePrefetched", plt);
+  REPORT_PLT("ResourcePrefetchPredictor.PLT.PagePrefetched."
+             + GetNetworkTypeString(), plt);
+  if (on_cellular)
+    REPORT_PLT("ResourcePrefetchPredictor.PLT.PagePrefetched.Cellular", plt);
+
+  std::string histogram_type = key_type == PREFETCH_KEY_TYPE_HOST ? "Host" :
+      "Url";
+  REPORT_PLT("ResourcePrefetchPredictor.PLT.PagePrefetched." + histogram_type,

[tburkard, 2014/10/08 07:58:29]

see comment below, this shouldn't work.

[Zhen Wang, 2014/10/14 04:12:12]

Done.

+             plt);
+  REPORT_PLT("ResourcePrefetchPredictor.PLT.PagePrefetched." + histogram_type

[tburkard, 2014/10/08 07:58:29]

ditto

[Zhen Wang, 2014/10/14 04:12:12]

Done.

+             + "." + GetNetworkTypeString(), plt);
+  if (on_cellular) {
+    REPORT_PLT("ResourcePrefetchPredictor.PLT.PagePrefetched." + histogram_type
+               + ".Cellular", plt);
+  }
+}
+
+void ResourcePrefetchPredictor::ReportPageLoadTimeNotPrefetchedStats(
+    base::TimeDelta plt) const {
+  bool on_cellular =
+      net::NetworkChangeNotifier::IsConnectionCellular(
+          net::NetworkChangeNotifier::GetConnectionType());
+
+  UMA_HISTOGRAM_ENUMERATION(
+      "ResourcePrefetchPredictor.PageNotPrefetchedNetworkType",
+      PAGE_NOT_PREFETCHED_NETWORK_TYPE_ALL,
+      PAGE_NOT_PREFETCHED_NETWORK_TYPE_COUNT);
+  UMA_HISTOGRAM_ENUMERATION(
+      "ResourcePrefetchPredictor.PageNotPrefetchedNetworkType",
+      GetPageNotPrefetchedNetworkType(),
+      PAGE_PREFETCHED_NETWORK_TYPE_COUNT);
+  if (on_cellular) {
+    UMA_HISTOGRAM_ENUMERATION(
+        "ResourcePrefetchPredictor.PagePrefetchedNetworkType",
+        PAGE_PREFETCHED_NETWORK_TYPE_CELLULAR,
+        PAGE_PREFETCHED_NETWORK_TYPE_COUNT);
+  }
+
+  REPORT_PLT("ResourcePrefetchPredictor.PLT.PageNotPrefetched", plt);
+  REPORT_PLT("ResourcePrefetchPredictor.PLT.PageNotPrefetched."
+             + GetNetworkTypeString(), plt);

[tburkard, 2014/10/08 07:58:29]

This should not work, if the user switches networks. Can you test this
condition?

The reason is that the UMA macros expand to a { } with a static variable,
initialized with the histogram name, and the histogram name must remain constant
across all calls to the macro.

See prerender_histograms.cc, we have the same issue there, and it must be
addressed by duplicating the UMA call for each possible value of the variable.

[Zhen Wang, 2014/10/14 04:12:12]

I see. I duplicate the UMA calls now.

+  if (on_cellular)
+    REPORT_PLT("ResourcePrefetchPredictor.PLT.PageNotPrefetched.Cellular", plt);
+}
 
 void ResourcePrefetchPredictor::ReportAccuracyStats(
     PrefetchKeyType key_type,
     const std::vector<URLRequestSummary>& actual,
     ResourcePrefetcher::RequestVector* prefetched) const {
   // Annotate the results.
   std::map<GURL, bool> actual_resources;
   for (std::vector<URLRequestSummary>::const_iterator it = actual.begin();
        it != actual.end(); ++it) {
     actual_resources[it->resource_url] = it->was_cached;
@@ skipping 198 matching lines @@
     RPP_PREDICTED_HISTOGRAM_PERCENTAGE(
         "PrefetchFromNetworkPercentOfTotalFromNetwork",
         prefetch_network * 100.0 / total_resources_fetched_from_network);
   }
 
 #undef RPP_PREDICTED_HISTOGRAM_PERCENTAGE
 #undef RPP_PREDICTED_HISTOGRAM_COUNTS
 }
 
 }  // namespace predictors