Translate: UMA for "Show original"

chrome/browser/translate/translate_infobar_delegate.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 "chrome/browser/translate/translate_infobar_delegate.h"
 
 #include <algorithm>
 
 #include "base/i18n/string_compare.h"
 #include "base/metrics/histogram.h"
 #include "chrome/browser/browser_process.h"
 #include "chrome/browser/infobars/infobar_service.h"
 #include "chrome/browser/profiles/profile.h"
 #include "chrome/browser/translate/translate_manager.h"
 #include "chrome/browser/translate/translate_tab_helper.h"
 #include "content/public/browser/navigation_details.h"
 #include "content/public/browser/navigation_entry.h"
 #include "content/public/browser/web_contents.h"
 #include "grit/generated_resources.h"
 #include "grit/theme_resources.h"
 #include "third_party/icu/public/i18n/unicode/coll.h"
 #include "ui/base/l10n/l10n_util.h"
 
 using content::NavigationEntry;
 
 namespace {
 
-const char kTranslateShowErrorInfobar[] = "Translate.ShowErrorInfobar";
+const char kDeclineTranslate[] = "Translate.DeclineTranslate";
+const char kCloseInfobar[] = "Translate.DeclineTranslateCloseInfobar";
+const char kRevertTranslation[] = "Translate.RevertTranslation";
+const char kShowErrorInfobar[] = "Translate.ShowErrorInfobar";
+const char kPerformTranslate[] = "Translate.Translate";
 
 }  // namespace
 
 // static
 const size_t TranslateInfoBarDelegate::kNoIndex = static_cast<size_t>(-1);
 
 TranslateInfoBarDelegate::~TranslateInfoBarDelegate() {
 }
 
 // static
@@ skipping 41 matching lines @@
 void TranslateInfoBarDelegate::Translate() {
   if (!web_contents()->GetBrowserContext()->IsOffTheRecord()) {
     prefs_.ResetTranslationDeniedCount(original_language_code());
     prefs_.IncrementTranslationAcceptedCount(original_language_code());
   }
 
   TranslateManager::GetInstance()->TranslatePage(web_contents(),
                                                  original_language_code(),
                                                  target_language_code());
 
-  UMA_HISTOGRAM_COUNTS("Translate.Translate", 1);
+  UMA_HISTOGRAM_COUNTS(kPerformTranslate, 1);
 }
 
 void TranslateInfoBarDelegate::RevertTranslation() {
   TranslateManager::GetInstance()->RevertTranslation(web_contents());
   RemoveSelf();
+
+  UMA_HISTOGRAM_COUNTS(kRevertTranslation, 1);

[jar (doing other things), 2013/05/23 17:20:00]

This pattern of trying to use histograms as single bucket counters is actually
problematic in several ways.

First of all, you really want to see the counts next to each other, so using an
enumerated histogram gets you these counters visualized exactly as you actually
need them: Several counters next to one another, providing normalization factors
for each other.

Second, it is wasteful of both run-time memory, and backend dashboard-pipeline
memory.  The cost of "an additional enumerated bucket" is about 12 bytes in the
browser.  Adding another histogram is surely in the range of a few hundred bytes
minimum to the browser, and a similar jump in cost/complexity in the processing
pipeline :-(.

Lastly, you've accidentally used UMA_HISTOGRAM_COUNTS(), which creates space for
50 buckets.  That costs about 500-600 bytes.  Much better in this poor usage
pattern would be UMA_HISOGRAM_BOOLEAN(), which at least only creates one bucket.

Bottom line: You really should use an enumerated histogram.  If you really want
to use up a few KB of RAM space extra, and stay with this pattern, you should at
least use UMA_HISTOGRAM_BOOLEAN("foo", true);

 }
 
 void TranslateInfoBarDelegate::ReportLanguageDetectionError() {
   TranslateManager::GetInstance()->
       ReportLanguageDetectionError(web_contents());
 }
 
 void TranslateInfoBarDelegate::TranslationDeclined() {
   if (!web_contents()->GetBrowserContext()->IsOffTheRecord()) {
     prefs_.ResetTranslationAcceptedCount(original_language_code());
     prefs_.IncrementTranslationDeniedCount(original_language_code());
   }
 
   // Remember that the user declined the translation so as to prevent showing a
   // translate infobar for that page again.  (TranslateManager initiates
   // translations when getting a LANGUAGE_DETERMINED from the page, which
   // happens when a load stops. That could happen multiple times, including
   // after the user already declined the translation.)
   TranslateTabHelper* translate_tab_helper =
       TranslateTabHelper::FromWebContents(web_contents());
   translate_tab_helper->language_state().set_translation_declined(true);
 
-  UMA_HISTOGRAM_COUNTS("Translate.DeclineTranslate", 1);
+  UMA_HISTOGRAM_COUNTS(kDeclineTranslate, 1);
 }
 
 bool TranslateInfoBarDelegate::InTranslateNavigation() {
   TranslateTabHelper* translate_tab_helper =
       TranslateTabHelper::FromWebContents(web_contents());
   if (!translate_tab_helper)
     return false;
   return translate_tab_helper->language_state().InTranslateNavigation();
 }
 
@@ skipping 58 matching lines @@
   RemoveSelf();
 }
 
 string16 TranslateInfoBarDelegate::GetMessageInfoBarText() {
   if (infobar_type_ == TRANSLATING) {
     return l10n_util::GetStringFUTF16(IDS_TRANSLATE_INFOBAR_TRANSLATING_TO,
                                       language_name_at(target_language_index_));
   }
 
   DCHECK_EQ(TRANSLATION_ERROR, infobar_type_);
-  UMA_HISTOGRAM_ENUMERATION(kTranslateShowErrorInfobar,
+  UMA_HISTOGRAM_ENUMERATION(kShowErrorInfobar,
                             error_type_,
                             TranslateErrors::TRANSLATE_ERROR_MAX);
   switch (error_type_) {
     case TranslateErrors::NETWORK:
       return l10n_util::GetStringUTF16(
           IDS_TRANSLATE_INFOBAR_ERROR_CANT_CONNECT);
     case TranslateErrors::INITIALIZATION_ERROR:
     case TranslateErrors::TRANSLATION_ERROR:
       return l10n_util::GetStringUTF16(
           IDS_TRANSLATE_INFOBAR_ERROR_CANT_TRANSLATE);
@@ skipping 159 matching lines @@
 
   return InfoBarDelegate::ShouldExpireInternal(details);
 }
 
 void TranslateInfoBarDelegate::InfoBarDismissed() {
   if (infobar_type_ != BEFORE_TRANSLATE)
     return;
 
   // The user closed the infobar without clicking the translate button.
   TranslationDeclined();
-  UMA_HISTOGRAM_COUNTS("Translate.DeclineTranslateCloseInfobar", 1);
+  UMA_HISTOGRAM_COUNTS(kCloseInfobar, 1);
 }
 
 int TranslateInfoBarDelegate::GetIconID() const {
   return IDR_INFOBAR_TRANSLATE;
 }
 
 InfoBarDelegate::Type TranslateInfoBarDelegate::GetInfoBarType() const {
   return PAGE_ACTION_TYPE;
 }
 
 TranslateInfoBarDelegate*
     TranslateInfoBarDelegate::AsTranslateInfoBarDelegate() {
   return this;
 }
 
 std::string TranslateInfoBarDelegate::GetPageHost() {
   NavigationEntry* entry = web_contents()->GetController().GetActiveEntry();
   return entry ? entry->GetURL().HostNoBrackets() : std::string();
 }