pw_metric: Create new module
This starts the metrics module, which will eventually offer facilities
to track metrics about a system, like average memory use, or other
performance counters.
Change-Id: I2b9dd089cbc2a15af295661fda6f8a6c30353d45
Reviewed-on: https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/15441
Commit-Queue: Keir Mierle <keir@google.com>
Reviewed-by: Wyatt Hepler <hepler@google.com>
Reviewed-by: Ewout van Bekkum <ewout@google.com>
Reviewed-by: Fateh Singh <fsingh@google.com>
Reviewed-by: Zoltan Szatmary-Ban <szatmz@google.com>
diff --git a/pw_metric/global_test.cc b/pw_metric/global_test.cc
new file mode 100644
index 0000000..a4babc7
--- /dev/null
+++ b/pw_metric/global_test.cc
@@ -0,0 +1,68 @@
+// Copyright 2020 The Pigweed Authors
+//
+// Licensed under the Apache License, Version 2.0 (the "License"); you may not
+// use this file except in compliance with the License. You may obtain a copy of
+// the License at
+//
+// https://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+// WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+// License for the specific language governing permissions and limitations under
+// the License.
+
+#include "pw_metric/global.h"
+
+#include "gtest/gtest.h"
+#include "pw_log/log.h"
+#include "pw_metric/metric.h"
+
+namespace pw {
+namespace metric {
+
+// Count elements in an iterable.
+template <typename T>
+int Size(T& container) {
+ int num_elements = 0;
+ for (auto& element : container) {
+ PW_UNUSED(element);
+ num_elements++;
+ }
+ return num_elements;
+}
+
+// Create two global metrics; make sure they show up.
+PW_METRIC_GLOBAL(stat_x, "stat_x", 123u);
+PW_METRIC_GLOBAL(stat_y, "stat_y", 123u);
+
+TEST(Global, Metrics) {
+ Metric::Dump(global_metrics);
+ EXPECT_EQ(Size(global_metrics), 2);
+}
+
+// Create three global metric groups; make sure they show up.
+// Also, register some sub-metrics in the global groups.
+PW_METRIC_GROUP_GLOBAL(gyro_metrics, "gyro");
+PW_METRIC(gyro_metrics, max_velocity, "max_velocity", 5.0f);
+
+PW_METRIC_GROUP_GLOBAL(comms_metrics, "comms");
+PW_METRIC(comms_metrics, packet_drops, "packet_drops", 10u);
+PW_METRIC(comms_metrics, bandwidth, "bandwidth", 230.3f);
+
+PW_METRIC_GROUP_GLOBAL(power_metrics, "power");
+PW_METRIC(power_metrics, voltage, "voltage", 3.33f);
+PW_METRIC(power_metrics, battery_cycles, "battery_cycles", 550u);
+PW_METRIC(power_metrics, current_ma, "current_ma", 35.2f);
+
+TEST(Global, Groups) {
+ Group::Dump(global_groups);
+ EXPECT_EQ(Size(global_groups), 3);
+
+ EXPECT_EQ(Size(gyro_metrics.metrics()), 1);
+ EXPECT_EQ(Size(comms_metrics.metrics()), 2);
+ EXPECT_EQ(Size(power_metrics.metrics()), 3);
+}
+
+} // namespace metric
+} // namespace pw