Add macros for ability to log samples that are added to histograms (RTC_LOGGED_*).

webrtc/system_wrappers/include/metrics.h

 //
 // Copyright (c) 2014 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_SYSTEM_WRAPPERS_INCLUDE_METRICS_H_
 #define WEBRTC_SYSTEM_WRAPPERS_INCLUDE_METRICS_H_
 
 #include <string>
 
 #include "webrtc/base/atomicops.h"
 #include "webrtc/base/checks.h"
 #include "webrtc/common_types.h"
+#include "webrtc/system_wrappers/include/logging.h"

[stefan-webrtc, 2016/03/15 10:14:10]

Should we use webrtc/base/logging.h?

[åsapersson, 2016/03/15 12:46:23]

Done.

 
 // Macros for allowing WebRTC clients (e.g. Chrome) to gather and aggregate
 // statistics.
 //
 // Histogram for counters.
 // RTC_HISTOGRAM_COUNTS(name, sample, min, max, bucket_count);
 //
 // Histogram for enumerators.
 // The boundary should be above the max enumerator sample.
 // RTC_HISTOGRAM_ENUMERATION(name, sample, boundary);
@@ skipping 42 matching lines @@
 #define RTC_HISTOGRAM_COUNTS_1000(name, sample) \
   RTC_HISTOGRAM_COUNTS(name, sample, 1, 1000, 50)
 
 #define RTC_HISTOGRAM_COUNTS_10000(name, sample) \
   RTC_HISTOGRAM_COUNTS(name, sample, 1, 10000, 50)
 
 #define RTC_HISTOGRAM_COUNTS_100000(name, sample) \
   RTC_HISTOGRAM_COUNTS(name, sample, 1, 100000, 50)
 
 #define RTC_HISTOGRAM_COUNTS(name, sample, min, max, bucket_count) \
