components/metrics/metrics_log.cc

   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 #include "components/metrics/metrics_log.h"
   6
   7 #include <algorithm>
   8 #include <string>
   9 #include <vector>
  10
  11 #include "base/base64.h"
  12 #include "base/basictypes.h"
  13 #include "base/build_time.h"
  14 #include "base/cpu.h"
  15 #include "base/memory/scoped_ptr.h"
  16 #include "base/metrics/histogram.h"
  17 #include "base/metrics/histogram_samples.h"
  18 #include "base/prefs/pref_registry_simple.h"
  19 #include "base/prefs/pref_service.h"
  20 #include "base/sha1.h"
  21 #include "base/strings/string_number_conversions.h"
  22 #include "base/strings/string_util.h"
  23 #include "base/strings/utf_string_conversions.h"
  24 #include "base/sys_info.h"
  25 #include "base/time/time.h"
  26 #include "components/metrics/histogram_encoder.h"
  27 #include "components/metrics/metrics_hashes.h"
  28 #include "components/metrics/metrics_pref_names.h"
  29 #include "components/metrics/metrics_provider.h"
  30 #include "components/metrics/metrics_service_client.h"
  31 #include "components/metrics/proto/histogram_event.pb.h"
  32 #include "components/metrics/proto/system_profile.pb.h"
  33 #include "components/metrics/proto/user_action_event.pb.h"
  34 #include "components/variations/active_field_trials.h"
  35
  36 #if defined(OS_ANDROID)
  37 #include "base/android/build_info.h"
  38 #endif
  39
  40 #if defined(OS_WIN)
  41 #include "base/win/metro.h"
  42
  43 // http://blogs.msdn.com/oldnewthing/archive/2004/10/25/247180.aspx
  44 extern "C" IMAGE_DOS_HEADER __ImageBase;
  45 #endif
  46
  47 using base::SampleCountIterator;
  48 typedef variations::ActiveGroupId ActiveGroupId;
  49
  50 namespace metrics {
  51
  52 namespace {
  53
  54 // Any id less than 16 bytes is considered to be a testing id.
  55 bool IsTestingID(const std::string& id) {
  56   return id.size() < 16;
  57 }
  58
  59 // Returns the date at which the current metrics client ID was created as
  60 // a string containing seconds since the epoch, or "0" if none was found.
  61 std::string GetMetricsEnabledDate(PrefService* pref) {
  62   if (!pref) {
  63     NOTREACHED();
  64     return "0";
  65   }
  66
  67   return pref->GetString(prefs::kMetricsReportingEnabledTimestamp);
  68 }
  69
  70 // Computes a SHA-1 hash of |data| and returns it as a hex string.
  71 std::string ComputeSHA1(const std::string& data) {
  72   const std::string sha1 = base::SHA1HashString(data);
  73   return base::HexEncode(sha1.data(), sha1.size());
  74 }
  75
  76 void WriteFieldTrials(const std::vector<ActiveGroupId>& field_trial_ids,
  77                       SystemProfileProto* system_profile) {
  78   for (std::vector<ActiveGroupId>::const_iterator it =
  79        field_trial_ids.begin(); it != field_trial_ids.end(); ++it) {
  80     SystemProfileProto::FieldTrial* field_trial =
  81         system_profile->add_field_trial();
  82     field_trial->set_name_id(it->name);
  83     field_trial->set_group_id(it->group);
  84   }
  85 }
  86
  87 // Round a timestamp measured in seconds since epoch to one with a granularity
  88 // of an hour. This can be used before uploaded potentially sensitive
  89 // timestamps.
  90 int64 RoundSecondsToHour(int64 time_in_seconds) {
  91   return 3600 * (time_in_seconds / 3600);
  92 }
  93
  94 }  // namespace
  95
  96 MetricsLog::MetricsLog(const std::string& client_id,
  97                        int session_id,
  98                        LogType log_type,
  99                        MetricsServiceClient* client,
 100                        PrefService* local_state)
 101     : closed_(false),
 102       log_type_(log_type),
 103       client_(client),
 104       creation_time_(base::TimeTicks::Now()),
 105       local_state_(local_state) {
 106   if (IsTestingID(client_id))
 107     uma_proto_.set_client_id(0);
 108   else
 109     uma_proto_.set_client_id(Hash(client_id));
 110
 111   uma_proto_.set_session_id(session_id);
 112
 113   const int32 product = client_->GetProduct();
 114   // Only set the product if it differs from the default value.
 115   if (product != uma_proto_.product())
 116     uma_proto_.set_product(product);
 117
 118   SystemProfileProto* system_profile = uma_proto_.mutable_system_profile();
 119   system_profile->set_build_timestamp(GetBuildTime());
 120   system_profile->set_app_version(client_->GetVersionString());
 121   system_profile->set_channel(client_->GetChannel());
 122 #if defined(SYZYASAN)
 123   system_profile->set_is_asan_build(true);
 124 #endif
 125 }
 126
 127 MetricsLog::~MetricsLog() {
 128 }
 129
 130 // static
 131 void MetricsLog::RegisterPrefs(PrefRegistrySimple* registry) {
 132   registry->RegisterIntegerPref(prefs::kStabilityLaunchCount, 0);
 133   registry->RegisterIntegerPref(prefs::kStabilityCrashCount, 0);
 134   registry->RegisterIntegerPref(prefs::kStabilityIncompleteSessionEndCount, 0);
 135   registry->RegisterIntegerPref(prefs::kStabilityBreakpadRegistrationFail, 0);
 136   registry->RegisterIntegerPref(
 137       prefs::kStabilityBreakpadRegistrationSuccess, 0);
 138   registry->RegisterIntegerPref(prefs::kStabilityDebuggerPresent, 0);
 139   registry->RegisterIntegerPref(prefs::kStabilityDebuggerNotPresent, 0);
 140   registry->RegisterStringPref(prefs::kStabilitySavedSystemProfile,
 141                                std::string());
 142   registry->RegisterStringPref(prefs::kStabilitySavedSystemProfileHash,
 143                                std::string());
 144 }
 145
 146 // static
 147 uint64 MetricsLog::Hash(const std::string& value) {
 148   uint64 hash = HashMetricName(value);
 149
 150   // The following log is VERY helpful when folks add some named histogram into
 151   // the code, but forgot to update the descriptive list of histograms.  When
 152   // that happens, all we get to see (server side) is a hash of the histogram
 153   // name.  We can then use this logging to find out what histogram name was
 154   // being hashed to a given MD5 value by just running the version of Chromium
 155   // in question with --enable-logging.
 156   DVLOG(1) << "Metrics: Hash numeric [" << value << "]=[" << hash << "]";
 157
 158   return hash;
 159 }
 160
 161 // static
 162 int64 MetricsLog::GetBuildTime() {
 163   static int64 integral_build_time = 0;
 164   if (!integral_build_time)
 165     integral_build_time = static_cast<int64>(base::GetBuildTime().ToTimeT());
 166   return integral_build_time;
 167 }
 168
 169 // static
 170 int64 MetricsLog::GetCurrentTime() {
 171   return (base::TimeTicks::Now() - base::TimeTicks()).InSeconds();
 172 }
 173
 174 void MetricsLog::RecordUserAction(const std::string& key) {
 175   DCHECK(!closed_);
 176
 177   UserActionEventProto* user_action = uma_proto_.add_user_action_event();
 178   user_action->set_name_hash(Hash(key));
 179   user_action->set_time(GetCurrentTime());
 180 }
 181
 182 void MetricsLog::RecordHistogramDelta(const std::string& histogram_name,
 183                                       const base::HistogramSamples& snapshot) {
 184   DCHECK(!closed_);
 185   EncodeHistogramDelta(histogram_name, snapshot, &uma_proto_);
 186 }
 187
 188 void MetricsLog::RecordStabilityMetrics(
 189     const std::vector<MetricsProvider*>& metrics_providers,
 190     base::TimeDelta incremental_uptime,
 191     base::TimeDelta uptime) {
 192   DCHECK(!closed_);
 193   DCHECK(HasEnvironment());
 194   DCHECK(!HasStabilityMetrics());
 195
 196   PrefService* pref = local_state_;
 197   DCHECK(pref);
 198
 199   // Get stability attributes out of Local State, zeroing out stored values.
 200   // NOTE: This could lead to some data loss if this report isn't successfully
 201   //       sent, but that's true for all the metrics.
 202
 203   WriteRequiredStabilityAttributes(pref);
 204
 205   // Record recent delta for critical stability metrics.  We can't wait for a
 206   // restart to gather these, as that delay biases our observation away from
 207   // users that run happily for a looooong time.  We send increments with each
 208   // uma log upload, just as we send histogram data.
 209   WriteRealtimeStabilityAttributes(pref, incremental_uptime, uptime);
 210
 211   SystemProfileProto* system_profile = uma_proto()->mutable_system_profile();
 212   for (size_t i = 0; i < metrics_providers.size(); ++i)
 213     metrics_providers[i]->ProvideStabilityMetrics(system_profile);
 214
 215   // Omit some stats unless this is the initial stability log.
 216   if (log_type() != INITIAL_STABILITY_LOG)
 217     return;
 218
 219   int incomplete_shutdown_count =
 220       pref->GetInteger(prefs::kStabilityIncompleteSessionEndCount);
 221   pref->SetInteger(prefs::kStabilityIncompleteSessionEndCount, 0);
 222   int breakpad_registration_success_count =
 223       pref->GetInteger(prefs::kStabilityBreakpadRegistrationSuccess);
 224   pref->SetInteger(prefs::kStabilityBreakpadRegistrationSuccess, 0);
 225   int breakpad_registration_failure_count =
 226       pref->GetInteger(prefs::kStabilityBreakpadRegistrationFail);
 227   pref->SetInteger(prefs::kStabilityBreakpadRegistrationFail, 0);
 228   int debugger_present_count =
 229       pref->GetInteger(prefs::kStabilityDebuggerPresent);
 230   pref->SetInteger(prefs::kStabilityDebuggerPresent, 0);
 231   int debugger_not_present_count =
 232       pref->GetInteger(prefs::kStabilityDebuggerNotPresent);
 233   pref->SetInteger(prefs::kStabilityDebuggerNotPresent, 0);
 234
 235   // TODO(jar): The following are all optional, so we *could* optimize them for
 236   // values of zero (and not include them).
 237   SystemProfileProto::Stability* stability =
 238       system_profile->mutable_stability();
 239   stability->set_incomplete_shutdown_count(incomplete_shutdown_count);
 240   stability->set_breakpad_registration_success_count(
 241       breakpad_registration_success_count);
 242   stability->set_breakpad_registration_failure_count(
 243       breakpad_registration_failure_count);
 244   stability->set_debugger_present_count(debugger_present_count);
 245   stability->set_debugger_not_present_count(debugger_not_present_count);
 246 }
 247
 248 void MetricsLog::RecordGeneralMetrics(
 249     const std::vector<MetricsProvider*>& metrics_providers) {
 250   for (size_t i = 0; i < metrics_providers.size(); ++i)
 251     metrics_providers[i]->ProvideGeneralMetrics(uma_proto());
 252 }
 253
 254 void MetricsLog::GetFieldTrialIds(
 255     std::vector<ActiveGroupId>* field_trial_ids) const {
 256   variations::GetFieldTrialActiveGroupIds(field_trial_ids);
 257 }
 258
 259 bool MetricsLog::HasEnvironment() const {
 260   return uma_proto()->system_profile().has_uma_enabled_date();
 261 }
 262
 263 bool MetricsLog::HasStabilityMetrics() const {
 264   return uma_proto()->system_profile().stability().has_launch_count();
 265 }
 266
 267 // The server refuses data that doesn't have certain values.  crashcount and
 268 // launchcount are currently "required" in the "stability" group.
 269 // TODO(isherman): Stop writing these attributes specially once the migration to
 270 // protobufs is complete.
 271 void MetricsLog::WriteRequiredStabilityAttributes(PrefService* pref) {
 272   int launch_count = pref->GetInteger(prefs::kStabilityLaunchCount);
 273   pref->SetInteger(prefs::kStabilityLaunchCount, 0);
 274   int crash_count = pref->GetInteger(prefs::kStabilityCrashCount);
 275   pref->SetInteger(prefs::kStabilityCrashCount, 0);
 276
 277   SystemProfileProto::Stability* stability =
 278       uma_proto()->mutable_system_profile()->mutable_stability();
 279   stability->set_launch_count(launch_count);
 280   stability->set_crash_count(crash_count);
 281 }
 282
 283 void MetricsLog::WriteRealtimeStabilityAttributes(
 284     PrefService* pref,
 285     base::TimeDelta incremental_uptime,
 286     base::TimeDelta uptime) {
 287   // Update the stats which are critical for real-time stability monitoring.
 288   // Since these are "optional," only list ones that are non-zero, as the counts
 289   // are aggregated (summed) server side.
 290
 291   SystemProfileProto::Stability* stability =
 292       uma_proto()->mutable_system_profile()->mutable_stability();
 293
 294   const uint64 incremental_uptime_sec = incremental_uptime.InSeconds();
 295   if (incremental_uptime_sec)
 296     stability->set_incremental_uptime_sec(incremental_uptime_sec);
 297   const uint64 uptime_sec = uptime.InSeconds();
 298   if (uptime_sec)
 299     stability->set_uptime_sec(uptime_sec);
 300 }
 301
 302 void MetricsLog::RecordEnvironment(
 303     const std::vector<MetricsProvider*>& metrics_providers,
 304     const std::vector<variations::ActiveGroupId>& synthetic_trials,
 305     int64 install_date) {
 306   DCHECK(!HasEnvironment());
 307
 308   SystemProfileProto* system_profile = uma_proto()->mutable_system_profile();
 309
 310   std::string brand_code;
 311   if (client_->GetBrand(&brand_code))
 312     system_profile->set_brand_code(brand_code);
 313
 314   int enabled_date;
 315   bool success =
 316       base::StringToInt(GetMetricsEnabledDate(local_state_), &enabled_date);
 317   DCHECK(success);
 318
 319   // Reduce granularity of the enabled_date field to nearest hour.
 320   system_profile->set_uma_enabled_date(RoundSecondsToHour(enabled_date));
 321
 322   // Reduce granularity of the install_date field to nearest hour.
 323   system_profile->set_install_date(RoundSecondsToHour(install_date));
 324
 325   system_profile->set_application_locale(client_->GetApplicationLocale());
 326
 327   SystemProfileProto::Hardware* hardware = system_profile->mutable_hardware();
 328
 329   // HardwareModelName() will return an empty string on platforms where it's
 330   // not implemented or if an error occured.
 331   hardware->set_hardware_class(base::SysInfo::HardwareModelName());
 332
 333   hardware->set_cpu_architecture(base::SysInfo::OperatingSystemArchitecture());
 334   hardware->set_system_ram_mb(base::SysInfo::AmountOfPhysicalMemoryMB());
 335 #if defined(OS_WIN)
 336   hardware->set_dll_base(reinterpret_cast<uint64>(&__ImageBase));
 337 #endif
 338
 339   SystemProfileProto::OS* os = system_profile->mutable_os();
 340   std::string os_name = base::SysInfo::OperatingSystemName();
 341 #if defined(OS_WIN)
 342   // TODO(mad): This only checks whether the main process is a Metro process at
 343   // upload time; not whether the collected metrics were all gathered from
 344   // Metro.  This is ok as an approximation for now, since users will rarely be
 345   // switching from Metro to Desktop mode; but we should re-evaluate whether we
 346   // can distinguish metrics more cleanly in the future: http://crbug.com/140568
 347   if (base::win::IsMetroProcess())
 348     os_name += " (Metro)";
 349 #endif
 350   os->set_name(os_name);
 351   os->set_version(base::SysInfo::OperatingSystemVersion());
 352 #if defined(OS_ANDROID)
 353   os->set_fingerprint(
 354       base::android::BuildInfo::GetInstance()->android_build_fp());
 355 #endif
 356
 357   base::CPU cpu_info;
 358   SystemProfileProto::Hardware::CPU* cpu = hardware->mutable_cpu();
 359   cpu->set_vendor_name(cpu_info.vendor_name());
 360   cpu->set_signature(cpu_info.signature());
 361
 362   std::vector<ActiveGroupId> field_trial_ids;
 363   GetFieldTrialIds(&field_trial_ids);
 364   WriteFieldTrials(field_trial_ids, system_profile);
 365   WriteFieldTrials(synthetic_trials, system_profile);
 366
 367   for (size_t i = 0; i < metrics_providers.size(); ++i)
 368     metrics_providers[i]->ProvideSystemProfileMetrics(system_profile);
 369
 370   std::string serialied_system_profile;
 371   std::string base64_system_profile;
 372   if (system_profile->SerializeToString(&serialied_system_profile)) {
 373     base::Base64Encode(serialied_system_profile, &base64_system_profile);
 374     PrefService* local_state = local_state_;
 375     local_state->SetString(prefs::kStabilitySavedSystemProfile,
 376                            base64_system_profile);
 377     local_state->SetString(prefs::kStabilitySavedSystemProfileHash,
 378                            ComputeSHA1(serialied_system_profile));
 379   }
 380 }
 381
 382 bool MetricsLog::LoadSavedEnvironmentFromPrefs() {
 383   PrefService* local_state = local_state_;
 384   const std::string base64_system_profile =
 385       local_state->GetString(prefs::kStabilitySavedSystemProfile);
 386   if (base64_system_profile.empty())
 387     return false;
 388
 389   const std::string system_profile_hash =
 390       local_state->GetString(prefs::kStabilitySavedSystemProfileHash);
 391   local_state->ClearPref(prefs::kStabilitySavedSystemProfile);
 392   local_state->ClearPref(prefs::kStabilitySavedSystemProfileHash);
 393
 394   SystemProfileProto* system_profile = uma_proto()->mutable_system_profile();
 395   std::string serialied_system_profile;
 396   return base::Base64Decode(base64_system_profile, &serialied_system_profile) &&
 397          ComputeSHA1(serialied_system_profile) == system_profile_hash &&
 398          system_profile->ParseFromString(serialied_system_profile);
 399 }
 400
 401 void MetricsLog::CloseLog() {
 402   DCHECK(!closed_);
 403   closed_ = true;
 404 }
 405
 406 void MetricsLog::GetEncodedLog(std::string* encoded_log) {
 407   DCHECK(closed_);
 408   uma_proto_.SerializeToString(encoded_log);
 409 }
 410
 411 }  // namespace metrics