feat(ntp-*): add --stratum parameter and modernize code

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:
 
+* 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/ntp-chronyd/README.md

@@ -34,16 +34,24 @@ The stratum of the NTP time source determines its quality. The stratum is equal
 ## Help
 
 ```text
-usage: ntp-chronyd [-h] [-V] [-c CRIT] [--test TEST] [-w WARN]
+usage: ntp-chronyd [-h] [-V] [-c CRIT] [--stratum STRATUM] [--test TEST]
+                   [-w WARN]
 
-This plugin checks the clock offset of chronyd in milliseconds compared to ntp
-servers.
+This plugin compares the chronyd clock offset in milliseconds to that of the
+NTP servers.
 
 options:
   -h, --help           show this help message and exit
   -V, --version        show program's version number and exit
   -c, --critical CRIT  Set the critical threshold for the ntp time offset, in
                        ms. Default: 86400000ms
+  --stratum STRATUM    Warns if the determined stratum of the time server is
+                       greater than or equal to this value. Stratum 1
+                       indicates a computer with a locally attached reference
+                       clock. A computer that is synchronised to a stratum 1
+                       computer is at stratum 2. A computer that is
+                       synchronised to a stratum 2 computer is at stratum 3,
+                       and so on. Default: 6
   --test TEST          For unit tests. Needs "path-to-stdout-file,path-to-
                        stderr-file,expected-retc".
   -w, --warning WARN   Set the warning threshold for the ntp time offset, in
@@ -54,7 +62,7 @@ options:
 ## Usage Examples
 
 ```bash
