// // 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 SYSTEM_WRAPPERS_INCLUDE_METRICS_H_ #define SYSTEM_WRAPPERS_INCLUDE_METRICS_H_ #include <stddef.h> #include <atomic> #include <map> #include <memory> #include <string> #include "absl/strings/string_view.h" #include "rtc_base/checks.h" #include "rtc_base/string_utils.h" #if defined(RTC_DISABLE_METRICS) #define RTC_METRICS_ENABLED … #else #define RTC_METRICS_ENABLED … #endif namespace webrtc { namespace metrics_impl { template <typename... Ts> void NoOp(const Ts&...) { … } } // namespace metrics_impl } // namespace webrtc #if RTC_METRICS_ENABLED #define EXPECT_METRIC_EQ(val1, val2) … #define EXPECT_METRIC_EQ_WAIT(val1, val2, timeout) … #define EXPECT_METRIC_GT(val1, val2) … #define EXPECT_METRIC_LE(val1, val2) … #define EXPECT_METRIC_TRUE(conditon) … #define EXPECT_METRIC_FALSE(conditon) … #define EXPECT_METRIC_THAT(value, matcher) … #else #define EXPECT_METRIC_EQ … #define EXPECT_METRIC_EQ_WAIT … #define EXPECT_METRIC_GT … #define EXPECT_METRIC_LE … #define EXPECT_METRIC_TRUE … #define EXPECT_METRIC_FALSE … #define EXPECT_METRIC_THAT … #endif #if RTC_METRICS_ENABLED // 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); // // // The macros use the methods HistogramFactoryGetCounts, // HistogramFactoryGetEnumeration and HistogramAdd. // // By default WebRTC provides implementations of the aforementioned methods // that can be found in system_wrappers/source/metrics.cc. If clients want to // provide a custom version, they will have to: // // 1. Compile WebRTC defining the preprocessor macro // WEBRTC_EXCLUDE_METRICS_DEFAULT (if GN is used this can be achieved // by setting the GN arg rtc_exclude_metrics_default to true). // 2. Provide implementations of: // Histogram* webrtc::metrics::HistogramFactoryGetCounts( // absl::string_view name, int sample, int min, int max, // int bucket_count); // Histogram* webrtc::metrics::HistogramFactoryGetEnumeration( // absl::string_view name, int sample, int boundary); // void webrtc::metrics::HistogramAdd( // Histogram* histogram_pointer, absl::string_view name, int sample); // // Example usage: // // RTC_HISTOGRAM_COUNTS("WebRTC.Video.NacksSent", nacks_sent, 1, 100000, 100); // // enum Types { // kTypeX, // kTypeY, // kBoundary, // }; // // RTC_HISTOGRAM_ENUMERATION("WebRTC.Types", kTypeX, kBoundary); // // NOTE: It is recommended to do the Chromium review for modifications to // histograms.xml before new metrics are committed to WebRTC. // Macros for adding samples to a named histogram. // Histogram for counters (exponentially spaced buckets). #define RTC_HISTOGRAM_COUNTS_100(name, sample) … #define RTC_HISTOGRAM_COUNTS_200(name, sample) … #define RTC_HISTOGRAM_COUNTS_500(name, sample) … #define RTC_HISTOGRAM_COUNTS_1000(name, sample) … #define RTC_HISTOGRAM_COUNTS_10000(name, sample) … #define RTC_HISTOGRAM_COUNTS_100000(name, sample) … #define RTC_HISTOGRAM_COUNTS(name, sample, min, max, bucket_count) … #define RTC_HISTOGRAM_COUNTS_LINEAR(name, sample, min, max, bucket_count) … // Slow metrics: pointer to metric is acquired at each call and is not cached. // #define RTC_HISTOGRAM_COUNTS_SPARSE_100(name, sample) … #define RTC_HISTOGRAM_COUNTS_SPARSE_200(name, sample) … #define RTC_HISTOGRAM_COUNTS_SPARSE_500(name, sample) … #define RTC_HISTOGRAM_COUNTS_SPARSE_1000(name, sample) … #define RTC_HISTOGRAM_COUNTS_SPARSE_10000(name, sample) … #define RTC_HISTOGRAM_COUNTS_SPARSE_100000(name, sample) … #define RTC_HISTOGRAM_COUNTS_SPARSE(name, sample, min, max, bucket_count) … // Histogram for percentage (evenly spaced buckets). #define RTC_HISTOGRAM_PERCENTAGE_SPARSE(name, sample) … // Histogram for booleans. #define RTC_HISTOGRAM_BOOLEAN_SPARSE(name, sample) … // Histogram for enumerators (evenly spaced buckets). // `boundary` should be above the max enumerator sample. // // TODO(qingsi): Refactor the default implementation given by RtcHistogram, // which is already sparse, and remove the boundary argument from the macro. #define RTC_HISTOGRAM_ENUMERATION_SPARSE(name, sample, boundary) … // Histogram for percentage (evenly spaced buckets). #define RTC_HISTOGRAM_PERCENTAGE(name, sample) … // Histogram for booleans. #define RTC_HISTOGRAM_BOOLEAN(name, sample) … // Histogram for enumerators (evenly spaced buckets). // `boundary` should be above the max enumerator sample. #define RTC_HISTOGRAM_ENUMERATION(name, sample, boundary) … // The name of the histogram should not vary. #define RTC_HISTOGRAM_COMMON_BLOCK(constant_name, sample, \ factory_get_invocation) … // The histogram is constructed/found for each call. // May be used for histograms with infrequent updates.` #define RTC_HISTOGRAM_COMMON_BLOCK_SLOW(name, sample, factory_get_invocation) … // Helper macros. // Macros for calling a histogram with varying name (e.g. when using a metric // in different modes such as real-time vs screenshare). Fast, because pointer // is cached. `index` should be different for different names. Allowed `index` // values are 0, 1, and 2. #define RTC_HISTOGRAMS_COUNTS_100(index, name, sample) … #define RTC_HISTOGRAMS_COUNTS_200(index, name, sample) … #define RTC_HISTOGRAMS_COUNTS_500(index, name, sample) … #define RTC_HISTOGRAMS_COUNTS_1000(index, name, sample) … #define RTC_HISTOGRAMS_COUNTS_10000(index, name, sample) … #define RTC_HISTOGRAMS_COUNTS_100000(index, name, sample) … #define RTC_HISTOGRAMS_ENUMERATION(index, name, sample, boundary) … #define RTC_HISTOGRAMS_PERCENTAGE(index, name, sample) … #define RTC_HISTOGRAMS_COMMON(index, name, sample, macro_invocation) … #else //////////////////////////////////////////////////////////////////////////////// // This section defines no-op alternatives to the metrics macros when // RTC_METRICS_ENABLED is defined. #define RTC_HISTOGRAM_COUNTS_100 … #define RTC_HISTOGRAM_COUNTS_200 … #define RTC_HISTOGRAM_COUNTS_500 … #define RTC_HISTOGRAM_COUNTS_1000 … #define RTC_HISTOGRAM_COUNTS_10000 … #define RTC_HISTOGRAM_COUNTS_100000 … #define RTC_HISTOGRAM_COUNTS … #define RTC_HISTOGRAM_COUNTS_LINEAR … #define RTC_HISTOGRAM_COUNTS_SPARSE_100 … #define RTC_HISTOGRAM_COUNTS_SPARSE_200 … #define RTC_HISTOGRAM_COUNTS_SPARSE_500 … #define RTC_HISTOGRAM_COUNTS_SPARSE_1000 … #define RTC_HISTOGRAM_COUNTS_SPARSE_10000 … #define RTC_HISTOGRAM_COUNTS_SPARSE_100000 … #define RTC_HISTOGRAM_COUNTS_SPARSE … #define RTC_HISTOGRAM_PERCENTAGE_SPARSE … #define RTC_HISTOGRAM_BOOLEAN_SPARSE … #define RTC_HISTOGRAM_ENUMERATION_SPARSE … #define RTC_HISTOGRAM_PERCENTAGE … #define RTC_HISTOGRAM_BOOLEAN … #define RTC_HISTOGRAM_ENUMERATION … #define RTC_HISTOGRAM_COMMON_BLOCK … #define RTC_HISTOGRAM_COMMON_BLOCK_SLOW … #define RTC_HISTOGRAMS_COUNTS_100 … #define RTC_HISTOGRAMS_COUNTS_200 … #define RTC_HISTOGRAMS_COUNTS_500 … #define RTC_HISTOGRAMS_COUNTS_1000 … #define RTC_HISTOGRAMS_COUNTS_10000 … #define RTC_HISTOGRAMS_COUNTS_100000 … #define RTC_HISTOGRAMS_ENUMERATION … #define RTC_HISTOGRAMS_PERCENTAGE … #define RTC_HISTOGRAMS_COMMON … #endif // RTC_METRICS_ENABLED namespace webrtc { namespace metrics { // Time that should have elapsed for stats that are gathered once per call. constexpr int kMinRunTimeInSeconds = …; class Histogram; // Functions for getting pointer to histogram (constructs or finds the named // histogram). // Get histogram for counters. Histogram* HistogramFactoryGetCounts(absl::string_view name, int min, int max, int bucket_count); // Get histogram for counters with linear bucket spacing. Histogram* HistogramFactoryGetCountsLinear(absl::string_view name, int min, int max, int bucket_count); // Get histogram for enumerators. // `boundary` should be above the max enumerator sample. Histogram* HistogramFactoryGetEnumeration(absl::string_view name, int boundary); // Get sparse histogram for enumerators. // `boundary` should be above the max enumerator sample. Histogram* SparseHistogramFactoryGetEnumeration(absl::string_view name, int boundary); // Function for adding a `sample` to a histogram. void HistogramAdd(Histogram* histogram_pointer, int sample); struct SampleInfo { … }; // Enables collection of samples. // This method should be called before any other call into webrtc. void Enable(); // Gets histograms and clears all samples. void GetAndReset( std::map<std::string, std::unique_ptr<SampleInfo>, rtc::AbslStringViewCmp>* histograms); // Functions below are mainly for testing. // Clears all samples. void Reset(); // Returns the number of times the `sample` has been added to the histogram. int NumEvents(absl::string_view name, int sample); // Returns the total number of added samples to the histogram. int NumSamples(absl::string_view name); // Returns the minimum sample value (or -1 if the histogram has no samples). int MinSample(absl::string_view name); // Returns a map with keys the samples with at least one event and values the // number of events for that sample. std::map<int, int> Samples(absl::string_view name); } // namespace metrics } // namespace webrtc #endif // SYSTEM_WRAPPERS_INCLUDE_METRICS_H_
Codebase Browser
chromium