feat(about-me): add option to avoid dmidecode and sudo (closes #948)

Author: markuslf

CHANGELOG.md

@@ -11,6 +11,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/).
 
 Monitoring Plugins:
 
+* about-me: add option to avoid dmidecode and sudo ([#948](https://github.com/Linuxfabrik/lib/issues/948))
 * ntp-\*: add `--stratum` parameter and modernize code
 * sprint-boot-actuator-health: derived from [PR #940](https://github.com/Linuxfabrik/monitoring-plugins/pull/940), thanks to [Dominik Riva](https://github.com/slalomsk8er) - a monitoring plugin for the Spring Boot Actuator `/health` endpoint
 * virustotal-scan-url: analyses URLs to detect malware and other breaches using VirusTotal

check-plugins/about-me/README.md

@@ -33,14 +33,19 @@ Plugin execution may take up to 30 seconds, depending on the amount or type of i
 ## Help
 
 ```text
-usage: about-me [-h] [-V] [--insecure] [--no-proxy]
+usage: about-me [-h] [-V] [--dmidecode] [--insecure] [--no-proxy]
                 [--public-ip-url PUBLIC_IP_URL] [--tags] [--timeout TIMEOUT]
 
 Provides a quick overview of host dimensions and software.
 
 options:
   -h, --help            show this help message and exit
   -V, --version         show program's version number and exit
+  --dmidecode           Use the `dmidecode` command to gather additional
+                        hardware information, such as a list of the system's
+                        components, as well as other useful details like
+                        serial numbers and BIOS revisions. If enabled, this
+                        feature requires sudo permissions. Default: False
   --insecure            This option explicitly allows to perform "insecure"
                         SSL connections. Default: False
   --no-proxy            Do not use a proxy. Default: False
@@ -60,7 +65,7 @@ options:
 ## Usage Examples
 
 ```bash
-./about-me
+./about-me --dmidecode
 ```
 
 Shortened output example:

check-plugins/about-me/about-me

@@ -40,10 +40,11 @@ except ImportError:
 
 
 __author__ = 'Linuxfabrik GmbH, Zurich/Switzerland'
-__version__ = '2025090901 / v2.1.1'
+__version__ = '2025091701 / v2.1.1'
 
 DESCRIPTION = 'Provides a quick overview of host dimensions and software.'
 
+DEFAULT_DMIDECODE = False
 DEFAULT_INSECURE = False
 DEFAULT_NO_PROXY = False
 DEFAULT_PUBLIC_IP_URL = None
@@ -61,6 +62,17 @@ def parse_args():
         version='{0}: v{1} by {2}'.format('%(prog)s', __version__, __author__)
     )
 
+    parser.add_argument(
+        '--dmidecode',
+        help='Use the `dmidecode` command to gather additional hardware information, such as a list '
+             'of the system\'s components, as well as other useful details like serial numbers and '
+             'BIOS revisions. If enabled, this feature requires sudo permissions. '
+             'Default: %(default)s',
+        dest='DMIDECODE',
+        action='store_true',
+        default=DEFAULT_DMIDECODE,
+    )
+
     parser.add_argument(
         '--insecure',
         help='This option explicitly allows to perform "insecure" SSL connections. '
@@ -806,7 +818,10 @@ def main():
     if firmware_device_model:
         msg += '{}, '.format(firmware_device_model)
 
-    dmi = lib.dmidecode.get_data()
+    if args.DMIDECODE:
+        dmi = lib.dmidecode.get_data()
+    else:
+        dmi = False
     sys_dimensions = get_sys_dimensions()
     if dmi and sys_dimensions:
         # combine the best from both worlds
@@ -845,6 +860,7 @@ def main():
             sys_dimensions['cpu_logical'],
             sys_dimensions['cpu_usable'],
         )
+        msg += 'Current Speed: {} MHz, '.format(int(sys_dimensions['cpu_freq'][0]))
         msg += '{} RAM, '.format(
             lib.human.bytes2human(sys_dimensions['ram'])
         )
@@ -865,7 +881,8 @@ def main():
 
 
     # multi-line content - print further lines -----------------------------------------------------
-    msg += get_hw_info()
+    if args.DMIDECODE:
+        msg += get_hw_info()
     msg += get_interfaces()
     msg += get_listening_ports()
     msg += get_nondefault_software()
@@ -893,7 +910,7 @@ def main():
     perfdata += lib.base.get_perfdata('cpu_logical', sys_dimensions['cpu_logical'], None, None, None, 0, None)
     perfdata += lib.base.get_perfdata('cpu_physical', sys_dimensions['cpu_physical'], None, None, None, 0, None)
     perfdata += lib.base.get_perfdata('cpu_usable', sys_dimensions['cpu_usable'], None, None, None, 0, None)
-    perfdata += lib.base.get_perfdata('cpu_freq', int(sys_dimensions['cpu_freq'][0]), None, None, None, 0, lib.dmidecode.cpu_speed(dmi))
+    perfdata += lib.base.get_perfdata('cpu_freq', int(sys_dimensions['cpu_freq'][0]), None, None, None, 0, lib.dmidecode.cpu_speed(dmi) if args.DMIDECODE else None)
     if dmi:
         perfdata += lib.base.get_perfdata('ram', lib.dmidecode.ram(dmi), 'B', None, None, 0, None)
     elif sys_dimensions:

check-plugins/about-me/icingaweb2-module-director/about-me.json

@@ -2,6 +2,9 @@
     "Command": {
         "cmd-check-about-me": {
             "arguments": {
+                "--dmidecode": {
+                    "set_if": "$about_me_dmidecode$"
+                },
                 "--insecure": {
                     "set_if": "$about_me_insecure$"
                 },
@@ -45,6 +48,11 @@
                     "datafield_id": 5,
                     "is_required": "n",
                     "var_filter": null
+                },
+                {
+                    "datafield_id": 6,
+                    "is_required": "n",
+                    "var_filter": null
                 }
             ],
             "imports": [],
@@ -99,6 +107,7 @@
             "use_var_overrides": null,
             "vars": {
                 "criticality": "C",
+                "about_me_dmidecode": true,
                 "about_me_insecure": false,
                 "about_me_no_proxy": false,
                 "about_me_tags": false,
@@ -111,6 +120,15 @@
     },
     "Datafield": {
         "1": {
+            "varname": "about_me_dmidecode",
+            "caption": "About Me: Dmidecode?",
+            "description": "Use the `dmidecode` command to gather additional hardware information, such as a list of the system's components, as well as other useful details like serial numbers and BIOS revisions. If enabled, this feature requires sudo permissions.",
+            "datatype": "Icinga\\Module\\Director\\DataType\\DataTypeBoolean",
+            "format": null,
+            "settings": {},
+            "uuid": "0cecc7e6-6684-4e66-b3aa-ab98cab75eca"
+        },
+        "2": {
             "varname": "about_me_insecure",
             "caption": "About Me: Insecure?",
             "description": "This option explicitly allows to perform \"insecure\" SSL connections.",
@@ -119,7 +137,7 @@
             "settings": {},
             "uuid": "42dbeb20-a8c7-43ff-89d2-771e8c8fc5d0"
         },
-        "2": {
+        "3": {
             "varname": "about_me_no_proxy",
             "caption": "About Me: No Proxy?",
             "description": "Do not use a proxy.",
@@ -128,7 +146,7 @@
             "settings": {},
             "uuid": "1ef7aa98-4d41-4973-aecc-bf0f438f6f57"
         },
-        "3": {
+        "4": {
             "varname": "about_me_public_ip_url",
             "caption": "About Me: Public Ip URL",
             "description": "If you want this check to return the public IP address, specify one ore more comma-separated URLs to \"what is my ip\" online services. For example: \"https://ipv4.icanhazip.com,https://ipecho.net/plain,https://ipinfo.io/ip\" (these examples are located in the United States).",
@@ -139,7 +157,7 @@
             },
             "uuid": "d8dad468-3de3-4ffd-9db8-ff414b55e619"
         },
-        "4": {
+        "5": {
             "varname": "about_me_tags",
             "caption": "About Me: Tags?",
             "description": "Guess a list of tags to apply in Icinga Director (Linuxfabrik Basket Config).",
@@ -148,7 +166,7 @@
             "settings": {},
             "uuid": "c1687513-03a9-4599-bac4-468e29b45ae2"
         },
-        "5": {
+        "6": {
             "varname": "about_me_timeout",
             "caption": "About Me: Timeout",
             "description": "Network timeout in seconds.",

check-plugins/about-me/icingaweb2-module-director/about-me.yml

@@ -5,3 +5,4 @@ overwrites:
   '["ServiceTemplate"]["tpl-service-about-me"]["check_interval"]': 86400
   '["ServiceTemplate"]["tpl-service-about-me"]["enable_perfdata"]': true
   '["ServiceTemplate"]["tpl-service-about-me"]["retry_interval"]': 3600
+  '["ServiceTemplate"]["tpl-service-about-me"]["vars"]["about_me_dmidecode"]': true