-./ntp-chronyd --warning 500 --critical 10000
+./ntp-chronyd --warning=500 --critical=10000 --stratum=6
 ```
 
 Output:
@@ -91,7 +99,7 @@ MS Name/IP address         Stratum Poll Reach LastRx Last sample
 ## States
 
 * WARN or CRIT if ntp offset is below or above a given threshold.
-* WARN if stratum is \>= 9.
+* WARN if stratum is \>= `--stratum`.
 * WARN if no NTP server is used.
 * WARN if no NTP server is found.
 

check-plugins/ntp-chronyd/icingaweb2-module-director/ntp-chronyd.json

@@ -5,6 +5,9 @@
                 "--critical": {
                     "value": "$ntp_chronyd_critical$"
                 },
+                "--stratum": {
+                    "value": "$ntp_chronyd_stratum$"
+                },
                 "--warning": {
                     "value": "$ntp_chronyd_warning$"
                 }
@@ -21,6 +24,11 @@
                     "datafield_id": 2,
                     "is_required": "n",
                     "var_filter": null
+                },
+                {
+                    "datafield_id": 3,
+                    "is_required": "n",
+                    "var_filter": null
                 }
             ],
             "imports": [],
@@ -64,7 +72,7 @@
                 "tpl-service-generic"
             ],
             "max_check_attempts": 5,
-            "notes": "This plugin checks the clock offset of chronyd in milliseconds compared to ntp servers.",
+            "notes": "This plugin compares the chronyd clock offset in milliseconds to that of the NTP servers.",
             "notes_url": "https://github.com/Linuxfabrik/monitoring-plugins/tree/main/check-plugins/ntp-chronyd",
             "object_name": "tpl-service-ntp-chronyd",
             "object_type": "template",
@@ -76,6 +84,7 @@
             "vars": {
                 "criticality": "C",
                 "ntp_chronyd_critical": 86400000,
+                "ntp_chronyd_stratum": 6,
                 "ntp_chronyd_warning": 800
             },
             "volatile": null,
@@ -96,6 +105,17 @@
             "uuid": "47e8b431-eaae-4136-8a70-350ce0ca1804"
         },
         "2": {
+            "varname": "ntp_chronyd_stratum",
+            "caption": "NTP Chronyd: Stratum",
+            "description": "Warns if the determined stratum of the time server is greater than or equal to this value. Stratum 1 indicates a computer with a locally attached reference clock. A computer that is synchronised to a stratum 1 computer is at stratum 2. A computer that is synchronised to a stratum 2 computer is at stratum 3, and so on.",
+            "datatype": "Icinga\\Module\\Director\\DataType\\DataTypeString",
+            "format": null,
+            "settings": {
+                "visibility": "visible"
+            },
+            "uuid": "61cac0f3-c41b-42f8-a11d-f255d74ece12"
+        },
+        "3": {
             "varname": "ntp_chronyd_warning",
             "caption": "NTP Chronyd: Warning",
             "description": "Set the warning threshold for the ntp time offset, in ms.",

check-plugins/ntp-chronyd/ntp-chronyd

@@ -11,25 +11,25 @@
 """See the check's README for more details.
 """
 
-import argparse  # pylint: disable=C0413
-import sys  # pylint: disable=C0413
+import argparse
+import sys
 
-import lib.args  # pylint: disable=C0413
-import lib.base  # pylint: disable=C0413
-import lib.human  # pylint: disable=C0413
-import lib.shell  # pylint: disable=C0413
-import lib.lftest  # pylint: disable=C0413
-from lib.globals import (STATE_CRIT, STATE_OK,  # pylint: disable=C0413
-                          STATE_UNKNOWN, STATE_WARN)
+import lib.args
+import lib.base
+import lib.human
+import lib.lftest
+import lib.shell
+from lib.globals import (STATE_OK, STATE_UNKNOWN, STATE_WARN)
 
 __author__ = 'Linuxfabrik GmbH, Zurich/Switzerland'
-__version__ = '2025021501'
+__version__ = '2025091501'
 
-DESCRIPTION = '''This plugin checks the clock offset of chronyd in milliseconds
-                 compared to ntp servers.'''
+DESCRIPTION = '''This plugin compares the chronyd clock offset in milliseconds to that of
+                 the NTP servers.'''
 
-DEFAULT_WARN = 800  # ms offset
 DEFAULT_CRIT = 86400000 # 24h in ms offset
+DEFAULT_STRATUM = 6
+DEFAULT_WARN = 800  # ms offset
 
 
 def parse_args():
@@ -40,17 +40,27 @@ def parse_args():
     parser.add_argument(
         '-V', '--version',
         action='version',
-        version='{0}: v{1} by {2}'.format('%(prog)s', __version__, __author__)
+        version=f'%(prog)s: v{__version__} by {__author__}'
     )
 
     parser.add_argument(
         '-c', '--critical',
-        help='Set the critical threshold for the ntp time offset, in ms. Default: %(default)sms',
+        help='Set the critical threshold for the ntp time offset, in ms. '
+             'Default: %(default)sms',
         dest='CRIT',
         type=int,
         default=DEFAULT_CRIT,
     )
 
+    parser.add_argument(
+        '--stratum',
+        help=lib.args.help('--stratum') + ' '
+             + 'Default: %(default)s',
+        dest='STRATUM',
+        type=int,
+        default=DEFAULT_STRATUM,
+    )
+
     parser.add_argument(
         '--test',
         help='For unit tests. Needs "path-to-stdout-file,path-to-stderr-file,expected-retc".',
@@ -60,7 +70,8 @@ def parse_args():
 
     parser.add_argument(
         '-w', '--warning',
-        help='Set the warning threshold for the ntp time offset, in ms. Default: %(default)sms',
+        help='Set the warning threshold for the ntp time offset, in ms. '
+             'Default: %(default)sms',
         dest='WARN',
         type=int,
         default=DEFAULT_WARN,
@@ -81,18 +92,27 @@ def main():
 
     if args.TEST is None:
         cmd = 'chronyc tracking'
-        stdout, stderr, retc = lib.base.coe(lib.shell.shell_exec(cmd)) # pylint: disable=W0612
-        if stderr:
-            lib.base.cu(stderr)
+        stdout, stderr, _ = lib.base.coe(lib.shell.shell_exec(cmd))
     else:
         # do not call the command, put in test data
-        stdout, stderr, retc = lib.lftest.test(args.TEST)
+        stdout, stderr, _ = lib.lftest.test(args.TEST)
+    if stderr:
+        lib.base.cu(stderr)
 
     # init some vars
     msg = ''
     state = STATE_OK
     perfdata = ''
+
+    frequency = 0
+    last_offset = 0
+    leap_status = ''
     peer_used = False
+    residual_freq = 0
+    rms_offset = 0
+    root_delay = 0
+    root_dispersion = 0
+    skew = 0
 
     # analyze data
     for line in stdout.splitlines():
@@ -130,31 +150,93 @@ def main():
         msg = 'NTP server not reachable. No NTP server is used.'
         success, result = lib.shell.shell_exec('chronyc sources')
         if success:
-            msg += '\n\n{}'.format(result[0])
+            msg += '\n\n' + result[0]
         lib.base.oao(msg, STATE_WARN)
 
     # build the message
     offset_state = lib.base.get_state(abs(last_offset), args.WARN, args.CRIT)
     state = lib.base.get_worst(state, offset_state)
-    msg += 'NTP offset is {}ms{}, '.format(
-        round(last_offset, 3),
-        lib.base.state2str(offset_state, prefix=' '),
-    )
-    msg += 'Stratum is {}'.format(stratum)
-    if stratum >= 9:
+    msg += f'NTP offset is {round(last_offset, 3)}ms' \
+           f'{lib.base.state2str(offset_state, prefix=' ')}, ' \
+           f'Stratum is {stratum}'
+    if stratum >= args.STRATUM:
         stratum_state = STATE_WARN
         state = lib.base.get_worst(state, stratum_state)
-        msg += ' is >= 9{}'.format(lib.base.state2str(stratum_state, prefix=' '))
-    msg += ', Leap status is {}'.format(leap_status)
-
-    perfdata += lib.base.get_perfdata('frequency', frequency, None, None, None, None, None)
-    perfdata += lib.base.get_perfdata('last_offset', last_offset, 'ms', args.WARN, args.CRIT, None, None)
-    perfdata += lib.base.get_perfdata('residual_freq', residual_freq, None, None, None, None, None)
-    perfdata += lib.base.get_perfdata('rms_offset', rms_offset, 'ms', None, None, None, None)
-    perfdata += lib.base.get_perfdata('root_delay', root_delay, 'ms', None, None, None, None)
-    perfdata += lib.base.get_perfdata('root_dispersion', root_dispersion, 'ms', None, None, None, None)
-    perfdata += lib.base.get_perfdata('skew', skew, None, None, None, None, None)
-    perfdata += lib.base.get_perfdata('stratum', stratum, None, 9, None, 0, None)
+        msg += f' (is >= {args.STRATUM} {lib.base.state2str(stratum_state)})'
+    msg += f', Leap status is {leap_status}'
+
+    perfdata += lib.base.get_perfdata(
+        'frequency',
+        frequency,
+        uom=None,
+        warn=None,
+        crit=None,
+        _min=None,
+        _max=None,
+    )
+    perfdata += lib.base.get_perfdata(
+        'last_offset',
+        last_offset,
+        uom='ms',
+        warn=args.WARN,
+        crit=args.CRIT,
+        _min=None,
+        _max=None,
+    )
+    perfdata += lib.base.get_perfdata(
+        'residual_freq',
+        residual_freq,
+        uom=None,
+        warn=None,
+        crit=None,
+        _min=None,
+        _max=None,
+    )
+    perfdata += lib.base.get_perfdata(
+        'rms_offset',
+        rms_offset,
+        uom='ms',
+        warn=None,
+        crit=None,
+        _min=None,
+        _max=None,
+    )
+    perfdata += lib.base.get_perfdata(
+        'root_delay',
+        root_delay,
+        uom='ms',
+        warn=None,
+        crit=None,
+        _min=None,
+        _max=None,
+    )
+    perfdata += lib.base.get_perfdata(
+        'root_dispersion',
+        root_dispersion,
+        uom='ms',
+        warn=None,
+        crit=None,
+        _min=None,
+        _max=None,
+    )
+    perfdata += lib.base.get_perfdata(
+        'skew',
+        skew,
+        uom=None,
+        warn=None,
+        crit=None,
+        _min=None,
+        _max=None,
+    )
+    perfdata += lib.base.get_perfdata(
+        'stratum',
+        stratum,
+        uom=None,
+        warn=args.STRATUM,
+        crit=None,
+        _min=0,
+        _max=16,
+    )
 
     # over and out
     lib.base.oao(msg + '\n\n' + stdout, state, perfdata)

check-plugins/ntp-ntpd/README.md

@@ -33,7 +33,8 @@ The stratum of the NTP time source determines its quality. The stratum is equal
 ## Help
 
 ```text
