Add histograms for ExternalDataUseObserver

chrome/browser/android/data_usage/external_data_use_observer.h

 // Copyright 2015 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.
 
 #ifndef CHROME_BROWSER_ANDROID_DATA_USAGE_EXTERNAL_DATA_USE_OBSERVER_H_
 #define CHROME_BROWSER_ANDROID_DATA_USAGE_EXTERNAL_DATA_USE_OBSERVER_H_
 
 #include <jni.h>
 #include <stdint.h>
 
@@ skipping 36 matching lines @@
 // owns a Java listener object that is notified of the data usage observations
 // of Chromium. This class receives regular expressions from the Java listener
 // object. It also registers as a data use observer with DataUseAggregator,
 // filters the received observations by applying the regex matching to the URLs
 // of the requests, and notifies the filtered data use to the Java listener. The
 // Java object in turn may notify the platform APIs of the data usage
 // observations.
 // TODO(tbansal): Create an inner class that manages the UI and IO threads.
 class ExternalDataUseObserver : public data_usage::DataUseAggregator::Observer {
  public:
+  // Result of data usage report submission.

[sclittle, 2015/12/08 00:36:21]

nit: mention that this should be kept in sync with the histograms.xml enum

[tbansal1, 2015/12/08 02:01:25]

Done.

+  enum DataUsageReportSubmissionResult {
+    // Submission of data use report to the external observer was successful.
+    DATAUSAGE_REPORT_SUBMISSION_SUCCESSFUL = 0,
+    // Submission of data use report to the external observer returned error.
+    DATAUSAGE_REPORT_SUBMISSION_FAILED = 1,
+    // Submission of data use report to the external observer timed out.
+    DATAUSAGE_REPORT_SUBMISSION_TIMED_OUT = 2,
+    // Data use report was lost before an attempt was made to submit it.
+    DATAUSAGE_REPORT_SUBMISSION_LOST = 3,
+    DATAUSAGE_REPORT_SUBMISSION_BOUNDARY = 4

[sclittle, 2015/12/08 00:36:21]

nit: isn't the typical naming for this "..._MAX"?

[tbansal1, 2015/12/08 02:01:25]

Done. Not sure, I have seen both.

+  };
+
   // External data use observer field trial name.
   static const char kExternalDataUseObserverFieldTrial[];
 
   ExternalDataUseObserver(
       data_usage::DataUseAggregator* data_use_aggregator,
       scoped_refptr<base::SingleThreadTaskRunner> io_task_runner,
       scoped_refptr<base::SingleThreadTaskRunner> ui_task_runner);
   ~ExternalDataUseObserver() override;
 
   // Called by Java when new matching rules have been fetched. This may be
@@ skipping 29 matching lines @@
   // names. |label| must not be null. If a match is found, the |label| is set
   // to the matching rule's label.
   bool MatchesAppPackageName(const std::string& app_package_name,
                              std::string* label) const;
 
   DataUseTabModel* GetDataUseTabModel() const;
 
  private:
   friend class DataUseTabModelTest;
   friend class ExternalDataUseObserverTest;
-  FRIEND_TEST_ALL_PREFIXES(DataUseUITabModelTest, ReportTabEventsTest);
   FRIEND_TEST_ALL_PREFIXES(ExternalDataUseObserverTest, BufferDataUseReports);
   FRIEND_TEST_ALL_PREFIXES(ExternalDataUseObserverTest, BufferSize);
   FRIEND_TEST_ALL_PREFIXES(ExternalDataUseObserverTest, ChangeRegex);
+  FRIEND_TEST_ALL_PREFIXES(ExternalDataUseObserverTest, DataUseReportTimedOut);
   FRIEND_TEST_ALL_PREFIXES(ExternalDataUseObserverTest, HashFunction);
   FRIEND_TEST_ALL_PREFIXES(ExternalDataUseObserverTest, LabelRemoved);
   FRIEND_TEST_ALL_PREFIXES(ExternalDataUseObserverTest, MultipleMatchingRules);
   FRIEND_TEST_ALL_PREFIXES(ExternalDataUseObserverTest, MultipleRegex);
   FRIEND_TEST_ALL_PREFIXES(ExternalDataUseObserverTest,
                            PeriodicFetchMatchingRules);
   FRIEND_TEST_ALL_PREFIXES(ExternalDataUseObserverTest, ReportsMergedCorrectly);
+  FRIEND_TEST_ALL_PREFIXES(DataUseUITabModelTest, ReportTabEventsTest);
   FRIEND_TEST_ALL_PREFIXES(ExternalDataUseObserverTest, SingleRegex);
   FRIEND_TEST_ALL_PREFIXES(ExternalDataUseObserverTest,
                            TimestampsMergedCorrectly);
   FRIEND_TEST_ALL_PREFIXES(ExternalDataUseObserverTest, TwoRegex);
   FRIEND_TEST_ALL_PREFIXES(ExternalDataUseObserverTest, Variations);
 
   // DataUseReportKey is a unique identifier for a data use report.
   struct DataUseReportKey {
     DataUseReportKey(const std::string& label,
                      net::NetworkChangeNotifier::ConnectionType connection_type,
@@ skipping 145 matching lines @@
   // expressions are applied to the request URLs, and filtered data use is
   // notified to |j_external_data_use_observer_|.
   base::android::ScopedJavaGlobalRef<jobject> j_external_data_use_observer_;
 
   // Maintains tab sessions.
   scoped_ptr<DataUseTabModel> data_use_tab_model_;
 
   // True if callback from |FetchMatchingRulesDone| is currently pending.
   bool matching_rules_fetch_pending_;
 
-  // True if callback from |SubmitDataUseReportCallback| is currently pending.
-  bool submit_data_report_pending_;
+  // Time when the currently pending data use report was submitted.
+  // |last_data_report_submitted_ticks_| is null if no data use report is
+  // currently pending.
+  base::TimeTicks last_data_report_submitted_ticks_;
+
+  // |pending_report_bytes_| is the total byte count in the data use report that
+  // is currently pending.
+  int64_t pending_report_bytes_;
 
   // Contains matching rules.
   std::vector<scoped_ptr<MatchingRule>> matching_rules_;
 
   // Buffered data reports that need to be submitted to the Java data use
   // observer.
   DataUseReports buffered_data_reports_;
 
   // True if |this| is currently registered as a data use observer.
   bool registered_as_observer_;
@@ skipping 16 matching lines @@
   // reports.
   int64_t total_bytes_buffered_;
 
   // Duration after which matching rules are periodically fetched.
   const base::TimeDelta fetch_matching_rules_duration_;
 
   // Minimum number of bytes that should be buffered before a data use report is
   // submitted.
   const int64_t data_use_report_min_bytes_;
 
+  // If a data use report is pending for more than |data_report_submit_timeout_|
+  // duration, it is considered as timed out.
+  const base::TimeDelta data_report_submit_timeout_;
+
   base::ThreadChecker thread_checker_;
 
   // |io_weak_factory_| and |ui_weak_factory_| are used for posting tasks on the
   // IO and UI thread, respectively.
   base::WeakPtrFactory<ExternalDataUseObserver> io_weak_factory_;
   base::WeakPtrFactory<ExternalDataUseObserver> ui_weak_factory_;
 
   DISALLOW_COPY_AND_ASSIGN(ExternalDataUseObserver);
 };
 
 bool RegisterExternalDataUseObserver(JNIEnv* env);
 
 }  // namespace android
 
 }  // namespace chrome
 
 #endif  // CHROME_BROWSER_ANDROID_DATA_USAGE_EXTERNAL_DATA_USE_OBSERVER_H_