blob: afb1cb41c2cb266328817005ad5dab60cf6af9bd [file] [log] [blame]
[email protected]2e4cd1a2012-01-12 08:51:031// Copyright (c) 2012 The Chromium Authors. All rights reserved.
license.botbf09a502008-08-24 00:55:552// Use of this source code is governed by a BSD-style license that can be
3// found in the LICENSE file.
initial.commit09911bf2008-07-26 23:55:294
5// This file defines a set of user experience metrics data recorded by
6// the MetricsService. This is the unit of data that is sent to the server.
7
[email protected]11f4857282009-11-13 19:56:178#ifndef CHROME_BROWSER_METRICS_METRICS_LOG_H_
9#define CHROME_BROWSER_METRICS_METRICS_LOG_H_
initial.commit09911bf2008-07-26 23:55:2910
[email protected]6ffdb9002011-11-15 00:09:2411#include <string>
12#include <vector>
13
initial.commit09911bf2008-07-26 23:55:2914#include "base/basictypes.h"
[email protected]e182be02012-01-27 02:35:4415#include "chrome/common/metrics/metrics_log_base.h"
[email protected]197c0772012-05-14 23:50:5116#include "chrome/installer/util/google_update_settings.h"
[email protected]ed0fd002012-04-25 23:10:3417#include "content/public/common/process_type.h"
[email protected]767c9d92012-03-02 16:04:3418#include "ui/gfx/size.h"
initial.commit09911bf2008-07-26 23:55:2919
[email protected]f65859e2013-02-04 20:00:2520#if defined(OS_CHROMEOS)
21#include "chrome/browser/metrics/perf_provider_chromeos.h"
22#endif
23
initial.commit09911bf2008-07-26 23:55:2924struct AutocompleteLog;
initial.commit09911bf2008-07-26 23:55:2925class PrefService;
[email protected]5b199522012-12-22 17:24:4426class PrefServiceSimple;
initial.commit09911bf2008-07-26 23:55:2927
[email protected]f3a1c642011-07-12 19:15:0328namespace base {
29class DictionaryValue;
30}
31
[email protected]ed0fd002012-04-25 23:10:3432namespace tracked_objects {
33struct ProcessDataSnapshot;
34}
35
[email protected]2ac73f62012-08-13 21:49:0736namespace chrome_variations {
[email protected]0c8b7ad2012-11-06 07:08:1437struct ActiveGroupId;
[email protected]ad2461c2012-04-27 21:11:0338}
39
[email protected]191eb3f72010-12-21 06:27:5040namespace webkit {
[email protected]191eb3f72010-12-21 06:27:5041struct WebPluginInfo;
42}
[email protected]191eb3f72010-12-21 06:27:5043
[email protected]197c0772012-05-14 23:50:5144// This is a small helper struct to pass Google Update metrics in a single
45// reference argument to MetricsLog::RecordEnvironment().
46struct GoogleUpdateMetrics {
47 GoogleUpdateMetrics();
48 ~GoogleUpdateMetrics();
49
50 // Defines whether this is a user-level or system-level install.
51 bool is_system_install;
52 // The time at which Google Update last started an automatic update check.
53 base::Time last_started_au;
54 // The time at which Google Update last successfully recieved update
55 // information from Google servers.
56 base::Time last_checked;
57 // Details about Google Update's attempts to update itself.
58 GoogleUpdateSettings::ProductData google_update_data;
59 // Details about Google Update's attempts to update this product.
60 GoogleUpdateSettings::ProductData product_data;
61};
62
[email protected]1226abb2010-06-10 18:01:2863class MetricsLog : public MetricsLogBase {
initial.commit09911bf2008-07-26 23:55:2964 public:
65 // Creates a new metrics log
66 // client_id is the identifier for this profile on this installation
67 // session_id is an integer that's incremented on each application launch
68 MetricsLog(const std::string& client_id, int session_id);
69 virtual ~MetricsLog();
70
[email protected]5b199522012-12-22 17:24:4471 static void RegisterPrefs(PrefServiceSimple* prefs);
initial.commit09911bf2008-07-26 23:55:2972
[email protected]1df44b72012-01-19 05:20:3473 // Get the amount of uptime in seconds since this function was last called.
74 // This updates the cumulative uptime metric for uninstall as a side effect.
75 static int64 GetIncrementalUptime(PrefService* pref);
76
77 // Get the current version of the application as a string.
78 static std::string GetVersionString();
79
80 // Use |extension| in all uploaded appversions in addition to the standard
81 // version string.
82 static void set_version_extension(const std::string& extension);
83 static const std::string& version_extension();
84
initial.commit09911bf2008-07-26 23:55:2985 // Records the current operating environment. Takes the list of installed
[email protected]197c0772012-05-14 23:50:5186 // plugins and Google Update statistics as parameters because those can't be
87 // obtained synchronously from the UI thread.
initial.commit09911bf2008-07-26 23:55:2988 // profile_metrics, if non-null, gives a dictionary of all profile metrics
89 // that are to be recorded. Each value in profile_metrics should be a
90 // dictionary giving the metrics for the profile.
[email protected]191eb3f72010-12-21 06:27:5091 void RecordEnvironment(
[email protected]91d9f3d2011-08-14 05:24:4492 const std::vector<webkit::WebPluginInfo>& plugin_list,
[email protected]197c0772012-05-14 23:50:5193 const GoogleUpdateMetrics& google_update_metrics,
[email protected]f3a1c642011-07-12 19:15:0394 const base::DictionaryValue* profile_metrics);
initial.commit09911bf2008-07-26 23:55:2995
[email protected]bc66d532012-03-23 01:57:0596 // Records the current operating environment. Takes the list of installed
[email protected]197c0772012-05-14 23:50:5197 // plugins and Google Update statistics as parameters because those can't be
98 // obtained synchronously from the UI thread. This is exposed as a separate
99 // method from the |RecordEnvironment()| method above because we record the
100 // environment with *each* protobuf upload, but only with the initial XML
101 // upload.
[email protected]bc66d532012-03-23 01:57:05102 void RecordEnvironmentProto(
[email protected]197c0772012-05-14 23:50:51103 const std::vector<webkit::WebPluginInfo>& plugin_list,
104 const GoogleUpdateMetrics& google_update_metrics);
[email protected]bc66d532012-03-23 01:57:05105
initial.commit09911bf2008-07-26 23:55:29106 // Records the input text, available choices, and selected entry when the
107 // user uses the Omnibox to open a URL.
108 void RecordOmniboxOpenedURL(const AutocompleteLog& log);
109
[email protected]ed0fd002012-04-25 23:10:34110 // Records the passed profiled data, which should be a snapshot of the
111 // browser's profiled performance during startup for a single process.
112 void RecordProfilerData(
113 const tracked_objects::ProcessDataSnapshot& process_data,
114 content::ProcessType process_type);
115
[email protected]0b33f80b2008-12-17 21:34:36116 // Record recent delta for critical stability metrics. We can't wait for a
117 // restart to gather these, as that delay biases our observation away from
118 // users that run happily for a looooong time. We send increments with each
[email protected]fe58acc22012-02-29 01:29:58119 // uma log upload, just as we send histogram data. Takes the list of
120 // installed plugins as a parameter because that can't be obtained
121 // synchronously from the UI thread.
122 void RecordIncrementalStabilityElements(
123 const std::vector<webkit::WebPluginInfo>& plugin_list);
[email protected]0b33f80b2008-12-17 21:34:36124
[email protected]767c9d92012-03-02 16:04:34125 protected:
126 // Exposed for the sake of mocking in test code.
127
128 // Returns the PrefService from which to log metrics data.
129 virtual PrefService* GetPrefService();
130
131 // Returns the screen size for the primary monitor.
132 virtual gfx::Size GetScreenSize() const;
133
[email protected]aa96417972012-08-22 03:16:44134 // Returns the device scale factor for the primary monitor.
135 virtual float GetScreenDeviceScaleFactor() const;
136
[email protected]767c9d92012-03-02 16:04:34137 // Returns the number of monitors the user is using.
138 virtual int GetScreenCount() const;
139
140 // Fills |field_trial_ids| with the list of initialized field trials name and
141 // group ids.
142 virtual void GetFieldTrialIds(
[email protected]0c8b7ad2012-11-06 07:08:14143 std::vector<chrome_variations::ActiveGroupId>* field_trial_ids) const;
[email protected]767c9d92012-03-02 16:04:34144
initial.commit09911bf2008-07-26 23:55:29145 private:
[email protected]c1834a92011-01-21 18:21:03146 FRIEND_TEST_ALL_PREFIXES(MetricsLogTest, ChromeOSStabilityData);
147
[email protected]74b299e2013-01-29 01:24:42148 class NetworkObserver;
149
initial.commit09911bf2008-07-26 23:55:29150 // Writes application stability metrics (as part of the profile log).
151 // NOTE: Has the side-effect of clearing those counts.
[email protected]fe58acc22012-02-29 01:29:58152 void WriteStabilityElement(
153 const std::vector<webkit::WebPluginInfo>& plugin_list,
154 PrefService* pref);
initial.commit09911bf2008-07-26 23:55:29155
[email protected]147bbc0b2009-01-06 19:37:40156 // Within stability group, write plugin crash stats.
[email protected]fe58acc22012-02-29 01:29:58157 void WritePluginStabilityElements(
158 const std::vector<webkit::WebPluginInfo>& plugin_list,
159 PrefService* pref);
[email protected]147bbc0b2009-01-06 19:37:40160
161 // Within the stability group, write required attributes.
162 void WriteRequiredStabilityAttributes(PrefService* pref);
163
164 // Within the stability group, write attributes that need to be updated asap
[email protected]0b33f80b2008-12-17 21:34:36165 // and can't be delayed until the user decides to restart chromium.
166 // Delaying these stats would bias metrics away from happy long lived
167 // chromium processes (ones that don't crash, and keep on running).
[email protected]147bbc0b2009-01-06 19:37:40168 void WriteRealtimeStabilityAttributes(PrefService* pref);
[email protected]0b33f80b2008-12-17 21:34:36169
[email protected]bc66d532012-03-23 01:57:05170 // Writes the list of installed plugins. If |write_as_xml| is true, writes
171 // the XML version. Otherwise, writes the protobuf version.
[email protected]191eb3f72010-12-21 06:27:50172 void WritePluginList(
[email protected]bc66d532012-03-23 01:57:05173 const std::vector<webkit::WebPluginInfo>& plugin_list,
174 bool write_as_xml);
initial.commit09911bf2008-07-26 23:55:29175
[email protected]147bbc0b2009-01-06 19:37:40176 // Within the profile group, write basic install info including appversion.
177 void WriteInstallElement();
178
initial.commit09911bf2008-07-26 23:55:29179 // Writes all profile metrics. This invokes WriteProfileMetrics for each key
180 // in all_profiles_metrics that starts with kProfilePrefix.
[email protected]f3a1c642011-07-12 19:15:03181 void WriteAllProfilesMetrics(
182 const base::DictionaryValue& all_profiles_metrics);
initial.commit09911bf2008-07-26 23:55:29183
184 // Writes metrics for the profile identified by key. This writes all
185 // key/value pairs in profile_metrics.
[email protected]e7b418b2010-07-30 19:47:47186 void WriteProfileMetrics(const std::string& key,
[email protected]f3a1c642011-07-12 19:15:03187 const base::DictionaryValue& profile_metrics);
initial.commit09911bf2008-07-26 23:55:29188
[email protected]197c0772012-05-14 23:50:51189 // Writes info about the Google Update install that is managing this client.
190 // This is a no-op if called on a non-Windows platform.
191 void WriteGoogleUpdateProto(const GoogleUpdateMetrics& google_update_metrics);
192
[email protected]74b299e2013-01-29 01:24:42193 // Registers as observer with net::NetworkChangeNotifier and keeps track of
194 // the network environment.
195 scoped_ptr<NetworkObserver> network_observer_;
[email protected]f65859e2013-02-04 20:00:25196#if defined(OS_CHROMEOS)
197 metrics::PerfProvider perf_provider_;
198#endif
[email protected]74b299e2013-01-29 01:24:42199
[email protected]4d818fee2010-06-06 13:32:27200 DISALLOW_COPY_AND_ASSIGN(MetricsLog);
initial.commit09911bf2008-07-26 23:55:29201};
202
[email protected]11f4857282009-11-13 19:56:17203#endif // CHROME_BROWSER_METRICS_METRICS_LOG_H_