blob: c75bd9429cde44176ccf64e5d8e2f4ce5442eef7 [file] [log] [blame]
* Copyright (c) 2022 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 <map>
#include <string>
#include <vector>
#include "absl/strings/string_view.h"
#include "api/numerics/samples_stats_counter.h"
#include "api/test/metrics/metric.h"
#include "api/units/timestamp.h"
#include "rtc_base/synchronization/mutex.h"
#include "rtc_base/thread_annotations.h"
namespace webrtc {
namespace test {
// Accumulates metrics' samples internally and provides API to get collected
// ones.
// This object is thread safe.
class MetricsAccumulator {
MetricsAccumulator() = default;
// Adds sample for the specified `metric_name` within specified
// `test_case_name`. If it is the first time when this combination of
// `metric_name` and `test_case_name` is used, creates a new Metric to collect
// samples, otherwise adds a sample to the previously created Metric.
// By default metric will use `Unit::kUnitless` and
// `ImprovementDirection::kNeitherIsBetter`.
// `point_metadata` - the metadata to be added to the single data point that
// this method adds to the Metric (it is not a metric global metadata).
// Returns true if a new metric was created and false otherwise.
bool AddSample(absl::string_view metric_name,
absl::string_view test_case_name,
double value,
Timestamp timestamp,
std::map<std::string, std::string> point_metadata = {});
// Adds metadata to the metric specified by `metric_name` within specified
// `test_case_name`. If such a metric doesn't exist, creates a new one,
// otherwise overrides previously recorded values.
// Returns true if a new metric was created and false otherwise.
bool AddMetricMetadata(
absl::string_view metric_name,
absl::string_view test_case_name,
Unit unit,
ImprovementDirection improvement_direction,
std::map<std::string, std::string> metric_metadata = {});
// Returns all metrics collected by this accumulator. No order guarantees
// provided.
std::vector<Metric> GetCollectedMetrics() const;
struct MetricKey {
MetricKey(absl::string_view metric_name, absl::string_view test_case_name)
: metric_name(metric_name), test_case_name(test_case_name) {}
std::string metric_name;
std::string test_case_name;
friend bool operator<(const MetricKey& a, const MetricKey& b);
struct MetricValue {
SamplesStatsCounter counter;
Metric metric;
// Gets existing metrics or creates a new one. If metric was created `created`
// will be set to true.
MetricValue* GetOrCreateMetric(absl::string_view metric_name,
absl::string_view test_case_name,
bool* created)
mutable Mutex mutex_;
std::map<MetricKey, MetricValue> metrics_ RTC_GUARDED_BY(mutex_);
} // namespace test
} // namespace webrtc