Add UpdateCurrentAppInfo() interface to record info about current app, including

chromecast/base/metrics/cast_metrics_helper.cc

 // Copyright 2014 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 "chromecast/base/metrics/cast_metrics_helper.h"
 
 #include "base/bind.h"
 #include "base/bind_helpers.h"
 #include "base/location.h"
 #include "base/message_loop/message_loop_proxy.h"
 #include "base/metrics/histogram.h"
 #include "base/metrics/user_metrics.h"
+#include "base/strings/string_split.h"
+#include "base/strings/string_util.h"
 #include "chromecast/base/metrics/cast_histograms.h"
 #include "chromecast/base/metrics/grouped_histogram.h"
 
 namespace chromecast {
 namespace metrics {
 
 // A useful macro to make sure current member function runs on the valid thread.
 #define MAKE_SURE_THREAD(callback, ...)                    \
   if (!message_loop_proxy_->BelongsToCurrentThread()) {    \
     message_loop_proxy_->PostTask(FROM_HERE, base::Bind(   \
         &CastMetricsHelper::callback,                      \
         base::Unretained(this), ##__VA_ARGS__));           \
     return;                                                \
   }
 
 namespace {
 
 CastMetricsHelper* g_instance = NULL;
 
 // Displayed frames are logged in frames per second (but sampling can be over
 // a longer period of time, e.g. 5 seconds).
 const int kDisplayedFramesPerSecondPeriod = 1000000;
 
 // Sample every 5 seconds, represented in microseconds.
 const int kNominalVideoSamplePeriod = 5000000;
 
 }  // namespace
 
+// static
+const char CastMetricsHelper::kMetricsNameAppInfoDelimiter = '#';
+
+// static
+CastMetricsHelper::MetricsAppInfo CastMetricsHelper::GetAppInfoFromMetricsName(
+    const std::string& metrics_name) {
+  // TODO(gfhuang): This is a hacky way to encode/decode app infos into a

[gunsch, 2014/12/10 22:43:58]

Got a planned approach for the TODO, or is this just an FYI?

[gfhuang, 2014/12/11 02:59:39]

Change to a NOTE.

+  // string. Mainly because it's hard to add another metrics serialization type
+  // into components/metrics/serialization/.
+  std::vector<std::string> tokens;
+  base::SplitString(metrics_name, kMetricsNameAppInfoDelimiter, &tokens);
+  DCHECK_EQ(tokens.size(), 4u);
+  CastMetricsHelper::MetricsAppInfo metrics_app_info;
+  // The order of tokens should match GetMetricsNameWithAppInfo().
+  metrics_app_info.action_name = tokens[0];
+  metrics_app_info.app_id = tokens[1];
+  metrics_app_info.session_id = tokens[2];
+  metrics_app_info.sdk_version = tokens[3];
+  return metrics_app_info;
+}
+
+// static
 CastMetricsHelper* CastMetricsHelper::GetInstance() {
   DCHECK(g_instance);
   return g_instance;
 }
 
+CastMetricsHelper::MetricsAppInfo::MetricsAppInfo() {
+}
+
+CastMetricsHelper::MetricsAppInfo::~MetricsAppInfo() {
+}
+
 CastMetricsHelper::CastMetricsHelper(
     scoped_refptr<base::MessageLoopProxy> message_loop_proxy)
     : message_loop_proxy_(message_loop_proxy),
       metrics_sink_(NULL),
       record_action_callback_(base::Bind(&base::RecordComputedAction)) {
   DCHECK(message_loop_proxy_.get());
   DCHECK(!g_instance);
   g_instance = this;
 }
 
 CastMetricsHelper::CastMetricsHelper()
     : metrics_sink_(NULL) {
   DCHECK(!g_instance);
   g_instance = this;
 }
 
 CastMetricsHelper::~CastMetricsHelper() {
   DCHECK_EQ(g_instance, this);
   g_instance = NULL;
 }
 
 void CastMetricsHelper::TagAppStart(const std::string& arg_app_name) {
   MAKE_SURE_THREAD(TagAppStart, arg_app_name);
   app_name_ = arg_app_name;
   app_start_time_ = base::TimeTicks::Now();
   new_startup_time_ = true;
 
   TagAppStartForGroupedHistograms(app_name_);
+  // Clear app info
+  UpdateCurrentAppInfo("", "", "");
 }
 
+void CastMetricsHelper::UpdateCurrentAppInfo(const std::string& app_id,
+                                             const std::string& session_id,
+                                             const std::string& sdk_version) {
+  MAKE_SURE_THREAD(UpdateCurrentAppInfo, app_id, session_id, sdk_version);
+  app_id_ = app_id;
+  session_id_ = session_id;
+  sdk_version_ = sdk_version;
+}

[gunsch, 2014/12/10 22:43:58]

style nit: blank line between methods

[gfhuang, 2014/12/11 02:59:39]

Done.

 void CastMetricsHelper::LogMediaPlay() {
-  RecordSimpleAction(GetMetricsNameWithAppName("MediaPlay", ""));
+  RecordSimpleAction(GetMetricsNameWithAppInfo("MediaPlay"));
 }
 
 void CastMetricsHelper::LogMediaPause() {
-  RecordSimpleAction(GetMetricsNameWithAppName("MediaPause", ""));
+  RecordSimpleAction(GetMetricsNameWithAppInfo("MediaPause"));
 }
 
 void CastMetricsHelper::LogTimeToDisplayVideo() {
   if (!new_startup_time_) {  // For faster check.
     return;
   }
   MAKE_SURE_THREAD(LogTimeToDisplayVideo);
   new_startup_time_ = false;
   base::TimeDelta launch_time = base::TimeTicks::Now() - app_start_time_;
   const std::string uma_name(GetMetricsNameWithAppName("Startup",
@@ skipping 90 matching lines @@
     metrics_name.append(app_name_);
   }
   if (!suffix.empty()) {
     if (!metrics_name.empty())
       metrics_name.push_back('.');
     metrics_name.append(suffix);
   }
   return metrics_name;
 }
 
+std::string CastMetricsHelper::GetMetricsNameWithAppInfo(
+    const std::string& action_name) const {
+  DCHECK(message_loop_proxy_->BelongsToCurrentThread());
+  std::vector<std::string> parts;
+  parts.push_back(action_name);
+  parts.push_back(app_id_);
+  parts.push_back(session_id_);
+  parts.push_back(sdk_version_);
+  return JoinString(parts, kMetricsNameAppInfoDelimiter);
+}
+
 void CastMetricsHelper::SetMetricsSink(MetricsSink* delegate) {
   MAKE_SURE_THREAD(SetMetricsSink, delegate);
   metrics_sink_ = delegate;
 }
 
 void CastMetricsHelper::SetRecordActionCallback(
       const RecordActionCallback& callback) {
   DCHECK(message_loop_proxy_->BelongsToCurrentThread());
   record_action_callback_ = callback;
 }
@@ skipping 38 matching lines @@
     const base::TimeDelta& value) {
   // Follow UMA_HISTOGRAM_MEDIUM_TIMES definition.
   LogTimeHistogramEvent(name, value,
                         base::TimeDelta::FromMilliseconds(10),
                         base::TimeDelta::FromMinutes(3),
                         50);
 }
 
 }  // namespace metrics
 }  // namespace chromecast