Support saving browser metrics to disk and reading them during next run.

chrome/browser/metrics/chrome_metrics_service_client.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/metrics/chrome_metrics_service_client.h"
 
 #include <stddef.h>
 
 #include <vector>
 
 #include "base/bind.h"
 #include "base/callback.h"
 #include "base/command_line.h"
 #include "base/files/file_path.h"
+#include "base/files/file_util.h"
 #include "base/logging.h"
 #include "base/memory/ptr_util.h"
 #include "base/metrics/histogram.h"
+#include "base/metrics/persistent_histogram_allocator.h"
 #include "base/path_service.h"
 #include "base/rand_util.h"
 #include "base/strings/string16.h"
 #include "base/threading/platform_thread.h"
 #include "build/build_config.h"
 #include "chrome/browser/browser_process.h"
 #include "chrome/browser/chrome_notification_types.h"
 #include "chrome/browser/google/google_brand.h"
+#include "chrome/browser/metrics/chrome_metrics_service_accessor.h"
 #include "chrome/browser/metrics/chrome_stability_metrics_provider.h"
 #include "chrome/browser/metrics/metrics_reporting_state.h"
 #include "chrome/browser/metrics/subprocess_metrics_provider.h"
 #include "chrome/browser/metrics/time_ticks_experiment_win.h"
 #include "chrome/browser/sync/chrome_sync_client.h"
 #include "chrome/browser/ui/browser_otr_state.h"
 #include "chrome/common/channel_info.h"
 #include "chrome/common/chrome_paths.h"
 #include "chrome/common/chrome_switches.h"
 #include "chrome/common/crash_keys.h"
 #include "chrome/common/features.h"
 #include "chrome/installer/util/util_constants.h"
 #include "components/metrics/call_stack_profile_metrics_provider.h"
 #include "components/metrics/drive_metrics_provider.h"
 #include "components/metrics/file_metrics_provider.h"
 #include "components/metrics/gpu/gpu_metrics_provider.h"
 #include "components/metrics/metrics_pref_names.h"
 #include "components/metrics/metrics_service.h"
 #include "components/metrics/metrics_service_client.h"
+#include "components/metrics/metrics_state_manager.h"
 #include "components/metrics/net/net_metrics_log_uploader.h"
 #include "components/metrics/net/network_metrics_provider.h"
 #include "components/metrics/net/version_utils.h"
 #include "components/metrics/profiler/profiler_metrics_provider.h"
 #include "components/metrics/profiler/tracking_synchronizer.h"
 #include "components/metrics/stability_metrics_helper.h"
 #include "components/metrics/ui/screen_info_metrics_provider.h"
 #include "components/metrics/url_constants.h"
 #include "components/omnibox/browser/omnibox_metrics_provider.h"
 #include "components/prefs/pref_registry_simple.h"
@@ skipping 46 matching lines @@
 const int kMaxHistogramGatheringWaitDuration = 60000;  // 60 seconds.
 
 // Standard interval between log uploads, in seconds.
 #if defined(OS_ANDROID)
 const int kStandardUploadIntervalSeconds = 5 * 60;  // Five minutes.
 const int kStandardUploadIntervalCellularSeconds = 15 * 60;  // Fifteen minutes.
 #else
 const int kStandardUploadIntervalSeconds = 30 * 60;  // Thirty minutes.
 #endif
 
