Add network quality change events to net log

net/nqe/network_quality_estimator.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 NET_NQE_NETWORK_QUALITY_ESTIMATOR_H_
 #define NET_NQE_NETWORK_QUALITY_ESTIMATOR_H_
 
 #include <stdint.h>
 
 #include <map>
 #include <memory>
 #include <string>
 
 #include "base/compiler_specific.h"
 #include "base/gtest_prod_util.h"
 #include "base/macros.h"
 #include "base/memory/ref_counted.h"
 #include "base/memory/weak_ptr.h"
 #include "base/observer_list.h"
 #include "base/threading/thread_checker.h"
 #include "base/time/time.h"
 #include "net/base/net_export.h"
 #include "net/base/network_change_notifier.h"
+#include "net/log/net_log_with_source.h"
 #include "net/nqe/cached_network_quality.h"
 #include "net/nqe/effective_connection_type.h"
 #include "net/nqe/external_estimate_provider.h"
 #include "net/nqe/network_id.h"
 #include "net/nqe/network_quality.h"
 #include "net/nqe/network_quality_observation.h"
 #include "net/nqe/network_quality_observation_source.h"
 #include "net/nqe/network_quality_store.h"
 #include "net/nqe/observation_buffer.h"
 #include "net/socket/socket_performance_watcher_factory.h"
 
 namespace base {
 class TickClock;
 }  // namespace base
 
 namespace net {
 
+class NetLog;
+
 namespace nqe {
 namespace internal {
 class ThroughputAnalyzer;
 }
 }
 
 class URLRequest;
 
 // NetworkQualityEstimator provides network quality estimates (quality of the
 // full paths to all origins that have been connected to).
@@ skipping 118 matching lines @@
    protected:
     NetworkQualityProvider() {}
 
    private:
     DISALLOW_COPY_AND_ASSIGN(NetworkQualityProvider);
   };
 
   // Creates a new NetworkQualityEstimator.
   // |variation_params| is the map containing all field trial parameters
   // related to NetworkQualityEstimator field trial.
-  // |external_estimates_provider| may be NULL.
+  // |external_estimates_provider| may be NULL. |net_log| is guaranteed to be

[RyanSturm, 2017/01/10 16:22:37]

Can you rephrase this to something like "The embedder guarantees that |net_log|
is non-null"

[tbansal1, 2017/01/10 18:27:53]

Done.

+  // non-null.
   NetworkQualityEstimator(
       std::unique_ptr<ExternalEstimateProvider> external_estimates_provider,
-      const std::map<std::string, std::string>& variation_params);
+      const std::map<std::string, std::string>& variation_params,
+      NetLog* net_log);
 
   // Construct a NetworkQualityEstimator instance allowing for test
   // configuration. Registers for network type change notifications so estimates
   // can be kept network specific.
   // |external_estimates_provider| may be NULL.
   // |variation_params| is the map containing all field trial parameters for the
   // network quality estimator field trial.
   // |use_local_host_requests_for_tests| should only be true when testing
   // against local HTTP server and allows the requests to local host to be
   // used for network quality estimation.
   // |use_smaller_responses_for_tests| should only be true when testing.
   // Allows the responses smaller than |kMinTransferSizeInBits| to be used for
-  // network quality estimation.
+  // network quality estimation. |net_log| is guaranteed to be non-null.

[RyanSturm, 2017/01/10 16:22:37]

same as above comment

[tbansal1, 2017/01/10 18:27:53]

Done.

   NetworkQualityEstimator(
       std::unique_ptr<ExternalEstimateProvider> external_estimates_provider,
       const std::map<std::string, std::string>& variation_params,
       bool use_local_host_requests_for_tests,
-      bool use_smaller_responses_for_tests);
+      bool use_smaller_responses_for_tests,
+      NetLog* net_log);
 
   ~NetworkQualityEstimator() override;
 
   // Returns the last computed effective type of the current connection. The
   // effective connection type is computed by the network quality estimator at
   // regular intervals and at certain events (e.g., connection change).
   // Virtualized for testing.
   virtual EffectiveConnectionType GetEffectiveConnectionType() const;
 
   // Returns the effective type of the current connection based on only the
@@ skipping 87 matching lines @@
                      nqe::internal::CachedNetworkQuality> read_prefs);
 
  protected:
   // A protected constructor for testing that allows setting the value of
   // |add_default_platform_observations_|.
   NetworkQualityEstimator(
       std::unique_ptr<ExternalEstimateProvider> external_estimates_provider,
       const std::map<std::string, std::string>& variation_params,
       bool use_local_host_requests_for_tests,
       bool use_smaller_responses_for_tests,
-      bool add_default_platform_observations);
+      bool add_default_platform_observations,
+      const NetLogWithSource& net_log);
 
   // NetworkChangeNotifier::ConnectionTypeObserver implementation:
   void OnConnectionTypeChanged(
       NetworkChangeNotifier::ConnectionType type) override;
 
   // ExternalEstimateProvider::UpdatedEstimateObserver implementation.
   void OnUpdatedEstimateAvailable(const base::TimeDelta& rtt,
                                   int32_t downstream_throughput_kbps,
                                   int32_t upstream_throughput_kbps) override;
 
@@ skipping 179 matching lines @@
   void NotifyObserversOfThroughput(const ThroughputObservation& observation);
 
   // Returns true only if the |request| can be used for RTT estimation.
   bool RequestProvidesRTTObservation(const URLRequest& request) const;
 
   // Recomputes effective connection type, if it was computed more than the
   // specified duration ago, or if there has been a connection change recently.
   void MaybeComputeEffectiveConnectionType();
 
   // Notifies observers of a change in effective connection type.
-  void NotifyObserversOfEffectiveConnectionTypeChanged();
+  // |http_rtt| is the estimate of the HTTP RTT. |transport_rtt| is the estimate
+  // of the transport RTT. |downstream_throughput_kbps| is the estimate of the

[RyanSturm, 2017/01/10 16:22:37]

units for the RTTs (msec)

[tbansal1, 2017/01/10 18:27:53]

RTTs are in base::TimeDelta. So, units are not required.

+  // downstream throughput (in kilobits per second).
+  void NotifyObserversOfEffectiveConnectionTypeChanged(
+      base::TimeDelta http_rtt,
+      base::TimeDelta transport_rtt,
+      int32_t downstream_throughput_kbps);
 
   // Notifies the observers of RTT or throughput estimates computation.
   void NotifyObserversOfRTTOrThroughputComputed() const;
 
   // Notifies |observer| of the current effective connection type if |observer|
   // is still registered as an observer.
   void NotifyEffectiveConnectionTypeObserverIfPresent(
       EffectiveConnectionTypeObserver* observer) const;
 
   // Notifies |observer| of the current RTT and throughput if |observer| is
@@ skipping 215 matching lines @@
   std::unique_ptr<nqe::internal::NetworkQualityStore> network_quality_store_;
 
   // True if effective connection type value has been forced via variation
   // parameters. If set to true, GetEffectiveConnectionType() will always return
   // |forced_effective_connection_type_|.
   const bool forced_effective_connection_type_set_;
   const EffectiveConnectionType forced_effective_connection_type_;
 
   base::ThreadChecker thread_checker_;
 
+  NetLogWithSource net_log_;
+
   base::WeakPtrFactory<NetworkQualityEstimator> weak_ptr_factory_;
 
   DISALLOW_COPY_AND_ASSIGN(NetworkQualityEstimator);
 };
 
 }  // namespace net
 
 #endif  // NET_NQE_NETWORK_QUALITY_ESTIMATOR_H_