Bypassed Bytes UMAs

components/data_reduction_proxy/browser/data_reduction_proxy_usage_stats.h

 // 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.
 
 #ifndef COMPONENTS_DATA_REDUCTION_PROXY_BROWSER_DATA_REDUCTION_PROXY_USAGE_STATS_H_
 #define COMPONENTS_DATA_REDUCTION_PROXY_BROWSER_DATA_REDUCTION_PROXY_USAGE_STATS_H_
 
 #include "base/message_loop/message_loop_proxy.h"
+#include "base/prefs/pref_member.h"
 #include "base/threading/thread_checker.h"
 #include "components/data_reduction_proxy/browser/data_reduction_proxy_params.h"
 #include "net/base/host_port_pair.h"
 #include "net/base/network_change_notifier.h"
+#include "net/proxy/proxy_service.h"
+#include "net/url_request/url_request.h"
 
 namespace data_reduction_proxy {
 
 class DataReductionProxyUsageStats
     : public net::NetworkChangeNotifier::NetworkChangeObserver {
  public:
   // MessageLoopProxy instances are owned by io_thread. |params| outlives
   // this class instance.
   DataReductionProxyUsageStats(DataReductionProxyParams* params,
                                base::MessageLoopProxy* ui_thread_proxy,
                                base::MessageLoopProxy* io_thread_proxy);
   virtual ~DataReductionProxyUsageStats();
 
-  /**
-   * Callback intended to be called from |ChromeNetworkDelegate| when a
-   * request completes. This method is used to gather usage stats.
-   */
+  // Callback intended to be called from |ChromeNetworkDelegate| when a
+  // request completes. This method is used to gather usage stats.
   void OnUrlRequestCompleted(const net::URLRequest* request, bool started);
 
-  /**
-   * Determines whether the data reduction proxy is unreachable.
-   * Returns true if data reduction proxy is unreachable.
-   */
+  // Determines whether the data reduction proxy is unreachable.
+  // Returns true if data reduction proxy is unreachable.
   bool isDataReductionProxyUnreachable();
 
+  // Records the last bypass reason to |bypass_type_| and sets
+  // |triggering_request_| to true.

[bengr, 2014/07/21 22:23:58]

Say what it means to be the triggering request.

[megjablon, 2014/07/22 02:11:30]

Done.

+  void SetBypassType(net::ProxyService::DataReductionProxyBypassType type);
+
+  // Records the number of bypassed bytes for various bypass reasons into their
+  // respective UMAs.

[bengr, 2014/07/21 22:23:58]

Describe the parameters.

[megjablon, 2014/07/22 02:11:31]

Done.

+  void RecordBypassedBytesHistograms(
+      int64 content_length,
+      const net::URLRequest& request,
+      const BooleanPrefMember& data_reduction_proxy_enabled);
+
  private:
+  enum BypassedBytesType {
+    // Not bypassed.
+    NOT_BYPASSED = 0,

[bengr, 2014/07/21 22:23:58]

Can you condense? E.g.:

enum BypassedBytesType {
  NOT_BYPASSED = 0,  /* Not bypassed. */
  SSL = 1, /* Bypass due to SSL. */
  ...

You can line up the comments if you'd like.

[megjablon, 2014/07/22 02:11:31]

Done.

+
+    // Bypass due to SSL.
+    SSL = 1,
+
+    // Bypass due to client-side bypass rules.
+    LOCAL_BYPASS_RULES = 2,
+
+    // Audio/Video bypass.
+    AUDIO_VIDEO = 3,
+
+    // Triggering request bypass.
+    TRIGGERING_REQUEST = 4,
+
+    // Network error.
+    NETWORK_ERROR = 5,
+
+    // This must always be last.
+    BYPASSED_BYTES_TYPE_MAX = 6
+  };
+
   DataReductionProxyParams* data_reduction_proxy_params_;
+  net::ProxyService::DataReductionProxyBypassType bypass_type_;

[bengr, 2014/07/21 22:23:58]

is the the last_bypass_type_? If so, rename. Add a comment.

[megjablon, 2014/07/22 02:11:31]

Done.

+  bool triggering_request_;

[bengr, 2014/07/21 22:23:58]

Comment.

[megjablon, 2014/07/22 02:11:30]

Done.

   base::MessageLoopProxy* ui_thread_proxy_;
   base::MessageLoopProxy* io_thread_proxy_;
 
   // The following 2 fields are used to determine if data reduction proxy is
   // unreachable. We keep a count of requests which should go through
   // data request proxy, as well as those which actually do. The proxy is
   // unreachable if no successful requests are made through it despite a
   // non-zero number of requests being eligible.
 
   // Count of requests which will be tried to be sent through data reduction
   // proxy. The count is only based on the config and not the bad proxy list.
   // Explicit bypasses are not part of this count. This is the desired behavior
   // since otherwise both counts would be identical.
   unsigned long eligible_num_requests_through_proxy_;
   // Count of successfull requests through data reduction proxy.
   unsigned long actual_num_requests_through_proxy_;
 
   // NetworkChangeNotifier::NetworkChangeObserver:
   virtual void OnNetworkChanged(
       net::NetworkChangeNotifier::ConnectionType type) OVERRIDE;
 
   void IncRequestCountsOnUiThread(bool actual);
   void ClearRequestCountsOnUiThread();
 
   base::ThreadChecker thread_checker_;
 
+  void RecordBypassedBytes(
+      net::ProxyService::DataReductionProxyBypassType bypass_type,
+      BypassedBytesType bypassed_bytes_type,
+      int64 content_length);
+
   DISALLOW_COPY_AND_ASSIGN(DataReductionProxyUsageStats);
 };
 
 }  // namespace data_reduction_proxy
 
 #endif  // COMPONENTS_DATA_REDUCTION_PROXY_BROWSER_DATA_REDUCTION_PROXY_USAGE_STATS_H_