chromecast/base/metrics/cast_metrics_helper.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 "chromecast/base/metrics/cast_metrics_helper.h"
   6
   7 #include "base/bind.h"
   8 #include "base/bind_helpers.h"
   9 #include "base/location.h"
  10 #include "base/metrics/histogram.h"
  11 #include "base/metrics/user_metrics.h"
  12 #include "base/single_thread_task_runner.h"
  13 #include "base/strings/string_split.h"
  14 #include "base/strings/string_util.h"
  15 #include "chromecast/base/metrics/cast_histograms.h"
  16 #include "chromecast/base/metrics/grouped_histogram.h"
  17
  18 namespace chromecast {
  19 namespace metrics {
  20
  21 // A useful macro to make sure current member function runs on the valid thread.
  22 #define MAKE_SURE_THREAD(callback, ...)                                        \
  23   if (!task_runner_->BelongsToCurrentThread()) {                               \
  24     task_runner_->PostTask(FROM_HERE,                                          \
  25                            base::Bind(&CastMetricsHelper::callback,            \
  26                                       base::Unretained(this), ##__VA_ARGS__)); \
  27     return;                                                                    \
  28   }
  29
  30 namespace {
  31
  32 CastMetricsHelper* g_instance = NULL;
  33
  34 const char kMetricsNameAppInfoDelimiter = '#';
  35
  36 }  // namespace
  37
  38 // static
  39
  40 // NOTE(gfhuang): This is a hacky way to encode/decode app infos into a
  41 // string. Mainly because it's hard to add another metrics serialization type
  42 // into components/metrics/serialization/.
  43 // static
  44 bool CastMetricsHelper::DecodeAppInfoFromMetricsName(
  45     const std::string& metrics_name,
  46     std::string* action_name,
  47     std::string* app_id,
  48     std::string* session_id,
  49     std::string* sdk_version) {
  50   DCHECK(action_name);
  51   DCHECK(app_id);
  52   DCHECK(session_id);
  53   DCHECK(sdk_version);
  54   if (metrics_name.find(kMetricsNameAppInfoDelimiter) == std::string::npos)
  55     return false;
  56
  57   std::vector<std::string> tokens;
  58   base::SplitString(metrics_name, kMetricsNameAppInfoDelimiter, &tokens);
  59   DCHECK_EQ(tokens.size(), 4u);
  60   // The order of tokens should match EncodeAppInfoIntoMetricsName().
  61   *action_name = tokens[0];
  62   *app_id = tokens[1];
  63   *session_id = tokens[2];
  64   *sdk_version = tokens[3];
  65   return true;
  66 }
  67
  68 // static
  69 std::string CastMetricsHelper::EncodeAppInfoIntoMetricsName(
  70     const std::string& action_name,
  71     const std::string& app_id,
  72     const std::string& session_id,
  73     const std::string& sdk_version) {
  74   std::string result(action_name);
  75   result.push_back(kMetricsNameAppInfoDelimiter);
  76   result.append(app_id);
  77   result.push_back(kMetricsNameAppInfoDelimiter);
  78   result.append(session_id);
  79   result.push_back(kMetricsNameAppInfoDelimiter);
  80   result.append(sdk_version);
  81   return result;
  82 }
  83
  84 // static
  85 CastMetricsHelper* CastMetricsHelper::GetInstance() {
  86   DCHECK(g_instance);
  87   return g_instance;
  88 }
  89
  90 CastMetricsHelper::CastMetricsHelper(
  91     scoped_refptr<base::SingleThreadTaskRunner> task_runner)
  92     : task_runner_(task_runner),
  93       metrics_sink_(NULL),
  94       record_action_callback_(base::Bind(&base::RecordComputedAction)) {
  95   DCHECK(task_runner_.get());
  96   DCHECK(!g_instance);
  97   g_instance = this;
  98 }
  99
 100 CastMetricsHelper::CastMetricsHelper()
 101     : metrics_sink_(NULL) {
 102   DCHECK(!g_instance);
 103   g_instance = this;
 104 }
 105
 106 CastMetricsHelper::~CastMetricsHelper() {
 107   DCHECK_EQ(g_instance, this);
 108   g_instance = NULL;
 109 }
 110
 111 void CastMetricsHelper::UpdateCurrentAppInfo(const std::string& app_id,
 112                                              const std::string& session_id) {
 113   MAKE_SURE_THREAD(UpdateCurrentAppInfo, app_id, session_id);
 114   app_id_ = app_id;
 115   session_id_ = session_id;
 116   app_start_time_ = base::TimeTicks::Now();
 117   TagAppStartForGroupedHistograms(app_id_);
 118   sdk_version_.clear();
 119 }
 120
 121 void CastMetricsHelper::UpdateSDKInfo(const std::string& sdk_version) {
 122   MAKE_SURE_THREAD(UpdateSDKInfo, sdk_version);
 123   sdk_version_ = sdk_version;
 124 }
 125
 126 void CastMetricsHelper::LogMediaPlay() {
 127   MAKE_SURE_THREAD(LogMediaPlay);
 128   RecordSimpleAction(EncodeAppInfoIntoMetricsName(
 129       "MediaPlay",
 130       app_id_,
 131       session_id_,
 132       sdk_version_));
 133 }
 134
 135 void CastMetricsHelper::LogMediaPause() {
 136   MAKE_SURE_THREAD(LogMediaPause);
 137   RecordSimpleAction(EncodeAppInfoIntoMetricsName(
 138       "MediaPause",
 139       app_id_,
 140       session_id_,
 141       sdk_version_));
 142 }
 143
 144 void CastMetricsHelper::LogTimeToFirstPaint() {
 145   MAKE_SURE_THREAD(LogTimeToFirstPaint);
 146   if (app_id_.empty())
 147     return;
 148   base::TimeDelta launch_time = base::TimeTicks::Now() - app_start_time_;
 149   const std::string uma_name(GetMetricsNameWithAppName("Startup",
 150                                                        "TimeToFirstPaint"));
 151   LogMediumTimeHistogramEvent(uma_name, launch_time);
 152   LOG(INFO) << uma_name << " is " << launch_time.InSecondsF() << " seconds.";
 153 }
 154
 155 void CastMetricsHelper::LogTimeToBufferAv(BufferingType buffering_type,
 156                                           base::TimeDelta time) {
 157   MAKE_SURE_THREAD(LogTimeToBufferAv, buffering_type, time);
 158   if (time < base::TimeDelta::FromSeconds(0)) {
 159     LOG(WARNING) << "Negative time";
 160     return;
 161   }
 162
 163   const std::string uma_name(GetMetricsNameWithAppName(
 164       "Media",
 165       (buffering_type == kInitialBuffering ? "TimeToBufferAv" :
 166        buffering_type == kBufferingAfterUnderrun ?
 167            "TimeToBufferAvAfterUnderrun" :
 168        buffering_type == kAbortedBuffering ? "TimeToBufferAvAfterAbort" : "")));
 169
 170   // Histogram from 250ms to 30s with 50 buckets.
 171   // The ratio between 2 consecutive buckets is:
 172   // exp( (ln(30000) - ln(250)) / 50 ) = 1.1
 173   LogTimeHistogramEvent(
 174       uma_name,
 175       time,
 176       base::TimeDelta::FromMilliseconds(250),
 177       base::TimeDelta::FromMilliseconds(30000),
 178       50);
 179 }
 180
 181 std::string CastMetricsHelper::GetMetricsNameWithAppName(
 182     const std::string& prefix,
 183     const std::string& suffix) const {
 184   DCHECK(task_runner_->BelongsToCurrentThread());
 185   std::string metrics_name(prefix);
 186   if (!app_id_.empty()) {
 187     if (!metrics_name.empty())
 188       metrics_name.push_back('.');
 189     metrics_name.append(app_id_);
 190   }
 191   if (!suffix.empty()) {
 192     if (!metrics_name.empty())
 193       metrics_name.push_back('.');
 194     metrics_name.append(suffix);
 195   }
 196   return metrics_name;
 197 }
 198
 199 void CastMetricsHelper::SetMetricsSink(MetricsSink* delegate) {
 200   MAKE_SURE_THREAD(SetMetricsSink, delegate);
 201   metrics_sink_ = delegate;
 202 }
 203
 204 void CastMetricsHelper::SetRecordActionCallback(
 205       const RecordActionCallback& callback) {
 206   DCHECK(task_runner_->BelongsToCurrentThread());
 207   record_action_callback_ = callback;
 208 }
 209
 210 void CastMetricsHelper::RecordSimpleAction(const std::string& action) {
 211   MAKE_SURE_THREAD(RecordSimpleAction, action);
 212
 213   if (metrics_sink_) {
 214     metrics_sink_->OnAction(action);
 215   } else {
 216     record_action_callback_.Run(action);
 217   }
 218 }
 219
 220 void CastMetricsHelper::LogEnumerationHistogramEvent(
 221     const std::string& name, int value, int num_buckets) {
 222   MAKE_SURE_THREAD(LogEnumerationHistogramEvent, name, value, num_buckets);
 223
 224   if (metrics_sink_) {
 225     metrics_sink_->OnEnumerationEvent(name, value, num_buckets);
 226   } else {
 227     UMA_HISTOGRAM_ENUMERATION_NO_CACHE(name, value, num_buckets);
 228   }
 229 }
 230
 231 void CastMetricsHelper::LogTimeHistogramEvent(const std::string& name,
 232                                               const base::TimeDelta& value,
 233                                               const base::TimeDelta& min,
 234                                               const base::TimeDelta& max,
 235                                               int num_buckets) {
 236   MAKE_SURE_THREAD(LogTimeHistogramEvent, name, value, min, max, num_buckets);
 237
 238   if (metrics_sink_) {
 239     metrics_sink_->OnTimeEvent(name, value, min, max, num_buckets);
 240   } else {
 241     UMA_HISTOGRAM_CUSTOM_TIMES_NO_CACHE(name, value, min, max, num_buckets);
 242   }
 243 }
 244
 245 void CastMetricsHelper::LogMediumTimeHistogramEvent(
 246     const std::string& name,
 247     const base::TimeDelta& value) {
 248   // Follow UMA_HISTOGRAM_MEDIUM_TIMES definition.
 249   LogTimeHistogramEvent(name, value,
 250                         base::TimeDelta::FromMilliseconds(10),
 251                         base::TimeDelta::FromMinutes(3),
 252                         50);
 253 }
 254
 255 }  // namespace metrics
 256 }  // namespace chromecast