Added some documentation regarding the newly added macros. Fixed the ci.

shripad621git · Feb 9, 2024 · 9744326 · 9744326
1 parent 8e0bae7
commit 9744326
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 1 deletion.
diff --git a/src/tracing/json/json_tracing.cpp b/src/tracing/json/json_tracing.cpp
@@ -299,7 +299,7 @@ void JsonBackend::TraceMetric(const char * label, long int val)
 {
     ::Json::Value value;
     value["label"] = label;
-    value["val"]   = val;
+    value["label_value"] = val;
 
     // Output the metric
 

diff --git a/src/tracing/macros.h b/src/tracing/macros.h
@@ -26,6 +26,14 @@
 //    MATTER_TRACE_END(label, group)
 //    MATTER_TRACE_INSTANT(label, group)
 //    MATTER_TRACE_SCOPE(label, group)
+
+// Tracing macro to trace monotonically increasing counter values.
+//  MATTER_TRACE_COUNTER(label)
+
+// Tracing macro to represent historical metric data i.e the data points which represent different
+// values at different point of time.
+//  MATTER_TRACE_METRIC(label, value)
+
 #include <matter/tracing/macros_impl.h>
 #include <tracing/log_declares.h>
 #include <tracing/registry.h>