feat(sensors-temperatures): add --ignore parameter to filter sensors by regex (#965)

Author: markuslf

.pylintrc

@@ -3,6 +3,9 @@ disable=
     # Plugin file names use dashes (e.g. "cpu-usage", "ipmi-sel") which is correct
     # for CLI tools but violates Python's snake_case module naming convention.
     C0103,
+    # Some plugins need warnings.filterwarnings() before imports (e.g. psutil
+    # deprecation warnings). This is intentional and cannot be avoided.
+    C0413,
     # Every plugin uses "except Exception: lib.base.cu()" as a top-level safety net.
     # This is intentional and consistent across all plugins.
     W0718,

CHANGELOG.md

@@ -40,6 +40,7 @@ Monitoring Plugins:
 * infomaniak-swiss-backup-devices: add `--ignore-customer`, `--ignore-name`, `--ignore-tag`, `--ignore-user` parameters to skip devices by regex
 * infomaniak-swiss-backup-products: add `--ignore-customer`, `--ignore-tag` parameters to skip products by regex
 * ipmi-sel: add `--ignore` parameter to filter out SEL entries by regex, e.g. auto-generated "Log area reset/cleared" entries after `ipmitool sel clear` ([#982](https://github.com/Linuxfabrik/monitoring-plugins/issues/982))
+* sensors-temperatures: add `--ignore` parameter to filter out sensors by regex ([#965](https://github.com/Linuxfabrik/monitoring-plugins/issues/965))
 * librenms-alerts: add device-type `management`
 * librenms-health: add device-type `management`
 * nextcloud-enterprise: provides information about an installed Nextcloud Enterprise subscription

check-plugins/sensors-temperatures/README.md

@@ -23,17 +23,20 @@ Hints:
 ## Help
 
 ```text
-usage: sensors-temperatures [-h] [-V] [--always-ok]
+usage: sensors-temperatures [-h] [-V] [--always-ok] [--ignore IGNORE]
 
 Return certain hardware temperature sensors (it may be a CPU, an hard disk or
 something else, depending on the OS and its configuration). All temperatures
 are expressed in celsius. Check is done automatically against hardware
 thresholds. If sensors are not supported by the OS OK is returned.
 
 options:
-  -h, --help     show this help message and exit
-  -V, --version  show program's version number and exit
-  --always-ok    Always returns OK.
+  -h, --help       show this help message and exit
+  -V, --version    show program's version number and exit
+  --always-ok      Always returns OK.
+  --ignore IGNORE  Ignore sensors matching this Python regular expression on
+                   the sensor name or label (repeating). Example:
+                   `--ignore="iwlwifi_1"` or `--ignore="^acpitz"`
 ```
 
 

check-plugins/sensors-temperatures/icingaweb2-module-director/sensors-temperatures.json

@@ -4,6 +4,10 @@
             "arguments": {
                 "--always-ok": {
                     "set_if": "$sensors_temperatures_always_ok$"
+                },
+                "--ignore": {
+                    "value": "$sensors_temperatures_ignore$",
+                    "repeat_key": true
                 }
             },
             "command": "/usr/lib64/nagios/plugins/sensors-temperatures",
@@ -13,6 +17,11 @@
                     "datafield_id": 1,
                     "is_required": "n",
                     "var_filter": null
+                },
+                {
+                    "datafield_id": 2,
+                    "is_required": "n",
+                    "var_filter": null
                 }
             ],
             "imports": [],
@@ -67,7 +76,8 @@
             "use_var_overrides": null,
             "vars": {
                 "criticality": "A",
-                "sensors_temperatures_always_ok": false
+                "sensors_temperatures_always_ok": false,
+                "sensors_temperatures_ignore": []
             },
             "volatile": null,
             "zone": null,
@@ -83,6 +93,17 @@
             "format": null,
             "settings": {},
             "uuid": "7170c8a1-70a8-4052-b98f-253d25ca28b5"
+        },
+        "2": {
+            "varname": "sensors_temperatures_ignore",
+            "caption": "Sensors Temperatures: Ignore",
+            "description": "Ignore sensors matching this Python regular expression on the sensor name or label (repeating). Example: `--ignore=\"iwlwifi_1\"` or `--ignore=\"^acpitz\"`",
+            "datatype": "Icinga\\Module\\Director\\DataType\\DataTypeArray",
+            "format": null,
+            "settings": {
+                "visibility": "visible"
+            },
+            "uuid": "3148036c-198e-47c1-bec8-cc4800683402"
         }
     }
 }

check-plugins/sensors-temperatures/sensors-temperatures

