chrome/browser/metrics/chrome_metrics_service_client.h

   1 // Copyright 2014 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 CHROME_BROWSER_METRICS_CHROME_METRICS_SERVICE_CLIENT_H_
   6 #define CHROME_BROWSER_METRICS_CHROME_METRICS_SERVICE_CLIENT_H_
   7
   8 #include <string>
   9
  10 #include "base/basictypes.h"
  11 #include "base/callback.h"
  12 #include "base/memory/scoped_ptr.h"
  13 #include "base/memory/weak_ptr.h"
  14 #include "base/threading/thread_checker.h"
  15 #include "chrome/browser/memory_details.h"
  16 #include "chrome/browser/metrics/network_stats_uploader.h"
  17 #include "components/metrics/metrics_service_client.h"
  18 #include "components/metrics/profiler/tracking_synchronizer_observer.h"
  19 #include "content/public/browser/notification_observer.h"
  20 #include "content/public/browser/notification_registrar.h"
  21
  22 class ChromeOSMetricsProvider;
  23 class GoogleUpdateMetricsProviderWin;
  24 class PluginMetricsProvider;
  25 class PrefRegistrySimple;
  26
  27 #if !defined(OS_CHROMEOS) && !defined(OS_IOS)
  28 class SigninStatusMetricsProvider;
  29 #endif
  30
  31 namespace base {
  32 class FilePath;
  33 }  // namespace base
  34
  35 namespace metrics {
  36 class MetricsService;
  37 class MetricsStateManager;
  38 class ProfilerMetricsProvider;
  39 }  // namespace metrics
  40
  41 // ChromeMetricsServiceClient provides an implementation of MetricsServiceClient
  42 // that depends on chrome/.
  43 class ChromeMetricsServiceClient
  44     : public metrics::MetricsServiceClient,
  45       public metrics::TrackingSynchronizerObserver,
  46       public content::NotificationObserver {
  47  public:
  48   ~ChromeMetricsServiceClient() override;
  49
  50   // Factory function.
  51   static scoped_ptr<ChromeMetricsServiceClient> Create(
  52       metrics::MetricsStateManager* state_manager,
  53       PrefService* local_state);
  54
  55   // Registers local state prefs used by this class.
  56   static void RegisterPrefs(PrefRegistrySimple* registry);
  57
  58   // metrics::MetricsServiceClient:
  59   void SetMetricsClientId(const std::string& client_id) override;
  60   bool IsOffTheRecordSessionActive() override;
  61   int32 GetProduct() override;
  62   std::string GetApplicationLocale() override;
  63   bool GetBrand(std::string* brand_code) override;
  64   metrics::SystemProfileProto::Channel GetChannel() override;
  65   std::string GetVersionString() override;
  66   void OnLogUploadComplete() override;
  67   void StartGatheringMetrics(const base::Closure& done_callback) override;
  68   void CollectFinalMetrics(const base::Closure& done_callback) override;
  69   scoped_ptr<metrics::MetricsLogUploader> CreateUploader(
  70       const std::string& server_url,
  71       const std::string& mime_type,
  72       const base::Callback<void(int)>& on_upload_complete) override;
  73   base::string16 GetRegistryBackupKey() override;
  74
  75   metrics::MetricsService* metrics_service() { return metrics_service_.get(); }
  76
  77   void LogPluginLoadingError(const base::FilePath& plugin_path);
  78
  79  private:
  80   explicit ChromeMetricsServiceClient(
  81       metrics::MetricsStateManager* state_manager);
  82
  83   // Completes the two-phase initialization of ChromeMetricsServiceClient.
  84   void Initialize();
  85
  86   // Callback that continues the init task by loading plugin information.
  87   void OnInitTaskGotHardwareClass();
  88
  89   // Called after the Plugin init task has been completed that continues the
  90   // init task by launching a task to gather Google Update statistics.
  91   void OnInitTaskGotPluginInfo();
  92
  93   // Called after GoogleUpdate init task has been completed that continues the
  94   // init task by loading profiler data.
  95   void OnInitTaskGotGoogleUpdateData();
  96
  97   // TrackingSynchronizerObserver:
  98   void ReceivedProfilerData(
  99       const tracked_objects::ProcessDataSnapshot& process_data,
 100       int process_type) override;
 101   void FinishedReceivingProfilerData() override;
 102
 103   // Callbacks for various stages of final log info collection. Do not call
 104   // these directly.
 105   void OnMemoryDetailCollectionDone();
 106   void OnHistogramSynchronizationDone();
 107
 108   // Records metrics about the switches present on the command line.
 109   void RecordCommandLineMetrics();
 110
 111   // Registers |this| as an observer for notifications which indicate that a
 112   // user is performing work. This is useful to allow some features to sleep,
 113   // until the machine becomes active, such as precluding UMA uploads unless
 114   // there was recent activity.
 115   void RegisterForNotifications();
 116
 117   // content::NotificationObserver:
 118   void Observe(int type,
 119                const content::NotificationSource& source,
 120                const content::NotificationDetails& details) override;
 121
 122 #if defined(OS_WIN)
 123   // Counts (and removes) the browser crash dump attempt signals left behind by
 124   // any previous browser processes which generated a crash dump.
 125   void CountBrowserCrashDumpAttempts();
 126 #endif  // OS_WIN
 127
 128   base::ThreadChecker thread_checker_;
 129
 130   // Weak pointer to the MetricsStateManager.
 131   metrics::MetricsStateManager* metrics_state_manager_;
 132
 133   // The MetricsService that |this| is a client of.
 134   scoped_ptr<metrics::MetricsService> metrics_service_;
 135
 136   content::NotificationRegistrar registrar_;
 137
 138   // On ChromeOS, holds a weak pointer to the ChromeOSMetricsProvider instance
 139   // that has been registered with MetricsService. On other platforms, is NULL.
 140   ChromeOSMetricsProvider* chromeos_metrics_provider_;
 141
 142   NetworkStatsUploader network_stats_uploader_;
 143
 144   // Saved callback received from CollectFinalMetrics().
 145   base::Closure collect_final_metrics_done_callback_;
 146
 147   // Indicates that collect final metrics step is running.
 148   bool waiting_for_collect_final_metrics_step_;
 149
 150   // Number of async histogram fetch requests in progress.
 151   int num_async_histogram_fetches_in_progress_;
 152
 153   // The ProfilerMetricsProvider instance that was registered with
 154   // MetricsService. Has the same lifetime as |metrics_service_|.
 155   metrics::ProfilerMetricsProvider* profiler_metrics_provider_;
 156
 157 #if defined(ENABLE_PLUGINS)
 158   // The PluginMetricsProvider instance that was registered with
 159   // MetricsService. Has the same lifetime as |metrics_service_|.
 160   PluginMetricsProvider* plugin_metrics_provider_;
 161 #endif
 162
 163 #if defined(OS_WIN)
 164   // The GoogleUpdateMetricsProviderWin instance that was registered with
 165   // MetricsService. Has the same lifetime as |metrics_service_|.
 166   GoogleUpdateMetricsProviderWin* google_update_metrics_provider_;
 167 #endif
 168
 169   // Callback that is called when initial metrics gathering is complete.
 170   base::Closure finished_gathering_initial_metrics_callback_;
 171
 172   // The MemoryGrowthTracker instance that tracks memory usage growth in
 173   // MemoryDetails.
 174   MemoryGrowthTracker memory_growth_tracker_;
 175
 176   base::WeakPtrFactory<ChromeMetricsServiceClient> weak_ptr_factory_;
 177
 178   DISALLOW_COPY_AND_ASSIGN(ChromeMetricsServiceClient);
 179 };
 180
 181 #endif  // CHROME_BROWSER_METRICS_CHROME_METRICS_SERVICE_CLIENT_H_