Use wildcard (regexp) to the hide configuration option for network, diskio and fs sections #799

NEWS

@@ -9,6 +9,7 @@ Enhancements and new features:
 
     * Add a connector to ElasticSearch (welcome to Kibana dashboard) (issue #311)
     * New folders' monitoring plugins (issue #721)
+    * Use wildcard (regexp) to the hide configuration option for network, diskio and fs sections (issue #799 )
     * Command line arguments are now take into account in the WebUI (#789 from @notFloran)
     * Add an option to disable top menu (issue #766)
     * Add IOps in the DiskIO plugin (issue #763)

conf/glances.conf

@@ -69,7 +69,7 @@ critical=90
 
 [network]
 # Define the list of hidden network interfaces (comma separeted regexp)
-hide=docker.*
+#hide=docker.*,lo
 # WLAN 0 alias
 #wlan0_alias=Wireless IF
 # WLAN 0 Default limits (in bits per second aka bps) for interface bitrate
@@ -84,13 +84,13 @@ hide=docker.*
 
 [diskio]
 # Define the list of hidden disks (comma separeted regexp)
-hide=sda2,sda5,loop.*
+#hide=sda2,sda5,loop.*
 # Alias for sda1
 #sda1_alias=IntDisk
 
 [fs]
 # Define the list of hidden file system (comma separeted regexp)
-hide=/boot.*
+#hide=/boot.*
 # Define filesystem space thresholds in %
 # Default values if not defined: 50/70/90
 # It is also possible to define per mount point value

docs/glances-doc.rst

@@ -2,11 +2,11 @@
 Glances
 =======
 
-This manual describes *Glances* version 2.5.1.
+This manual describes *Glances* version 2.6.
 
-Copyright © 2011-2015 Nicolas Hennion <nicolas@nicolargo.com>
+Copyright © 2011-2016 Nicolas Hennion <nicolas@nicolargo.com>
 
-October, 2015
+March, 2016
 
 .. contents:: Table of Contents
 
@@ -537,6 +537,13 @@ Alerts are only set if the maximum speed per network interface is available
 and per-interface limit values in the ``[network]`` section of the
 configuration file and aliases for interface name.
 
+For example, if you want to hide the loopback interface (lo) and all the virtual docker interface (docker0, docker1...):
+
+::
+
+    [network]    
+    hide=lo,docker.*
+
 Disk I/O
 --------
 
@@ -549,6 +556,13 @@ There is no alert on this information.
 *Note*: it is possible to define a list of disks to hide under the
 ``[diskio]`` section in the configuration file and aliases for disk name.
 
+For example, if you want to hide the loopback disks (loop0, loop1..) and the specific sda5 disk:
+
+::
+
+    [diskio]
+    hide=sda5,loop.*
+
 File System
 -----------
 
@@ -575,10 +589,13 @@ By default, the plugin only displays physical devices (hard disks, USB
 keys) and ignore all others. To allow others FS type, you have to use the
 following section in the configuration file:
 
+For example, if you want to allow the zfs and misc filesystems and hide boot mount points:
+
 ::
 
     [fs]
     allow=zfs,misc
+    hide=/boot.*    
 
 Folders
 -------

glances/plugins/glances_plugin.py

@@ -509,13 +509,14 @@ class GlancesPlugin(object):
             return []
 
     def is_hide(self, value, header=""):
-        """Return True if the value is in the hide configuration list."""
-        # return value in self.get_conf_value('hide', header=header)
-        logger.info("="*80)
-        logger.info("value={}".format(value))
-        logger.info("hide={}".format(self.get_conf_value('hide', header=header)))
-        logger.info("match={}".format([re.match(value, i) for i in self.get_conf_value('hide', header=header)]))
-        logger.info("result={}".format(not all(j is None for j in [re.match(i, value) for i in self.get_conf_value('hide', header=header)])))
+        """
+        Return True if the value is in the hide configuration list.
+        The hide configuration list is defined in the glances.conf file.
+        It is a comma separed list of regexp.
+        Example for diskio:
+        hide=sda2,sda5,loop.*
+        """
+        # TODO: possible optimisation: create a re.compile list
         return not all(j is None for j in [re.match(i, value) for i in self.get_conf_value('hide', header=header)])
 
     def has_alias(self, header):