Merge pull request #229 from nickbabcock/glob

Allow hiding of sensors by glob

OhmGraphite.Test/ConfigTest.cs

@@ -124,6 +124,12 @@ namespace OhmGraphite.Test
             Assert.True(results.IsHidden("/amdcpu/0/load/1"));
             Assert.True(results.IsHidden("/amdcpu/0/load/2"));
             Assert.False(results.IsHidden("/amdcpu/0/load/3"));
+
+            Assert.True(results.IsHidden("/amdcpu/0/clock/1"));
+            Assert.True(results.IsHidden("/amdcpu/1/clock/100"));
+            Assert.True(results.IsHidden("/amdcpu/0/power/1"));
+            Assert.True(results.IsHidden("/nvidia-gpu/0/power/1"));
+            Assert.False(results.IsHidden("/nvme/0/factor/power_cycles"));
         }
 
         [Fact]

OhmGraphite/MetricConfig.cs

@@ -4,6 +4,7 @@ using System.Linq;
 using System.Net;
 using System.Net.Security;
 using System.Security.Cryptography.X509Certificates;
+using System.Text.RegularExpressions;
 
 namespace OhmGraphite
 {
@@ -12,7 +13,7 @@ namespace OhmGraphite
         private readonly INameResolution _nameLookup;
 
         public MetricConfig(TimeSpan interval, INameResolution nameLookup, GraphiteConfig graphite, InfluxConfig influx,
-            PrometheusConfig prometheus, TimescaleConfig timescale, Dictionary<string, string> aliases, ISet<string> hiddenSensors, Influx2Config influx2)
+            PrometheusConfig prometheus, TimescaleConfig timescale, Dictionary<string, string> aliases, List<Regex> hiddenSensors, Influx2Config influx2)
         {
             _nameLookup = nameLookup;
             Interval = interval;
@@ -33,7 +34,7 @@ namespace OhmGraphite
         public PrometheusConfig Prometheus { get; }
         public TimescaleConfig Timescale { get; }
         public Dictionary<string, string> Aliases { get; }
-        public ISet<string> HiddenSensors { get; }
+        public List<Regex> HiddenSensors { get; }
 
         public static MetricConfig ParseAppSettings(IAppConfig config)
         {
@@ -83,9 +84,17 @@ namespace OhmGraphite
                     x => config[x]
                 );
 
-            var hidden = config.GetKeys().Where(x => x.EndsWith("/hidden"))
-                .Select(x => x.Remove(x.LastIndexOf("/hidden", StringComparison.Ordinal)));
-            var hiddenSensors = new HashSet<string>(hidden);
+            // Do a similar trim with "/hidden" suffix except treat the prefix as a glob to hide
+            // a group of sensors like if one wants to hide all power sensors they can do:
+            // /*/power/*/hidden
+            // Code to detect interpret strings as globs is shamelessly taken from stackoverflow:
+            // https://stackoverflow.com/a/4146349/433785
+            var hiddenSensors = config.GetKeys().Where(x => x.EndsWith("/hidden"))
+                .Select(x => x.Remove(x.LastIndexOf("/hidden", StringComparison.Ordinal)))
+                .Select(pattern => new Regex(
+                    "^" + Regex.Escape(pattern).Replace(@"\*", ".*").Replace(@"\?", ".") + "$",
+                    RegexOptions.IgnoreCase | RegexOptions.Singleline
+                )).ToList();
 
             return new MetricConfig(interval, nameLookup, gconfig, iconfig, pconfig, timescale, aliases, hiddenSensors, influx2);
         }
@@ -129,6 +138,6 @@ namespace OhmGraphite
         }
 
         public bool TryGetAlias(string v, out string alias) => Aliases.TryGetValue(v, out alias);
-        public bool IsHidden(string id) => HiddenSensors.Contains(id);
+        public bool IsHidden(string id) => HiddenSensors.Any(x => x.IsMatch(id));
     }
 }

README.md

@@ -247,6 +247,13 @@ There may be a sensor that is faulty on a given machine. Maybe it reports negati
 <add key="/lpc/nct6792d/temperature/1/hidden" />
 ```
 
+One can use globs to ignore a group of sensors. For instance, to hide all power sensors and hide clock sensors from an AMD CPU:
+
+```xml
+<add key="/amdcpu/*/clock/*/hidden" />
+<add key="/*/power/*/hidden" />
+``` 
+
 ### Determine Sensor Id
 
 There are several ways to determine the sensor id of a metric:

assets/hidden-sensors.config

@@ -8,5 +8,7 @@
 
     <add key="/amdcpu/0/load/1/hidden" />
     <add key="/amdcpu/0/load/2/hidden" />
+    <add key="/amdcpu/*/clock/*/hidden" />
+    <add key="/*/power/*/hidden" />
   </appSettings>
 </configuration>