Merge pull request #222 from WildernessLabs/custom_health_metric

add AddMetric(...) to IHealthReporter
WildernessLabs · May 1, 2024 · 95964a9 · 95964a9
2 parents 59f0450 + b08df99
commit 95964a9
Showing 1 changed file with 17 additions and 0 deletions.
diff --git a/Source/Meadow.Contracts/Cloud/IHealthReporter.cs b/Source/Meadow.Contracts/Cloud/IHealthReporter.cs
@@ -1,3 +1,4 @@
+using System;
 using System.Threading.Tasks;
 
 namespace Meadow.Cloud;
@@ -18,4 +19,20 @@ public interface IHealthReporter
     /// </summary>
     /// <returns></returns>
     Task Send();
+
+    /// <summary>
+    /// Add a custom health metric.
+    /// </summary>
+    /// <param name="name">Metric name.</param>
+    /// <param name="func">Function to calculate metric value.</param>
+    /// <returns></returns>
+    bool AddMetric(string name, Func<object> func);
+
+    /// <summary>
+    /// Add a custom health metric.
+    /// </summary>
+    /// <param name="name">Metric name.</param>
+    /// <param name="func">Function to calculate the metric value.</param>
+    /// <returns></returns>
+    bool AddMetric(string name, Func<Task<object>> func);
 }