Add histograms to record the number of writes to the prefs file

base/prefs/json_pref_store.cc

 // Copyright (c) 2012 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 "base/prefs/json_pref_store.h"
 
 #include <algorithm>
 
 #include "base/bind.h"
 #include "base/callback.h"
 #include "base/files/file_path.h"
 #include "base/files/file_util.h"
 #include "base/json/json_file_value_serializer.h"
 #include "base/json/json_string_value_serializer.h"
 #include "base/memory/ref_counted.h"
 #include "base/metrics/histogram.h"
 #include "base/prefs/pref_filter.h"
 #include "base/sequenced_task_runner.h"
+#include "base/strings/string_number_conversions.h"
 #include "base/strings/string_util.h"
 #include "base/task_runner_util.h"
 #include "base/threading/sequenced_worker_pool.h"
 #include "base/values.h"
 
 // Result returned from internal read tasks.
 struct JsonPrefStore::ReadResult {
  public:
   ReadResult();
   ~ReadResult();
 
   scoped_ptr<base::Value> value;
   PrefReadError error;
   bool no_dir;
 
  private:
   DISALLOW_COPY_AND_ASSIGN(ReadResult);
 };
 
 JsonPrefStore::ReadResult::ReadResult()
     : error(PersistentPrefStore::PREF_READ_ERROR_NONE), no_dir(false) {
 }
 
 JsonPrefStore::ReadResult::~ReadResult() {
 }
 
+class JsonPrefStore::WriteCountHistogram {
+ public:
+  WriteCountHistogram(const base::TimeDelta& commit_interval,
+                      const base::TimeDelta& report_interval,
+                      const base::FilePath& path);
+  ~WriteCountHistogram();
+
+  void RecordWriteOccured();
+
+ private:
+  base::HistogramBase* GetHistogram();
+
+  // The minimum interval at which writes can occur.
+  const base::TimeDelta commit_interval_;
+
+  // The interval at which to report write counts.
+  const base::TimeDelta report_interval_;
+
+  // The path to the file.
+  const base::FilePath path_;
+
+  // The time at which the last histogram value was reported for the number
+  // of write counts.
+  base::Time last_report_time_;
+
+  // The number of writes that have occured since the last write count was
+  // reported.
+  uint32_t writes_since_last_report_;
+
+  DISALLOW_COPY_AND_ASSIGN(WriteCountHistogram);
+};
+
 namespace {
 
+const int32 kHistogramWriteReportIntervalInMins = 5;
+
 // Some extensions we'll tack on to copies of the Preferences files.
 const base::FilePath::CharType kBadExtension[] = FILE_PATH_LITERAL("bad");
 
 PersistentPrefStore::PrefReadError HandleReadErrors(
     const base::Value* value,
     const base::FilePath& path,
     int error_code,
     const std::string& error_msg) {
   if (!value) {
     DVLOG(1) << "Error while loading JSON file: " << error_msg
@@ skipping 94 matching lines @@
     : path_(filename),
       sequenced_task_runner_(sequenced_task_runner),
       prefs_(new base::DictionaryValue()),
       read_only_(false),
       writer_(filename, sequenced_task_runner),
       pref_filter_(pref_filter.Pass()),
       initialized_(false),
       filtering_in_progress_(false),
       read_error_(PREF_READ_ERROR_NONE) {
   DCHECK(!path_.empty());
+
+  write_count_histogram_.reset(new WriteCountHistogram(

[Mattias Nissler (ping if slow), 2015/04/20 09:43:47]

looks like there's no good reason to keep this in a scoped_ptr now (as opposed
to just using a plain data member).

+      writer_.commit_interval(),
+      base::TimeDelta::FromMinutes(kHistogramWriteReportIntervalInMins),
+      path_));
 }
 
 JsonPrefStore::JsonPrefStore(
     const base::FilePath& filename,
     const base::FilePath& alternate_filename,
     const scoped_refptr<base::SequencedTaskRunner>& sequenced_task_runner,
     scoped_ptr<PrefFilter> pref_filter)
     : path_(filename),
       alternate_path_(alternate_filename),
       sequenced_task_runner_(sequenced_task_runner),
@@ skipping 216 matching lines @@
   }
 }
 
 JsonPrefStore::~JsonPrefStore() {
   CommitPendingWrite();
 }
 
 bool JsonPrefStore::SerializeData(std::string* output) {
   DCHECK(CalledOnValidThread());
 
+  write_count_histogram_->RecordWriteOccured();
+
   if (pref_filter_)
     pref_filter_->FilterSerializeData(prefs_.get());
 
   JSONStringValueSerializer serializer(output);
   // Not pretty-printing prefs shrinks pref file size by ~30%. To obtain
   // readable prefs for debugging purposes, you can dump your prefs into any
   // command-line or online JSON pretty printing tool.
   serializer.set_pretty_print(false);
   return serializer.Serialize(*prefs_);
 }
@@ skipping 21 matching lines @@
 
   if (error_delegate_ && read_error_ != PREF_READ_ERROR_NONE)
     error_delegate_->OnError(read_error_);
 
   FOR_EACH_OBSERVER(PrefStore::Observer,
                     observers_,
                     OnInitializationCompleted(true));
 
   return;
 }
+
+JsonPrefStore::WriteCountHistogram::WriteCountHistogram(
+    const base::TimeDelta& commit_interval,
+    const base::TimeDelta& report_interval,
+    const base::FilePath& path)
+    : commit_interval_(commit_interval),
+      report_interval_(report_interval),
+      path_(path),
+      last_report_time_(base::Time::Now()),
+      writes_since_last_report_(0) {
+}
+
+JsonPrefStore::WriteCountHistogram::~WriteCountHistogram() {
+  // Record any outstanding writes before shutdown.
+  GetHistogram()->Add(writes_since_last_report_);
+}
+
+void JsonPrefStore::WriteCountHistogram::RecordWriteOccured() {
+  base::Time current_time = base::Time::Now();
+  base::TimeDelta time_since_last_report = current_time - last_report_time_;
+  base::HistogramBase* histogram = GetHistogram();
+
+  // If the time since the last report exceeds the report interval, we report
+  // all of the fully elapsed intervals up to the current time.
+  while (time_since_last_report > report_interval_) {
+    histogram->Add(writes_since_last_report_);
+
+    writes_since_last_report_ = 0;
+    last_report_time_ += report_interval_;
+    time_since_last_report = current_time - last_report_time_;
+  }
+
+  writes_since_last_report_++;
+}
+
+base::HistogramBase* JsonPrefStore::WriteCountHistogram::GetHistogram() {
+  std::string spaceless_basename;
+  base::ReplaceChars(path_.BaseName().MaybeAsASCII(), " ", "_",
+                     &spaceless_basename);
+  std::string histogram_name =
+      "Settings.JsonDataWriteCount." + spaceless_basename;
+
+  // The min value for a histogram is 1. The max value is the maximum number of
+  // writes that can occur in the window being recorded. The number of buckets
+  // used is the max value (plus the underflow/overflow buckets).
+  int32_t min_value = 1;
+  int32_t max_value = report_interval_ / commit_interval_;
+  int32_t num_buckets = max_value + 2;
+
+  // The histogram below is an expansion of the UMA_HISTOGRAM_CUSTOM_COUNTS
+  // macro adapted to allow for a dynamically suffixed histogram name.
+  // Note: The factory creates and owns the histogram.
+  base::HistogramBase* histogram = base::Histogram::FactoryGet(
+      histogram_name, min_value, max_value, num_buckets,
+      base::HistogramBase::kUmaTargetedHistogramFlag);
+  return histogram;
+}