-  RTC_HISTOGRAM_COMMON_BLOCK(name, sample, \
+  RTC_HISTOGRAM_COMMON_BLOCK(name, sample, false, \
+      webrtc::metrics::HistogramFactoryGetCounts(name, min, max, bucket_count))
+
+// RTC_HISTOGRAM_COUNTS with logging.
+#define RTC_LHISTOGRAM_COUNTS_100(name, sample) \
+  RTC_LHISTOGRAM_COUNTS(name, sample, 1, 100, 50)
+
+#define RTC_LHISTOGRAM_COUNTS_200(name, sample) \
+  RTC_LHISTOGRAM_COUNTS(name, sample, 1, 200, 50)
+
+#define RTC_LHISTOGRAM_COUNTS_1000(name, sample) \
+  RTC_LHISTOGRAM_COUNTS(name, sample, 1, 1000, 50)
+
+#define RTC_LHISTOGRAM_COUNTS_10000(name, sample) \
+  RTC_LHISTOGRAM_COUNTS(name, sample, 1, 10000, 50)
+
+#define RTC_LHISTOGRAM_COUNTS_100000(name, sample) \
+  RTC_LHISTOGRAM_COUNTS(name, sample, 1, 100000, 50)
+
+#define RTC_LHISTOGRAM_COUNTS(name, sample, min, max, bucket_count) \
+  RTC_HISTOGRAM_COMMON_BLOCK(name, sample, true, \
       webrtc::metrics::HistogramFactoryGetCounts(name, min, max, bucket_count))
 
 // Deprecated.
 // TODO(asapersson): Remove.
 #define RTC_HISTOGRAM_COUNTS_SPARSE_100(name, sample) \
   RTC_HISTOGRAM_COUNTS_SPARSE(name, sample, 1, 100, 50)
 
 #define RTC_HISTOGRAM_COUNTS_SPARSE(name, sample, min, max, bucket_count) \
   RTC_HISTOGRAM_COMMON_BLOCK_SLOW(name, sample, \
       webrtc::metrics::HistogramFactoryGetCounts(name, min, max, bucket_count))
 
 // Histogram for percentage (evenly spaced buckets).
 #define RTC_HISTOGRAM_PERCENTAGE(name, sample) \
   RTC_HISTOGRAM_ENUMERATION(name, sample, 101)
 
+// RTC_HISTOGRAM_PERCENTAGE with logging.
+#define RTC_LHISTOGRAM_PERCENTAGE(name, sample) \
+  RTC_LHISTOGRAM_ENUMERATION(name, sample, 101)
+
 // Histogram for enumerators (evenly spaced buckets).
 // |boundary| should be above the max enumerator sample.
 #define RTC_HISTOGRAM_ENUMERATION(name, sample, boundary) \
-  RTC_HISTOGRAM_COMMON_BLOCK(name, sample, \
+  RTC_HISTOGRAM_COMMON_BLOCK(name, sample, false, \
+      webrtc::metrics::HistogramFactoryGetEnumeration(name, boundary))
+
+// RTC_HISTOGRAM_ENUMERATION with logging.
+#define RTC_LHISTOGRAM_ENUMERATION(name, sample, boundary) \
+  RTC_HISTOGRAM_COMMON_BLOCK(name, sample, true, \
       webrtc::metrics::HistogramFactoryGetEnumeration(name, boundary))
 
 // The name of the histogram should not vary.
 // TODO(asapersson): Consider changing string to const char*.
-#define RTC_HISTOGRAM_COMMON_BLOCK(constant_name, sample, \
+#define RTC_HISTOGRAM_COMMON_BLOCK(constant_name, sample, log, \
                                    factory_get_invocation) \
   do { \
+    if (log) { \
+      LOG(LS_INFO) << constant_name << " " << sample; \
+    } \
     static webrtc::metrics::Histogram* atomic_histogram_pointer = nullptr; \
     webrtc::metrics::Histogram* histogram_pointer = \
         rtc::AtomicOps::AcquireLoadPtr(&atomic_histogram_pointer); \
     if (!histogram_pointer) { \
       histogram_pointer = factory_get_invocation; \
       webrtc::metrics::Histogram* prev_pointer = \
           rtc::AtomicOps::CompareAndSwapPtr( \
               &atomic_histogram_pointer, \
               static_cast<webrtc::metrics::Histogram*>(nullptr), \
               histogram_pointer); \
@@ skipping 37 matching lines @@
       RTC_HISTOGRAM_COUNTS(name, sample, 1, 100000, 50))
 
 #define RTC_HISTOGRAMS_ENUMERATION(index, name, sample, boundary) \
   RTC_HISTOGRAMS_COMMON(index, name, sample, \
       RTC_HISTOGRAM_ENUMERATION(name, sample, boundary))
 
 #define RTC_HISTOGRAMS_PERCENTAGE(index, name, sample) \
   RTC_HISTOGRAMS_COMMON(index, name, sample, \
       RTC_HISTOGRAM_PERCENTAGE(name, sample))
 
+// RTC_HISTOGRAMS_COUNTS with logging.
+#define RTC_LHISTOGRAMS_COUNTS_100(index, name, sample) \
+  RTC_HISTOGRAMS_COMMON(index, name, sample, \
+      RTC_LHISTOGRAM_COUNTS(name, sample, 1, 100, 50))
+
+#define RTC_LHISTOGRAMS_COUNTS_200(index, name, sample) \
+  RTC_HISTOGRAMS_COMMON(index, name, sample, \
+      RTC_LHISTOGRAM_COUNTS(name, sample, 1, 200, 50))
+
+#define RTC_LHISTOGRAMS_COUNTS_1000(index, name, sample) \
+  RTC_HISTOGRAMS_COMMON(index, name, sample, \
+      RTC_LHISTOGRAM_COUNTS(name, sample, 1, 1000, 50))
+
+#define RTC_LHISTOGRAMS_COUNTS_10000(index, name, sample) \
+  RTC_HISTOGRAMS_COMMON(index, name, sample, \
+      RTC_LHISTOGRAM_COUNTS(name, sample, 1, 10000, 50))
+
+#define RTC_LHISTOGRAMS_COUNTS_100000(index, name, sample) \
+  RTC_HISTOGRAMS_COMMON(index, name, sample, \
+      RTC_LHISTOGRAM_COUNTS(name, sample, 1, 100000, 50))
+
+#define RTC_LHISTOGRAMS_ENUMERATION(index, name, sample, boundary) \
+  RTC_HISTOGRAMS_COMMON(index, name, sample, \
+      RTC_LHISTOGRAM_ENUMERATION(name, sample, boundary))
+
+#define RTC_LHISTOGRAMS_PERCENTAGE(index, name, sample) \
+  RTC_HISTOGRAMS_COMMON(index, name, sample, \
+      RTC_LHISTOGRAM_PERCENTAGE(name, sample))
+
 #define RTC_HISTOGRAMS_COMMON(index, name, sample, macro_invocation) \
   do { \
     switch (index) { \
       case 0: \
         macro_invocation; \
         break; \
       case 1: \
         macro_invocation; \
         break; \
       case 2: \
@@ skipping 28 matching lines @@
 // Function for adding a |sample| to a histogram.
 // |name| can be used to verify that it matches the histogram name.
 void HistogramAdd(
     Histogram* histogram_pointer, const std::string& name, int sample);
 
 }  // namespace metrics
 }  // namespace webrtc
 
 #endif  // WEBRTC_SYSTEM_WRAPPERS_INCLUDE_METRICS_H_