Trace stats in RTCStatsCollector.

webrtc/pc/rtcstatscollector.cc

 /*
  *  Copyright 2016 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.
  */
 
 #include "webrtc/pc/rtcstatscollector.h"
 
 #include <memory>
 #include <sstream>
 #include <utility>
 #include <vector>
 
 #include "webrtc/api/mediastreaminterface.h"
 #include "webrtc/api/peerconnectioninterface.h"
 #include "webrtc/media/base/mediachannel.h"
 #include "webrtc/p2p/base/candidate.h"
 #include "webrtc/p2p/base/p2pconstants.h"
 #include "webrtc/p2p/base/port.h"
 #include "webrtc/pc/peerconnection.h"
 #include "webrtc/pc/webrtcsession.h"
 #include "webrtc/rtc_base/checks.h"
+#include "webrtc/rtc_base/stringutils.h"
 #include "webrtc/rtc_base/timeutils.h"
+#include "webrtc/rtc_base/trace_event.h"
 
 namespace webrtc {
 
 namespace {
 
+const int kStatTypeMemberNameAndIdMaxLen = 120;

[ehmaldonado_webrtc, 2017/07/13 09:40:42]

Henrik, do you think 120 chars will be enough?

[hbos, 2017/07/18 08:55:08]

Yes. In the very unlikely case that it won't be in the future we'll notice
thanks to the DCHECK.

[hbos, 2017/07/18 10:09:48]

Oh sorry, I forgot about the length of the ID, and while typically short the
RTCCertificate IDs are a special case where it's really long! We should make the
buffer longer. I suspect the DCHECK will fail on rtcstats_integrationtest.cc.

Example string for certificates:

certificate.fingerprintAlgorithm.FE:C9:98:64:F3:3C:3E:A2:1A:ED:00:2D:17:18:6A:F2:2D:27:E5:BC:89:DE:67:11:83:B6:D6:5D:40:5E:FB:A3

That's 128 characters long! Let's go ahead and make
kStatTypeMemberNameAndIdMaxLen = 512 for plenty of margin (which is fine since
it's on the stack).

[hbos, 2017/07/18 10:11:58]

Or rather
"certificate.fingerprintAlgorithm.RTCCertificate_FE:C9:98:64:F3:3C:3E:A2:1A:ED:00:2D:17:18:6A:F2:2D:27:E5:BC:89:DE:67:11:83:B6:D6:5D:40:5E:FB:A3",
even longer. (And yeah, ':' can't be separator either.)

+
+std::string GetStatTypeMemberNameAndId(const RTCStats& stats,
+                                       const RTCStatsMemberInterface* member) {
+  RTC_DCHECK(strlen(stats.type()) + strlen(member->name())
+             + stats.id().size() + 3 < kStatTypeMemberNameAndIdMaxLen);
+  char buffer[kStatTypeMemberNameAndIdMaxLen];
+  rtc::sprintfn(&buffer[0], sizeof(buffer), "%s.%s.%s", stats.type(),
+                member->name(), stats.id().c_str());
+  return buffer;
+}
+
 std::string RTCCertificateIDFromFingerprint(const std::string& fingerprint) {
   return "RTCCertificate_" + fingerprint;
 }
 
 std::string RTCCodecStatsIDFromDirectionMediaAndPayload(
     bool inbound, bool audio, uint32_t payload_type) {
   // TODO(hbos): The present codec ID assignment is not sufficient to support
   // Unified Plan or unbundled connections in all cases. When we are able to
   // handle multiple m= lines of the same media type (and multiple BaseChannels
   // for the same type is possible?) this needs to be updated to differentiate
@@ skipping 701 matching lines @@
   else
     partial_report_->TakeMembersFrom(partial_report);
   --num_pending_partial_reports_;
   if (!num_pending_partial_reports_) {
     cache_timestamp_us_ = partial_report_timestamp_us_;
     cached_report_ = partial_report_;
     partial_report_ = nullptr;
     channel_name_pairs_.reset();
     track_media_info_map_.reset();
     track_to_id_.clear();
+    // Trace WebRTC Stats when getStats is called on Javascript.
+    // This allows access to WebRTC stats from trace logs. To enable them,
+    // select the "webrtc_stats" category when recording traces.
+    for (const RTCStats& stats : *cached_report_) {
+      for (const RTCStatsMemberInterface* member : stats.Members()) {
+        if (member->is_defined()) {
+          TRACE_EVENT_INSTANT2("webrtc_stats", "webrtc_stats",
+                               "value", member->ValueToString(),
+                               "type+name+id", GetStatTypeMemberNameAndId(

[hbos, 2017/07/18 08:55:08]

nit: How about "type.name.id" to match the format of GetStatTypeMemberNameAndId?
Or if the '.' has special meaning somewhere we could use a different separator
like ' '. type, name and ids so far only use A-Z, a-z, _, -, 0-9, anything else
could be a separator.

+                                   stats, member));
+        }
+      }
+    }
     DeliverCachedReport();
   }
 }
 
 void RTCStatsCollector::DeliverCachedReport() {
   RTC_DCHECK(signaling_thread_->IsCurrent());
   RTC_DCHECK(!callbacks_.empty());
   RTC_DCHECK(cached_report_);
   for (const rtc::scoped_refptr<RTCStatsCollectorCallback>& callback :
        callbacks_) {
@@ skipping 484 matching lines @@
     const std::string& type) {
   return CandidateTypeToRTCIceCandidateType(type);
 }
 
 const char* DataStateToRTCDataChannelStateForTesting(
     DataChannelInterface::DataState state) {
   return DataStateToRTCDataChannelState(state);
 }
 
 }  // namespace webrtc