Log probe results to RtcEventLog.

webrtc/modules/congestion_controller/probe_bitrate_estimator.cc

 /*
  *  Copyright (c) 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/modules/congestion_controller/probe_bitrate_estimator.h"
 
 #include <algorithm>
 
 #include "webrtc/base/checks.h"
 #include "webrtc/base/logging.h"
+#include "webrtc/logging/rtc_event_log/rtc_event_log.h"
 
 namespace {
 // The minumum number of probes we need to receive feedback about in percent
 // in order to have a valid estimate.
 constexpr int kMinReceivedProbesPercent = 80;
 
 // The minumum number of bytes we need to receive feedback about in percent
 // in order to have a valid estimate.
 constexpr int kMinReceivedBytesPercent = 80;
 
 // The maximum (receive rate)/(send rate) ratio for a valid estimate.
 constexpr float kValidRatio = 2.0f;
 
 // The maximum time period over which the cluster history is retained.
 // This is also the maximum time period beyond which a probing burst is not
 // expected to last.
 constexpr int kMaxClusterHistoryMs = 1000;
 
 // The maximum time interval between first and the last probe on a cluster
 // on the sender side as well as the receive side.
 constexpr int kMaxProbeIntervalMs = 1000;
 }  // namespace
 
 namespace webrtc {
 
-ProbeBitrateEstimator::ProbeBitrateEstimator() {}
+ProbeBitrateEstimator::ProbeBitrateEstimator(RtcEventLog* event_log)
+    : event_log_(event_log) {}
 
 int ProbeBitrateEstimator::HandleProbeAndEstimateBitrate(
     const PacketFeedback& packet_feedback) {
   int cluster_id = packet_feedback.pacing_info.probe_cluster_id;
   RTC_DCHECK_NE(cluster_id, PacedPacketInfo::kNotAProbe);
 
   EraseOldClusters(packet_feedback.arrival_time_ms - kMaxClusterHistoryMs);
 
   int payload_size_bits = packet_feedback.payload_size * 8;
   AggregatedCluster* cluster = &clusters_[cluster_id];
@@ skipping 28 matching lines @@
   float send_interval_ms = cluster->last_send_ms - cluster->first_send_ms;
   float receive_interval_ms =
       cluster->last_receive_ms - cluster->first_receive_ms;
 
   if (send_interval_ms <= 0 || send_interval_ms > kMaxProbeIntervalMs ||
       receive_interval_ms <= 0 || receive_interval_ms > kMaxProbeIntervalMs) {
     LOG(LS_INFO) << "Probing unsuccessful, invalid send/receive interval"
                  << " [cluster id: " << cluster_id
                  << "] [send interval: " << send_interval_ms << " ms]"
                  << " [receive interval: " << receive_interval_ms << " ms]";
+    if (event_log_) {
+      event_log_->LogProbeResultFailure(cluster_id,
+                                        kInvalidSendReceiveInterval);
+    }
     return -1;
   }
   // Since the |send_interval_ms| does not include the time it takes to actually
   // send the last packet the size of the last sent packet should not be
   // included when calculating the send bitrate.
   RTC_DCHECK_GT(cluster->size_total, cluster->size_last_send);
   float send_size = cluster->size_total - cluster->size_last_send;
   float send_bps = send_size / send_interval_ms * 1000;
 
   // Since the |receive_interval_ms| does not include the time it takes to
   // actually receive the first packet the size of the first received packet
   // should not be included when calculating the receive bitrate.
   RTC_DCHECK_GT(cluster->size_total, cluster->size_first_receive);
   float receive_size = cluster->size_total - cluster->size_first_receive;
   float receive_bps = receive_size / receive_interval_ms * 1000;
 
   float ratio = receive_bps / send_bps;
   if (ratio > kValidRatio) {
     LOG(LS_INFO) << "Probing unsuccessful, receive/send ratio too high"
                  << " [cluster id: " << cluster_id << "] [send: " << send_size
                  << " bytes / " << send_interval_ms
                  << " ms = " << send_bps / 1000 << " kb/s]"
                  << " [receive: " << receive_size << " bytes / "
                  << receive_interval_ms << " ms = " << receive_bps / 1000
                  << " kb/s]"
                  << " [ratio: " << receive_bps / 1000 << " / "
                  << send_bps / 1000 << " = " << ratio << " > kValidRatio ("
                  << kValidRatio << ")]";
+    if (event_log_)
+      event_log_->LogProbeResultFailure(cluster_id, kInvalidSendReceiveRatio);
     return -1;
   }
   LOG(LS_INFO) << "Probing successful"
                << " [cluster id: " << cluster_id << "] [send: " << send_size
                << " bytes / " << send_interval_ms << " ms = " << send_bps / 1000
                << " kb/s]"
                << " [receive: " << receive_size << " bytes / "
                << receive_interval_ms << " ms = " << receive_bps / 1000
                << " kb/s]";
-  return std::min(send_bps, receive_bps);
+  float res = std::min(send_bps, receive_bps);
+  if (event_log_)
+    event_log_->LogProbeResultSuccess(cluster_id, res);
+  return res;
 }
 
 void ProbeBitrateEstimator::EraseOldClusters(int64_t timestamp_ms) {
   for (auto it = clusters_.begin(); it != clusters_.end();) {
     if (it->second.last_receive_ms < timestamp_ms) {
       it = clusters_.erase(it);
     } else {
       ++it;
     }
   }
 }
 }  // namespace webrtc