src/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 }
  34
  35 namespace metrics {
  36 class MetricsService;
  37 class MetricsStateManager;
  38 class ProfilerMetricsProvider;
  39 }
  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   virtual ~ChromeMetricsServiceClient();
  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   virtual void SetMetricsClientId(const std::string& client_id) OVERRIDE;
  60   virtual bool IsOffTheRecordSessionActive() OVERRIDE;
  61   virtual std::string GetApplicationLocale() OVERRIDE;
  62   virtual bool GetBrand(std::string* brand_code) OVERRIDE;
  63   virtual metrics::SystemProfileProto::Channel GetChannel() OVERRIDE;
  64   virtual std::string GetVersionString() OVERRIDE;
  65   virtual void OnLogUploadComplete() OVERRIDE;
  66   virtual void StartGatheringMetrics(
  67       const base::Closure& done_callback) OVERRIDE;
  68   virtual void CollectFinalMetrics(const base::Closure& done_callback)
  69       OVERRIDE;
  70   virtual scoped_ptr<metrics::MetricsLogUploader> CreateUploader(
  71       const std::string& server_url,
  72       const std::string& mime_type,
  73       const base::Callback<void(int)>& on_upload_complete) OVERRIDE;
  74   virtual base::string16 GetRegistryBackupKey() OVERRIDE;
  75
  76   metrics::MetricsService* metrics_service() { return metrics_service_.get(); }
  77
  78   void LogPluginLoadingError(const base::FilePath& plugin_path);
  79
  80  private:
  81   explicit ChromeMetricsServiceClient(
  82       metrics::MetricsStateManager* state_manager);
  83
  84   // Completes the two-phase initialization of ChromeMetricsServiceClient.
  85   void Initialize();
  86
  87   // Callback that continues the init task by loading plugin information.
  88   void OnInitTaskGotHardwareClass();
  89
  90   // Called after the Plugin init task has been completed that continues the
  91   // init task by launching a task to gather Google Update statistics.
  92   void OnInitTaskGotPluginInfo();
  93
  94   // Called after GoogleUpdate init task has been completed that continues the
  95   // init task by loading profiler data.
  96   void OnInitTaskGotGoogleUpdateData();
  97
  98   // TrackingSynchronizerObserver:
  99   virtual void ReceivedProfilerData(
 100       const tracked_objects::ProcessDataSnapshot& process_data,
 101       int process_type) OVERRIDE;
 102   virtual void FinishedReceivingProfilerData() OVERRIDE;
 103
 104   // Callbacks for various stages of final log info collection. Do not call
 105   // these directly.
 106   void OnMemoryDetailCollectionDone();
 107   void OnHistogramSynchronizationDone();
 108
 109   // Records metrics about the switches present on the command line.
 110   void RecordCommandLineMetrics();
 111
 112   // Registers |this| as an observer for notifications which indicate that a
 113   // user is performing work. This is useful to allow some features to sleep,
 114   // until the machine becomes active, such as precluding UMA uploads unless
 115   // there was recent activity.
 116   void RegisterForNotifications();
 117
 118   // content::NotificationObserver:
 119   virtual void Observe(int type,
 120                        const content::NotificationSource& source,
 121                        const content::NotificationDetails& details) OVERRIDE;
 122
 123 #if defined(OS_WIN)
 124   // Counts (and removes) the browser crash dump attempt signals left behind by
 125   // any previous browser processes which generated a crash dump.
 126   void CountBrowserCrashDumpAttempts();
 127 #endif  // OS_WIN
 128
 129   base::ThreadChecker thread_checker_;
 130
 131   // Weak pointer to the MetricsStateManager.
 132   metrics::MetricsStateManager* metrics_state_manager_;
 133
 134   // The MetricsService that |this| is a client of.
 135   scoped_ptr<metrics::MetricsService> metrics_service_;
 136
 137   content::NotificationRegistrar registrar_;
 138
 139   // On ChromeOS, holds a weak pointer to the ChromeOSMetricsProvider instance
 140   // that has been registered with MetricsService. On other platforms, is NULL.
 141   ChromeOSMetricsProvider* chromeos_metrics_provider_;
 142
 143   NetworkStatsUploader network_stats_uploader_;
 144
 145   // Saved callback received from CollectFinalMetrics().
 146   base::Closure collect_final_metrics_done_callback_;
 147
 148   // Indicates that collect final metrics step is running.
 149   bool waiting_for_collect_final_metrics_step_;
 150
 151   // Number of async histogram fetch requests in progress.
 152   int num_async_histogram_fetches_in_progress_;
 153
 154   // The ProfilerMetricsProvider instance that was registered with
 155   // MetricsService. Has the same lifetime as |metrics_service_|.
 156   metrics::ProfilerMetricsProvider* profiler_metrics_provider_;
 157
 158 #if defined(ENABLE_PLUGINS)
 159   // The PluginMetricsProvider instance that was registered with
 160   // MetricsService. Has the same lifetime as |metrics_service_|.
 161   PluginMetricsProvider* plugin_metrics_provider_;
 162 #endif
 163
 164 #if defined(OS_WIN)
 165   // The GoogleUpdateMetricsProviderWin instance that was registered with
 166   // MetricsService. Has the same lifetime as |metrics_service_|.
 167   GoogleUpdateMetricsProviderWin* google_update_metrics_provider_;
 168 #endif
 169
 170 #if !defined(OS_CHROMEOS) && !defined(OS_IOS)
 171   // The SigninStatusMetricsProvider instance that was registered with
 172   // MetricsService. Has the same lifetime as |metrics_service_|.
 173   SigninStatusMetricsProvider* signin_status_metrics_provider_;
 174 #endif
 175
 176   // Callback that is called when initial metrics gathering is complete.
 177   base::Closure finished_gathering_initial_metrics_callback_;
 178
 179   // The MemoryGrowthTracker instance that tracks memory usage growth in
 180   // MemoryDetails.
 181   MemoryGrowthTracker memory_growth_tracker_;
 182
 183   base::WeakPtrFactory<ChromeMetricsServiceClient> weak_ptr_factory_;
 184
 185   DISALLOW_COPY_AND_ASSIGN(ChromeMetricsServiceClient);
 186 };
 187
 188 #endif  // CHROME_BROWSER_METRICS_CHROME_METRICS_SERVICE_CLIENT_H_