UMA stats for WebRTC text logging.

Adds stats for start, discard, upload started, upload succeeded, and upload failed.

Bug: 809903
Change-Id: I330cff6f975ddfa93a189d3de131627cb7249155
Reviewed-on: https://chromium-review.googlesource.com/c/1354446
Reviewed-by: Tommi <[email protected]>
Reviewed-by: Jesse Doherty <[email protected]>
Reviewed-by: Oskar Sundbom <[email protected]>
Commit-Queue: Henrik Grunell <[email protected]>
Cr-Original-Commit-Position: refs/heads/master@{#613912}(cherry picked from commit e94a2eb)
Reviewed-on: https://chromium-review.googlesource.com/c/1365243
Reviewed-by: Henrik Grunell <[email protected]>
Cr-Commit-Position: refs/branch-heads/3626@{#107}
Cr-Branched-From: d897fb1-refs/heads/master@{#612437}

Author: Henrik Grunell

chrome/browser/media/webrtc/webrtc_log_uploader.cc

@@ -10,6 +10,7 @@
 #include "base/files/file_path.h"
 #include "base/files/file_util.h"
 #include "base/logging.h"
+#include "base/metrics/histogram_functions.h"
 #include "base/pickle.h"
 #include "base/strings/string_number_conversions.h"
 #include "base/strings/string_split.h"
@@ -189,6 +190,8 @@ void WebRtcLogUploader::UploadStoredLog(
   std::string compressed_log;
   if (!base::ReadFileToString(native_log_path, &compressed_log)) {
     DPLOG(WARNING) << "Could not read WebRTC log file.";
+    base::UmaHistogramSparse("WebRtcTextLogging.UploadFailed",
+                             upload_data.web_app_id);
     base::PostTaskWithTraits(
         FROM_HERE, {BrowserThread::UI},
         base::BindOnce(upload_data.callback, false, "", "Log doesn't exist."));
@@ -473,6 +476,9 @@ void WebRtcLogUploader::UploadCompressedLog(
 
   DecreaseLogCount();
 
+  // We don't log upload failure to UMA in case of shutting down for
+  // consistency, since there are other cases during shutdown were we don't get
+  // a chance to log.
   if (shutting_down_)
     return;
 
@@ -641,7 +647,12 @@ void WebRtcLogUploader::NotifyUploadDone(
   if (!upload_done_data.callback.is_null()) {
     bool success = response_code == net::HTTP_OK;
     std::string error_message;
-    if (!success) {
+    if (success) {
+      base::UmaHistogramSparse("WebRtcTextLogging.UploadSuccessful",
+                               upload_done_data.web_app_id);
+    } else {
+      base::UmaHistogramSparse("WebRtcTextLogging.UploadFailed",
+                               upload_done_data.web_app_id);
       error_message = "Uploading failed, response code: " +
                       base::IntToString(response_code);
     }

chrome/browser/media/webrtc/webrtc_log_uploader.h

@@ -34,6 +34,8 @@ struct WebRtcLogUploadDoneData : public WebRtcLogPaths {
   WebRtcLoggingHandlerHost::UploadDoneCallback callback;
   scoped_refptr<WebRtcLoggingHandlerHost> host;
   std::string local_log_id;
+  // Used for statistics. See |WebRtcLoggingHandlerHost::web_app_id_|.
+  int web_app_id;
 };
 
 // WebRtcLogUploader uploads WebRTC logs, keeps count of how many logs have

chrome/browser/media/webrtc/webrtc_logging_handler_host.cc

@@ -11,6 +11,7 @@
 #include "base/command_line.h"
 #include "base/files/file_util.h"
 #include "base/logging.h"
+#include "base/metrics/histogram_functions.h"
 #include "base/task/post_task.h"
 #include "build/build_config.h"
 #include "chrome/browser/bad_message.h"
@@ -65,6 +66,15 @@ void WebRtcLoggingHandlerHost::SetMetaData(
   DCHECK_CURRENTLY_ON(BrowserThread::IO);
   DCHECK(!callback.is_null());
 
+  // Set the web app ID if there's a "client" key, otherwise leave it unchanged.
+  for (const auto& it : *meta_data) {
+    if (it.first == "client") {
+      web_app_id_ = static_cast<int>(base::PersistentHash(it.second));
+      text_log_handler_->SetWebAppId(web_app_id_);
+      break;
+    }
+  }
+
   text_log_handler_->SetMetaData(std::move(meta_data), callback);
 }
 
@@ -106,6 +116,8 @@ void WebRtcLoggingHandlerHost::UploadLog(const UploadDoneCallback& callback) {
   // Would it be better to upload whatever logs we have, or would the lack of
   // an error callback make it harder to debug potential errors?
 
+  base::UmaHistogramSparse("WebRtcTextLogging.UploadStarted", web_app_id_);
+
   base::PostTaskAndReplyWithResult(
       log_uploader_->background_task_runner().get(), FROM_HERE,
       base::Bind(&WebRtcLoggingHandlerHost::GetLogDirectoryAndEnsureExists,
@@ -119,14 +131,18 @@ void WebRtcLoggingHandlerHost::UploadStoredLog(
   DCHECK_CURRENTLY_ON(BrowserThread::IO);
   DCHECK(!callback.is_null());
 
+  base::UmaHistogramSparse("WebRtcTextLogging.UploadStoredStarted",
+                           web_app_id_);
+
   log_uploader_->background_task_runner()->PostTask(
       FROM_HERE,
       base::BindOnce(&WebRtcLoggingHandlerHost::UploadStoredLogOnFileThread,
-                     this, log_id, callback));
+                     this, log_id, web_app_id_, callback));
 }
 
 void WebRtcLoggingHandlerHost::UploadStoredLogOnFileThread(
     const std::string& log_id,
+    int web_app_id,
     const UploadDoneCallback& callback) {
   DCHECK(log_uploader_->background_task_runner()->RunsTasksInCurrentSequence());
 
@@ -135,6 +151,7 @@ void WebRtcLoggingHandlerHost::UploadStoredLogOnFileThread(
   upload_data.callback = callback;
   upload_data.host = this;
   upload_data.local_log_id = log_id;
+  upload_data.web_app_id = web_app_id;
 
   log_uploader_->UploadStoredLog(upload_data);
 }
@@ -507,6 +524,13 @@ void WebRtcLoggingHandlerHost::DoUploadLogAndRtpDumps(
        text_logging_state != WebRtcTextLogHandler::STOPPED) ||
       (channel_is_closing &&
        text_log_handler_->GetState() == WebRtcTextLogHandler::CLOSED)) {
+    // If the channel is not closing the log is expected to be uploaded, so
+    // it's considered a failure if it isn't.
+    // If the channel is closing we don't log failure to UMA for consistency,
+    // since there are other cases during shutdown were we don't get a chance
+    // to log.
+    if (!channel_is_closing)
+      base::UmaHistogramSparse("WebRtcTextLogging.UploadFailed", web_app_id_);
     base::PostTaskWithTraits(
         FROM_HERE, {content::BrowserThread::UI},
         base::BindOnce(callback, false, "",
@@ -518,6 +542,7 @@ void WebRtcLoggingHandlerHost::DoUploadLogAndRtpDumps(
   upload_done_data.log_path = log_directory;
   upload_done_data.callback = callback;
   upload_done_data.host = this;
+  upload_done_data.web_app_id = web_app_id_;
   ReleaseRtpDumps(&upload_done_data);
 
   std::unique_ptr<WebRtcLogBuffer> log_buffer;

chrome/browser/media/webrtc/webrtc_logging_handler_host.h

@@ -187,6 +187,7 @@ class WebRtcLoggingHandlerHost : public content::BrowserMessageFilter {
                            const base::FilePath& directory);
 
   void UploadStoredLogOnFileThread(const std::string& log_id,
+                                   int web_app_id,
                                    const UploadDoneCallback& callback);
 
   // A helper for TriggerUpload to do the real work.
@@ -250,6 +251,11 @@ class WebRtcLoggingHandlerHost : public content::BrowserMessageFilter {
   // Ownership lies with the browser process.
   WebRtcLogUploader* const log_uploader_;
 
+  // Web app id used for statistics. Created as the hash of the value of a
+  // "client" meta data key, if exists. 0 means undefined, and is the hash of
+  // the empty string. Must only be accessed on the IO thread.
+  int web_app_id_ = 0;
+
   DISALLOW_COPY_AND_ASSIGN(WebRtcLoggingHandlerHost);
 };
 

chrome/browser/media/webrtc/webrtc_text_log_handler.cc

@@ -13,6 +13,7 @@
 #include "base/cpu.h"
 #include "base/feature_list.h"
 #include "base/logging.h"
+#include "base/metrics/histogram_functions.h"
 #include "base/strings/strcat.h"
 #include "base/strings/string_number_conversions.h"
 #include "base/strings/stringprintf.h"
@@ -243,6 +244,8 @@ void WebRtcTextLogHandler::StartDone(const GenericDoneCallback& callback) {
 
   DCHECK_EQ(STARTING, logging_state_);
 
+  base::UmaHistogramSparse("WebRtcTextLogging.Start", web_app_id_);
+
   logging_started_time_ = base::Time::Now();
   logging_state_ = STARTED;
   FireGenericDoneCallback(callback, true, "");
@@ -306,6 +309,8 @@ void WebRtcTextLogHandler::DiscardLog() {
   DCHECK(logging_state_ == STOPPED ||
          (channel_is_closing_ && logging_state_ != CLOSED));
 
+  base::UmaHistogramSparse("WebRtcTextLogging.Discard", web_app_id_);
+
   log_buffer_.reset();
   meta_data_.reset();
   logging_state_ = LoggingState::CLOSED;
@@ -410,6 +415,11 @@ void WebRtcTextLogHandler::FireGenericDoneCallback(
       base::BindOnce(callback, success, error_message_with_state));
 }
 
+void WebRtcTextLogHandler::SetWebAppId(int web_app_id) {
+  DCHECK_CURRENTLY_ON(BrowserThread::IO);
+  web_app_id_ = web_app_id;
+}
+
 void WebRtcTextLogHandler::LogInitialInfoOnIOThread(
     const GenericDoneCallback& callback,
     const net::NetworkInterfaceList& network_list) {

chrome/browser/media/webrtc/webrtc_text_log_handler.h

@@ -133,6 +133,9 @@ class WebRtcTextLogHandler
                                bool success,
                                const std::string& error_message);
 
+  // Must be called on the IO thread.
+  void SetWebAppId(int web_app_id);
+
  private:
   friend class base::RefCountedThreadSafe<WebRtcTextLogHandler>;
   ~WebRtcTextLogHandler();
@@ -172,6 +175,11 @@ class WebRtcTextLogHandler
   // changes to STOPPED.
   base::Time logging_started_time_;
 
+  // Web app id used for statistics. See
+  // |WebRtcLoggingHandlerHost::web_app_id_|. Must only be accessed on the IO
+  // thread.
+  int web_app_id_ = 0;
+
   DISALLOW_COPY_AND_ASSIGN(WebRtcTextLogHandler);
 };
 

tools/metrics/histograms/enums.xml

@@ -53420,6 +53420,11 @@ Full version information for the fingerprint enum values:
   <int value="1" label="Error"/>
 </enum>
 
+<enum name="WebRtcLoggingWebAppIdHash">
+  <int value="-100222544" label="Hangouts"/>
+  <int value="0" label="Undefined"/>
+</enum>
+
 <enum name="WebRtcNativeRate">
   <int value="0" label="8kHz"/>
   <int value="1" label="16kHz"/>

tools/metrics/histograms/histograms.xml

@@ -126115,6 +126115,15 @@ uploading your change for review.
   <summary>Time for capturing one frame in window capturing.</summary>
 </histogram>
 
+<histogram base="true" name="WebRtcTextLogging"
+    enum="WebRtcLoggingWebAppIdHash">
+  <owner>[email protected]</owner>
+  <summary>
+    Counts the number of WebRTC text log events per web application. Suffixed by
+    event.
+  </summary>
+</histogram>
+
 <histogram name="WebShare.ApiCount" enum="WebShareMethod">
   <owner>[email protected]</owner>
   <summary>
@@ -140032,6 +140041,16 @@ uploading your change for review.
   <affected-histogram name="WebRTC.Audio.EchoCanceller.SuppressorGainBand1"/>
 </histogram_suffixes>
 
+<histogram_suffixes name="WebRtcLoggingEvent" separator=".">
+  <suffix name="Discard" label="Discard"/>
+  <suffix name="Start" label="Start"/>
+  <suffix name="UploadFailed" label="Upload failed"/>
+  <suffix name="UploadStarted" label="Upload started"/>
+  <suffix name="UploadStoredStarted" label="Upload of a stored log started"/>
+  <suffix name="UploadSuccessful" label="Upload successful"/>
+  <affected-histogram name="WebRtcTextLogging"/>
+</histogram_suffixes>
+
 <histogram_suffixes name="WebRTCMediaType" separator=".">
   <suffix name="Audio" label="Audio"/>
   <suffix name="Data" label="Data"/>