Add UMA metrics for ICE regathering reasons.

webrtc/p2p/base/portallocator.h

 /*
  *  Copyright 2004 The WebRTC Project Authors. All rights reserved.
  *
  *  Use of this source code is governed by a BSD-style license
  *  that can be found in the LICENSE file in the root of the source
  *  tree. An additional intellectual property rights grant can be found
  *  in the file PATENTS.  All contributing project authors may
  *  be found in the AUTHORS file in the root of the source tree.
  */
 
 #ifndef WEBRTC_P2P_BASE_PORTALLOCATOR_H_
 #define WEBRTC_P2P_BASE_PORTALLOCATOR_H_
 
 #include <deque>
 #include <memory>
 #include <string>
 #include <vector>
 
 #include "webrtc/p2p/base/port.h"
 #include "webrtc/p2p/base/portinterface.h"
 #include "webrtc/base/helpers.h"
 #include "webrtc/base/proxyinfo.h"
 #include "webrtc/base/sigslot.h"
 #include "webrtc/base/thread.h"
 
+namespace webrtc {
+class MetricsObserverInterface;
+}
+
 namespace cricket {
 
 // PortAllocator is responsible for allocating Port types for a given
 // P2PSocket. It also handles port freeing.
 //
 // Clients can override this class to control port allocation, including
 // what kinds of ports are allocated.
 
 enum {
   // Disable local UDP ports. This doesn't impact how we connect to relay
@@ skipping 29 matching lines @@
   // high cost. So if both Wi-Fi and cellular networks exist, gather only on the
   // Wi-Fi network. If a network type is "unknown", it has a cost lower than
   // cellular but higher than Wi-Fi/Ethernet. So if an unknown network exists,
   // cellular networks will not be used to gather candidates and if a Wi-Fi
   // network is present, "unknown" networks will not be usd to gather
   // candidates. Doing so ensures that even if a cellular network type was not
   // detected initially, it would not be used if a Wi-Fi network is present.
   PORTALLOCATOR_DISABLE_COSTLY_NETWORKS = 0x2000,
 };
 
+// Defines various reasons that have caused ICE regathering.
+enum class IceRegatheringReason {
+  ICE_RESTART_WHEN_CONNECTED,
+  ICE_RESTART_WHEN_CONNECTING,
+  ICE_RESTART_WHEN_DISCONNECTED,

[pthatcher2, 2016/10/04 06:03:17]

Shouldn't these be "_WHILE_" rather than "_WHEN_"?

[honghaiz3, 2016/10/05 05:01:53]

renamed class and variables as suggested in other comments.

+  CONTINUAL_GATHERING_BY_NETWORK_CHANGE,
+  CONTINUAL_GATHERING_BY_NETWORK_FAILURE,

[pthatcher2, 2016/10/04 06:03:17]

Shouldn't these be "_FOR_" rather than "_BY_"?

[honghaiz3, 2016/10/05 05:01:53]

Renames this too. 

+  MAX_VALUE
+};
+
 const uint32_t kDefaultPortAllocatorFlags = 0;
 
 const uint32_t kDefaultStepDelay = 1000;  // 1 sec step delay.
 // As per RFC 5245 Appendix B.1, STUN transactions need to be paced at certain
 // internal. Less than 20ms is not acceptable. We choose 50ms as our default.
 const uint32_t kMinimumStepDelay = 50;
 
 // CF = CANDIDATE FILTER
 enum {
   CF_NONE = 0x0,
@@ skipping 124 matching lines @@
   sigslot::signal2<PortAllocatorSession*, const std::vector<PortInterface*>&>
       SignalPortsPruned;
   sigslot::signal2<PortAllocatorSession*,
                    const std::vector<Candidate>&> SignalCandidatesReady;
   // Candidates should be signaled to be removed when the port that generated
   // the candidates is removed.
   sigslot::signal2<PortAllocatorSession*, const std::vector<Candidate>&>
       SignalCandidatesRemoved;
   sigslot::signal1<PortAllocatorSession*> SignalCandidatesAllocationDone;
 
+  sigslot::signal1<IceRegatheringReason> SignalIceRegatheringReason;

[pthatcher2, 2016/10/04 06:03:17]

Would it make more sense to call this SignalIceRegathering?

[honghaiz3, 2016/10/05 05:01:53]

Done.

+
   virtual uint32_t generation() { return generation_; }
   virtual void set_generation(uint32_t generation) { generation_ = generation; }
   sigslot::signal1<PortAllocatorSession*> SignalDestroyed;
 
  protected:
   // This method is called when a pooled session (which doesn't have these
   // properties initially) is returned by PortAllocator::TakePooledSession,
   // and the content name, component, and ICE ufrag/pwd are updated.
   //
   // A subclass may need to override this method to perform additional actions,
@@ skipping 134 matching lines @@
   void set_candidate_filter(uint32_t filter) {
     candidate_filter_ = filter;
   }
 
   bool prune_turn_ports() const { return prune_turn_ports_; }
 
   // Gets/Sets the Origin value used for WebRTC STUN requests.
   const std::string& origin() const { return origin_; }
   void set_origin(const std::string& origin) { origin_ = origin; }
 
+  virtual void ReportIceRegatheringReason(IceRegatheringReason reason) {}
+
+  void set_metrics_observer(webrtc::MetricsObserverInterface* observer) {
+    metrics_observer_ = observer;
+  }
+
  protected:
   virtual PortAllocatorSession* CreateSessionInternal(
       const std::string& content_name,
       int component,
       const std::string& ice_ufrag,
       const std::string& ice_pwd) = 0;
 
+  webrtc::MetricsObserverInterface* metrics_observer() {
+    return metrics_observer_;
+  }
+
   uint32_t flags_;
   std::string agent_;
   rtc::ProxyInfo proxy_;
   int min_port_;
   int max_port_;
   uint32_t step_delay_;
   bool allow_tcp_listen_;
   uint32_t candidate_filter_;
   std::string origin_;
 
  private:
   ServerAddresses stun_servers_;
   std::vector<RelayServerConfig> turn_servers_;
   // The last size passed into SetConfiguration.
   int target_pooled_session_count_ = 0;
   // This variable represents the total number of pooled sessions
   // both owned by this class and taken by TakePooledSession.
   int allocated_pooled_session_count_ = 0;
   std::deque<std::unique_ptr<PortAllocatorSession>> pooled_sessions_;
   bool prune_turn_ports_ = false;
+
+  webrtc::MetricsObserverInterface* metrics_observer_ = nullptr;
 };
 
 }  // namespace cricket
 
 #endif  // WEBRTC_P2P_BASE_PORTALLOCATOR_H_