+const char kBrowserMetricsFileName[] = "SavedMetrics";
+
 // Returns true if current connection type is cellular and user is assigned to
 // experimental group for enabled cellular uploads.
 bool IsCellularLogicEnabled() {
   if (variations::GetVariationParamValue("UMA_EnableCellularLogUpload",
                                          "Enabled") != "true" ||
       variations::GetVariationParamValue("UMA_EnableCellularLogUpload",
                                          "Optimize") == "false") {
     return false;
   }
 
@@ skipping 10 matching lines @@
   PrefService* local_state = g_browser_process->local_state();
   return !local_state->HasPrefPath(metrics::prefs::kMetricsReportingEnabled) &&
          variations::GetVariationParamValue("UMA_EnableCellularLogUpload",
                                             "Enabled") == "true";
 #else
   return false;
 #endif
 }
 
 void RegisterInstallerFileMetricsPreferences(PrefRegistrySimple* registry) {
+  base::GlobalHistogramAllocator* allocator =
+      base::GlobalHistogramAllocator::GetEvenIfDisabled();
+  if (allocator)
+    metrics::FileMetricsProvider::RegisterPrefs(registry, allocator->Name());
+
 #if defined(OS_WIN)
   metrics::FileMetricsProvider::RegisterPrefs(
       registry, installer::kSetupHistogramAllocatorName);
 #endif
 }
 
 void RegisterInstallerFileMetricsProvider(
-    metrics::MetricsService* metrics_service) {
-#if defined(OS_WIN)
-  std::unique_ptr<metrics::FileMetricsProvider> file_metrics(
+    metrics::MetricsService* metrics_service,
+    metrics::MetricsStateManager* metrics_state_manager) {

[Alexei Svitkine (slow), 2016/05/10 19:55:42]

Nit: How about just passing reporting_enabled bool?

[bcwhite, 2016/05/11 15:47:12]

I considered it.  It seemed better to pass the object rather than have the
caller need to know exactly what call to make on it.

I'll change it if you prefer.

[Alexei Svitkine (slow), 2016/05/11 15:51:28]

I prefer the bool since it's easier to reason about what the function is doing
based on its signature. Honestly I'd even prefer MetricsService wouldn't be a
param and just have the function return the provider, which can be registered by
the caller.

[bcwhite, 2016/05/11 17:58:34]

Done and Done.

+  // Create an object to monitor files of metrics and include them in reports.
+  std::unique_ptr<metrics::FileMetricsProvider> file_metrics_provider(
       new metrics::FileMetricsProvider(
           content::BrowserThread::GetBlockingPool()
               ->GetTaskRunnerWithShutdownBehavior(
                   base::SequencedWorkerPool::CONTINUE_ON_SHUTDOWN),
           g_browser_process->local_state()));
+
+  // Build the pathname for browser's persistent metrics file. Set it as the
+  // destination for the GlobalHistogramAllocator during process exit and add
+  // it to the file-metrics-provider so one written from a previous run will
+  // be loaded.
+  // TODO(bcwhite): Actually create those files.
+  base::FilePath metrics_file;
+  if (base::PathService::Get(chrome::DIR_USER_DATA, &metrics_file)) {
+    metrics_file =
+        metrics_file.AppendASCII(kBrowserMetricsFileName)
+            .AddExtension(base::PersistentMemoryAllocator::kFileExtension);

[Alexei Svitkine (slow), 2016/05/10 19:55:42]

Nit: Wonder if it would be shorter to have a static function in base to do this
that takes the name and parent file. Can look at doing it in a separate clean up
CL, not necessarily here.

[bcwhite, 2016/05/11 15:47:12]

Acknowledged.

+    if (metrics_state_manager->IsMetricsReportingEnabled()) {
+      // Metrics get persisted to disk when the process exits. Store the path
+      // to that file in the global allocator for use at exit time and tell
+      // the FileMetricsProvider about that file so it can read one created
+      // by the previous run.
+      base::GlobalHistogramAllocator* allocator =
+          base::GlobalHistogramAllocator::GetEvenIfDisabled();
+      if (allocator) {
+        const char* allocator_name = allocator->Name();
+        allocator->SetPersistentLocation(metrics_file);
+        file_metrics_provider->RegisterFile(
+            metrics_file,
+            metrics::FileMetricsProvider::FILE_HISTOGRAMS_ATOMIC,
+            metrics::FileMetricsProvider::ASSOCIATE_PREVIOUS_RUN,
+            allocator_name);
+      }
+    } else {
+      // When metrics reporting is not enabled, any existing file should be
+      // deleted in order to preserve user privacy.
+      base::DeleteFile(metrics_file, false);

[Alexei Svitkine (slow), 2016/05/10 19:55:42]

Make this a post task to the blocking pool - no reason to do this synchronously
on start up.

[bcwhite, 2016/05/11 15:47:12]

Done.

+    }
+  }
+
+#if defined(OS_WIN)
+  // Read metrics file from setup.exe.
   base::FilePath program_dir;
   base::PathService::Get(base::DIR_EXE, &program_dir);
-  file_metrics->RegisterFile(
+  file_metrics_provider->RegisterFile(
       program_dir.AppendASCII(installer::kSetupHistogramAllocatorName)
-          .AddExtension(L".pma"),
+          .AddExtension(FILE_PATH_LITERAL(".pma")),
       metrics::FileMetricsProvider::FILE_HISTOGRAMS_ATOMIC,
+      metrics::FileMetricsProvider::ASSOCIATE_CURRENT_RUN,
       installer::kSetupHistogramAllocatorName);
-  metrics_service->RegisterMetricsProvider(std::move(file_metrics));
 #endif
+
+  // Give the new provider to the metrics service.
+  metrics_service->RegisterMetricsProvider(std::move(file_metrics_provider));
 }
 
 }  // namespace
 
 
 ChromeMetricsServiceClient::ChromeMetricsServiceClient(
     metrics::MetricsStateManager* state_manager)
     : metrics_state_manager_(state_manager),
 #if defined(OS_CHROMEOS)
       chromeos_metrics_provider_(nullptr),
@@ skipping 212 matching lines @@
       std::unique_ptr<metrics::MetricsProvider>(
           new ChromeStabilityMetricsProvider(
               g_browser_process->local_state())));
   metrics_service_->RegisterMetricsProvider(
       std::unique_ptr<metrics::MetricsProvider>(
           new metrics::GPUMetricsProvider));
   metrics_service_->RegisterMetricsProvider(
       std::unique_ptr<metrics::MetricsProvider>(
           new metrics::ScreenInfoMetricsProvider));
 
-  RegisterInstallerFileMetricsProvider(metrics_service_.get());
+  RegisterInstallerFileMetricsProvider(metrics_service_.get(),
+                                       metrics_state_manager_);
 
   drive_metrics_provider_ = new metrics::DriveMetricsProvider(
       content::BrowserThread::GetMessageLoopProxyForThread(
           content::BrowserThread::FILE),
       chrome::FILE_LOCAL_STATE);
   metrics_service_->RegisterMetricsProvider(
       std::unique_ptr<metrics::MetricsProvider>(drive_metrics_provider_));
 
   profiler_metrics_provider_ =
       new metrics::ProfilerMetricsProvider(base::Bind(&IsCellularLogicEnabled));
@@ skipping 286 matching lines @@
   }
 }
 
 void ChromeMetricsServiceClient::OnURLOpenedFromOmnibox(OmniboxLog* log) {
   metrics_service_->OnApplicationNotIdle();
 }
 
 bool ChromeMetricsServiceClient::IsUMACellularUploadLogicEnabled() {
   return IsCellularLogicEnabled();
 }