-usage: ntp-ntpd [-h] [-V] [-c CRIT] [--test TEST] [-w WARN]
+usage: ntp-ntpd [-h] [-V] [-c CRIT] [--stratum STRATUM] [--test TEST]
+                [-w WARN]
 
 This plugin checks the clock offset of ntpd in milliseconds compared to ntp
 servers.
@@ -43,6 +44,13 @@ options:
   -V, --version        show program's version number and exit
   -c, --critical CRIT  Set the critical threshold for the ntp time offset, in
                        ms. Default: 86400000ms
+  --stratum STRATUM    Warns if the determined stratum of the time server is
+                       greater than or equal to this value. Stratum 1
+                       indicates a computer with a locally attached reference
+                       clock. A computer that is synchronised to a stratum 1
+                       computer is at stratum 2. A computer that is
+                       synchronised to a stratum 2 computer is at stratum 3,
+                       and so on. Default: 6
   --test TEST          For unit tests. Needs "path-to-stdout-file,path-to-
                        stderr-file,expected-retc".
   -w, --warning WARN   Set the warning threshold for the ntp time offset, in
@@ -53,7 +61,7 @@ options:
 ## Usage Examples
 
 ```bash
-./ntp-ntpd --warning 500 --critical 10000
+./ntp-ntpd --warning=500 --critical=10000 --stratum=6
 ```
 
 Output:
@@ -73,7 +81,7 @@ NTP offset is -3.005ms, Stratum is 2
 ## States
 
 * WARN or CRIT if ntp offset is below or above a given threshold.
-* WARN if stratum is \>= 9.
+* WARN if stratum is \>= `--stratum`.
 * WARN if no NTP server is used.
 * WARN if no NTP server is found.
 * WARN if only LOCAL clock is used.