Additions to the OptionsDescription model. Closes GH-12. Closes GH-13. Closes GH-14

Author: jeremydmiller

src/JasperFx.Core/Descriptions/MetricDescription.cs

@@ -0,0 +1,24 @@
+namespace JasperFx.Core.Descriptions;
+
+public enum MetricsType
+{
+    Histogram,
+    Counter,
+    ObservableGauge
+}
+
+public class MetricDescription
+{
+    public string Name { get; }
+    public MetricsType Type { get; }
+
+    public MetricDescription(string name, MetricsType type)
+    {
+        Name = name;
+        Type = type;
+    }
+
+    public string Units { get; set; } = "Number";
+
+    public Dictionary<string, string> Tags = new();
+}

src/JasperFx.Core/Descriptions/OptionsDescription.cs

@@ -10,6 +10,13 @@ public interface IDescribeMyself
     OptionsDescription ToDescription();
 }
 
+public class OptionSet
+{
+    public string Subject { get; set; }
+    public string[] SummaryColumns { get; set; } = Array.Empty<string>();
+    public List<OptionsDescription> Rows { get; set; } = new();
+}
+
 /// <summary>
 /// Just a serializable, readonly view of system configuration to be used for diagnostic purposes
 /// </summary>
@@ -19,6 +26,11 @@ public class OptionsDescription
     public List<OptionsValue> Properties { get; set; } = new();
 
     public Dictionary<string, OptionsDescription> Children = new();
+
+    /// <summary>
+    /// Children "sets" of option descriptions
+    /// </summary>
+    public Dictionary<string, OptionSet> Sets = new();
 
     // For serialization
     public OptionsDescription()
@@ -54,6 +66,29 @@ public OptionsDescription(object subject)
         }
     }
 
+    public OptionSet AddChildSet(string name)
+    {
+        var subject = $"{Subject}.{name}";
+        var set = new OptionSet { Subject = subject };
+        Sets[name] = set;
+        return set;
+    }
+    
+    public OptionSet AddChildSet(string name, IEnumerable<object> children)
+    {
+        var set = AddChildSet(name);
+        foreach (var child in children)
+        {
+            var description = child is IDescribeMyself describes
+                ? describes.ToDescription()
+                : new OptionsDescription(child);
+            
+            set.Rows.Add(description);
+        }
+
+        return set;
+    }
+
     public OptionsValue AddValue(string name, object value)
     {
         var subject = $"{Subject}.{name}";
@@ -72,4 +107,8 @@ public OptionsValue AddValue(string name, object value)
     {
         return Properties.FirstOrDefault(x => x.Name.EqualsIgnoreCase(name));
     }
+    
+    public Dictionary<string, string> Tags = new();
+
+    public List<MetricDescription> Metrics { get; set; } = new();
 }

src/JasperFx.Core/JasperFx.Core.csproj

@@ -2,7 +2,7 @@
 
     <PropertyGroup>
         <Description>Common extension methods and reflection helpers used by JasperFx projects</Description>
-        <Version>1.10.0</Version>
+        <Version>1.11.0</Version>
         <Authors>Jeremy D. Miller</Authors>
         <AssemblyName>JasperFx.Core</AssemblyName>
         <PackageId>JasperFx.Core</PackageId>