@@ -14,22 +14,22 @@
 import warnings
 
 warnings.filterwarnings("ignore")
-import argparse  # pylint: disable=C0413
-import sys  # pylint: disable=C0413
+import argparse
+import re
+import sys
 
-import lib.base  # pylint: disable=C0413
-from lib.globals import (STATE_CRIT, STATE_OK,  # pylint: disable=C0413
-                          STATE_UNKNOWN, STATE_WARN)
+import lib.base
+from lib.globals import (STATE_OK, STATE_UNKNOWN)
 
 try:
-    import psutil  # pylint: disable=C0413
+    import psutil
 except ImportError:
     print('Python module "psutil" is not installed.')
     sys.exit(STATE_UNKNOWN)
 
 
 __author__ = 'Linuxfabrik GmbH, Zurich/Switzerland'
-__version__ = '2025100601'
+__version__ = '2026040801'
 
 DESCRIPTION = """Return certain hardware temperature sensors (it may be a CPU, an hard disk or
                  something else, depending on the OS and its configuration). All temperatures are
@@ -45,7 +45,7 @@ def parse_args():
     parser.add_argument(
         '-V', '--version',
         action='version',
-        version='%(prog)s: v{} by {}'.format(__version__, __author__)
+        version=f'%(prog)s: v{__version__} by {__author__}'
     )
 
     parser.add_argument(
@@ -56,6 +56,16 @@ def parse_args():
         default=False,
     )
 
+    parser.add_argument(
+        '--ignore',
+        help='Ignore sensors matching this Python regular expression on the sensor '
+             'name or label (repeating). '
+             'Example: `--ignore="iwlwifi_1"` or `--ignore="^acpitz"`',
+        dest='IGNORE',
+        action='append',
+        default=None,
+    )
+
     args, _ = parser.parse_known_args()
     return args
 
@@ -70,35 +80,65 @@ def main():
     except SystemExit:
         sys.exit(STATE_UNKNOWN)
 
+    if args.IGNORE is None:
+        args.IGNORE = []
+
+    # compile ignore patterns
+    try:
+        ignore_patterns = [re.compile(p) for p in args.IGNORE]
+    except re.error as e:
+        lib.base.cu(f'Invalid regular expression: {e}')
+
     if not hasattr(psutil, 'sensors_temperatures'):
         lib.base.cu('Platform not supported.')
 
     # fetch data
     temps = psutil.sensors_temperatures()
     if not temps:
-        lib.base.oao('Can\'t read any temperature.', STATE_OK, always_ok=args.ALWAYS_OK)
+        lib.base.oao("Can't read any temperature.", STATE_OK, always_ok=args.ALWAYS_OK)
 
     msg = ''
     state = STATE_OK
     perfdata = ''
 
     for name, entries in temps.items():
-        msg += '* {}: '.format(name)
+        filtered_entries = []
         for entry in entries:
-            perfdata += lib.base.get_perfdata('{}_{}'.format(name, entry.label).replace(' ', '_').lower(), entry.current, None, entry.high, entry.critical, 0, None)
+            sensor_id = f'{name}_{entry.label}' if entry.label else name
+            if any(pattern.search(sensor_id) for pattern in ignore_patterns):
+                continue
+            filtered_entries.append(entry)
+
+        if not filtered_entries:
+            continue
+
+        msg += f'* {name}: '
+        for entry in filtered_entries:
+            perfdata_label = f'{name}_{entry.label}'.replace(' ', '_').lower() \
+                if entry.label else name.replace(' ', '_').lower()
+            perfdata += lib.base.get_perfdata(
+                perfdata_label,
+                entry.current,
+                warn=entry.high,
+                crit=entry.critical,
+                _min=0,
+            )
             sensor_state = lib.base.get_state(entry.current, entry.high, entry.critical, 'ge')
-            msg += '{} = {}°C '.format(entry.label or name, entry.current)
+            msg += f'{entry.label or name} = {entry.current}°C '
             msg += lib.base.state2str(sensor_state)
             msg = msg.strip() + ', '
             state = lib.base.get_worst(state, sensor_state)
         msg = msg[:-2] + '\n'
 
+    if not msg:
+        lib.base.oao('Everything is ok (all sensors ignored).', STATE_OK, always_ok=args.ALWAYS_OK)
+
     # over and out
-    lib.base.oao(msg[:-2], state, perfdata, always_ok=args.ALWAYS_OK)
+    lib.base.oao(msg[:-1], state, perfdata, always_ok=args.ALWAYS_OK)
 
 
 if __name__ == '__main__':
     try:
         main()
-    except Exception:   # pylint: disable=W0703
+    except Exception:
         lib.base.cu()