Henrik Lundin | 3ef3bfc | 2018-04-10 13:10:26 | [diff] [blame] | 1 | /* Copyright (c) 2018 The WebRTC project authors. All Rights Reserved. |
| 2 | * |
| 3 | * Use of this source code is governed by a BSD-style license |
| 4 | * that can be found in the LICENSE file in the root of the source |
| 5 | * tree. An additional intellectual property rights grant can be found |
| 6 | * in the file PATENTS. All contributing project authors may |
| 7 | * be found in the AUTHORS file in the root of the source tree. |
| 8 | */ |
| 9 | |
| 10 | #ifndef MODULES_AUDIO_CODING_NETEQ_EXPAND_UMA_LOGGER_H_ |
| 11 | #define MODULES_AUDIO_CODING_NETEQ_EXPAND_UMA_LOGGER_H_ |
| 12 | |
Yves Gerey | 988cc08 | 2018-10-23 10:03:01 | [diff] [blame] | 13 | #include <stdint.h> |
Jonas Olsson | a4d8737 | 2019-07-05 17:08:33 | [diff] [blame] | 14 | |
Henrik Lundin | 3ef3bfc | 2018-04-10 13:10:26 | [diff] [blame] | 15 | #include <memory> |
| 16 | #include <string> |
| 17 | |
Ali Tofigh | 714e3cb | 2022-07-20 10:53:07 | [diff] [blame] | 18 | #include "absl/strings/string_view.h" |
Danil Chapovalov | b602123 | 2018-06-19 11:26:36 | [diff] [blame] | 19 | #include "absl/types/optional.h" |
Ivo Creusen | 3ce44a3 | 2019-10-31 13:38:11 | [diff] [blame] | 20 | #include "api/neteq/tick_timer.h" |
Henrik Lundin | 3ef3bfc | 2018-04-10 13:10:26 | [diff] [blame] | 21 | |
| 22 | namespace webrtc { |
| 23 | |
| 24 | // This class is used to periodically log values to a UMA histogram. The caller |
| 25 | // is expected to update this class with an incremental sample counter which |
| 26 | // counts expand samples. At the end of each logging period, the class will |
| 27 | // calculate the fraction of samples that were expand samples during that period |
| 28 | // and report that in percent. The logging period must be strictly positive. |
| 29 | // Does not take ownership of tick_timer and the pointer must refer to a valid |
| 30 | // object that outlives the one constructed. |
| 31 | class ExpandUmaLogger { |
| 32 | public: |
Ali Tofigh | 714e3cb | 2022-07-20 10:53:07 | [diff] [blame] | 33 | ExpandUmaLogger(absl::string_view uma_name, |
Henrik Lundin | 3ef3bfc | 2018-04-10 13:10:26 | [diff] [blame] | 34 | int logging_period_s, |
| 35 | const TickTimer* tick_timer); |
| 36 | |
| 37 | ~ExpandUmaLogger(); |
| 38 | |
Byoungchan Lee | 604fd2f | 2022-01-21 00:49:39 | [diff] [blame] | 39 | ExpandUmaLogger(const ExpandUmaLogger&) = delete; |
| 40 | ExpandUmaLogger& operator=(const ExpandUmaLogger&) = delete; |
| 41 | |
Henrik Lundin | 3ef3bfc | 2018-04-10 13:10:26 | [diff] [blame] | 42 | // In this call, value should be an incremental sample counter. The sample |
| 43 | // rate must be strictly positive. |
| 44 | void UpdateSampleCounter(uint64_t value, int sample_rate_hz); |
| 45 | |
| 46 | private: |
| 47 | const std::string uma_name_; |
| 48 | const int logging_period_s_; |
| 49 | const TickTimer& tick_timer_; |
| 50 | std::unique_ptr<TickTimer::Countdown> timer_; |
Danil Chapovalov | b602123 | 2018-06-19 11:26:36 | [diff] [blame] | 51 | absl::optional<uint64_t> last_logged_value_; |
Henrik Lundin | 3ef3bfc | 2018-04-10 13:10:26 | [diff] [blame] | 52 | uint64_t last_value_ = 0; |
| 53 | int sample_rate_hz_ = 0; |
Henrik Lundin | 3ef3bfc | 2018-04-10 13:10:26 | [diff] [blame] | 54 | }; |
| 55 | |
| 56 | } // namespace webrtc |
| 57 | #endif // MODULES_AUDIO_CODING_NETEQ_EXPAND_UMA_LOGGER_H_ |